{
  "openapi": "3.0.1",
  "info": {
    "title": "Craigslist Scraper - Jobs, Housing, Cars, For Sale & Services",
    "description": "Scrape Craigslist in 700+ cities across jobs, housing, cars, for-sale and services. Fast 360-per-request search, keyword and filter search, new-listing monitoring, optional full details and contacts. MCP-ready.",
    "version": "0.7",
    "x-build-id": "EwRLUt8GRbKhCWd6z"
  },
  "servers": [
    {
      "url": "https://api.apify.com/v2"
    }
  ],
  "paths": {
    "/acts/khadinakbar~craigslist-all-in-one-scraper/run-sync-get-dataset-items": {
      "post": {
        "operationId": "run-sync-get-dataset-items-khadinakbar-craigslist-all-in-one-scraper",
        "x-openai-isConsequential": false,
        "summary": "Executes an Actor, waits for its completion, and returns Actor's dataset items in response.",
        "tags": [
          "Run Actor"
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/inputSchema"
              }
            }
          }
        },
        "parameters": [
          {
            "name": "token",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            },
            "description": "Enter your Apify token here"
          }
        ],
        "responses": {
          "200": {
            "description": "OK"
          }
        }
      }
    },
    "/acts/khadinakbar~craigslist-all-in-one-scraper/runs": {
      "post": {
        "operationId": "runs-sync-khadinakbar-craigslist-all-in-one-scraper",
        "x-openai-isConsequential": false,
        "summary": "Executes an Actor and returns information about the initiated run in response.",
        "tags": [
          "Run Actor"
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/inputSchema"
              }
            }
          }
        },
        "parameters": [
          {
            "name": "token",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            },
            "description": "Enter your Apify token here"
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/runsResponseSchema"
                }
              }
            }
          }
        }
      }
    },
    "/acts/khadinakbar~craigslist-all-in-one-scraper/run-sync": {
      "post": {
        "operationId": "run-sync-khadinakbar-craigslist-all-in-one-scraper",
        "x-openai-isConsequential": false,
        "summary": "Executes an Actor, waits for completion, and returns the OUTPUT from Key-value store in response.",
        "tags": [
          "Run Actor"
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/inputSchema"
              }
            }
          }
        },
        "parameters": [
          {
            "name": "token",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            },
            "description": "Enter your Apify token here"
          }
        ],
        "responses": {
          "200": {
            "description": "OK"
          }
        }
      }
    }
  },
  "components": {
    "schemas": {
      "inputSchema": {
        "type": "object",
        "properties": {
          "city": {
            "title": "City",
            "type": "string",
            "description": "City to search: a name like 'San Francisco' or 'London', or the part before '.craigslist.org' (e.g. 'sfbay', 'newyork'). Presets: 'topUSMetros' (top 25 US metros), 'topGlobalMetros' (top 50 worldwide), 'allUS' (every US site). Ignored when 'cities', 'states' or 'startUrls' is set."
          },
          "cities": {
            "title": "Cities (multiple)",
            "type": "array",
            "description": "Several cities in one run, by name or subdomain (e.g. ['Austin','sfbay','Toronto']). Each city is searched separately. Leave empty to use 'city'.",
            "default": [],
            "items": {
              "type": "string"
            }
          },
          "states": {
            "title": "US states / regions",
            "type": "array",
            "description": "Search every Craigslist site in these state or province codes (e.g. ['CA','TX']). Added to the cities above. Each site is searched separately, so combine with a sensible 'maxResults'.",
            "default": [],
            "items": {
              "type": "string"
            }
          },
          "category": {
            "title": "Category",
            "enum": [
              "forsale",
              "jobs",
              "housing",
              "services",
              "gigs",
              "community",
              "resumes",
              "events",
              "all"
            ],
            "type": "string",
            "description": "Top-level Craigslist category. 'forsale' covers all goods (cars+trucks, electronics, furniture, etc.); pick a 'subcategory' below for narrower results. Defaults to 'forsale'. Use 'all' to scrape every category (expensive — leaves volume control to 'maxResults').",
            "default": "forsale"
          },
          "subcategory": {
            "title": "Subcategory",
            "type": "string",
            "description": "Craigslist subcategory code that narrows the category (e.g. 'cta' for cars+trucks-all, 'apa' for apartments/housing, 'sof' for software jobs, 'mis' for general for-sale). Leave blank to scrape the whole category. Full list of codes in the README.",
            "default": ""
          },
          "searchQuery": {
            "title": "Search query",
            "type": "string",
            "description": "Free-text search run inside the chosen category (e.g. 'macbook pro', 'studio apartment', 'remote python'). Leave empty to browse the latest postings in the category. Supports Craigslist's own search operators.",
            "default": ""
          },
          "searchQueries": {
            "title": "Keywords (multiple)",
            "type": "array",
            "description": "Run several keyword searches in one go, e.g. ['macbook','thinkpad']. Each keyword is searched in every city and category. Adds to 'searchQuery'.",
            "default": [],
            "items": {
              "type": "string"
            }
          },
          "startUrls": {
            "title": "Start URLs (advanced)",
            "type": "array",
            "description": "Craigslist search links or single post links (host ends in '.craigslist.org'). A search link keeps its filters (keyword, price, bedrooms, sort…). A post link returns that one listing in full detail. Overrides city/category/keyword when set.",
            "default": [],
            "items": {
              "type": "object",
              "required": [
                "url"
              ],
              "properties": {
                "url": {
                  "type": "string",
                  "title": "URL of a web page",
                  "format": "uri"
                }
              }
            }
          },
          "maxResults": {
            "title": "Max results per city",
            "minimum": 1,
            "maximum": 3000,
            "type": "integer",
            "description": "Most listings to return per city (across all keywords and categories). The first 360 per search come from a very fast feed; more are read page by page. Default 50.",
            "default": 50
          },
          "maxTotalResults": {
            "title": "Max results in total",
            "minimum": 0,
            "type": "integer",
            "description": "Hard stop for the whole run across all cities. 0 means no overall limit (only the per-city limit applies).",
            "default": 0
          },
          "sortBy": {
            "title": "Sort by",
            "enum": [
              "date",
              "relevance",
              "priceAsc",
              "priceDesc"
            ],
            "type": "string",
            "description": "Order of results. 'Newest first' is best for monitoring.",
            "default": "date"
          },
          "includeDetails": {
            "title": "Fetch full post details",
            "type": "boolean",
            "description": "When true, opens each individual listing for full description, complete image gallery, post attributes, and reply URL — each such row is charged as a 'listing-detailed' event. When false, returns only the search-result card data (title, price, location, primary image, URL), charged as 'listing-scraped' events. See the Pricing tab for event prices. Default false.",
            "default": false
          },
          "extractContacts": {
            "title": "Extract public contact info",
            "type": "boolean",
            "description": "Also return phone numbers and email addresses written in the post text (as lists). Needs full details, so each row is a 'listing-detailed' event. Never logs in or reveals hidden reply addresses.",
            "default": false
          },
          "minPrice": {
            "title": "Minimum price",
            "minimum": 0,
            "type": "integer",
            "description": "Minimum listing price filter, in the local currency of each city's marketplace (USD for US cities, GBP for London, etc.). Applies to categories that have a price column (for-sale, housing, services). Leave blank for no minimum.",
            "default": 0
          },
          "maxPrice": {
            "title": "Maximum price",
            "minimum": 0,
            "type": "integer",
            "description": "Maximum listing price filter. Same currency rule as minPrice. Default 0 means no maximum. Use to skip out-of-budget cars or rentals.",
            "default": 0
          },
          "hasPic": {
            "title": "Only listings with images",
            "type": "boolean",
            "description": "When true, only returns listings that include at least one image. Useful for resellers and real-estate filters. Default false.",
            "default": false
          },
          "ownerOnly": {
            "title": "Owner posts only (skip dealers)",
            "type": "boolean",
            "description": "When true, only returns listings posted by owners — excludes dealer/agency/recruiter posts. Applies to for-sale (cars+trucks especially), housing, and jobs categories. Default false.",
            "default": false
          },
          "postedToday": {
            "title": "Posted today only",
            "type": "boolean",
            "description": "Only listings posted in the last day.",
            "default": false
          },
          "titleOnly": {
            "title": "Search titles only",
            "type": "boolean",
            "description": "Match the keyword in the listing title only, not the full text.",
            "default": false
          },
          "conditions": {
            "title": "Condition (for sale)",
            "type": "array",
            "description": "Keep only items in these conditions. Leave empty for any.",
            "items": {
              "type": "string",
              "enum": [
                "new",
                "likeNew",
                "excellent",
                "good",
                "fair",
                "salvage"
              ]
            },
            "default": []
          },
          "minBedrooms": {
            "title": "Min bedrooms (housing)",
            "minimum": 0,
            "type": "integer",
            "description": "Housing only. 0 means any.",
            "default": 0
          },
          "maxBedrooms": {
            "title": "Max bedrooms (housing)",
            "minimum": 0,
            "type": "integer",
            "description": "Housing only. 0 means any.",
            "default": 0
          },
          "minBathrooms": {
            "title": "Min bathrooms (housing)",
            "minimum": 0,
            "type": "integer",
            "description": "Housing only. 0 means any.",
            "default": 0
          },
          "petsDogsOk": {
            "title": "Dogs OK (housing)",
            "type": "boolean",
            "description": "Housing only: keep dog-friendly places.",
            "default": false
          },
          "petsCatsOk": {
            "title": "Cats OK (housing)",
            "type": "boolean",
            "description": "Housing only: keep cat-friendly places.",
            "default": false
          },
          "postalCode": {
            "title": "Postal / ZIP code",
            "type": "string",
            "description": "Search around this postal code (US ZIP or Canadian postal code). Use together with the distance below.",
            "default": ""
          },
          "searchDistanceMiles": {
            "title": "Search distance (miles)",
            "minimum": 0,
            "type": "integer",
            "description": "How far around the postal code to search. 0 means the city default.",
            "default": 0
          },
          "maxAgeDays": {
            "title": "Max age (days)",
            "minimum": 0,
            "maximum": 365,
            "type": "integer",
            "description": "Skip listings older than this many days. Craigslist sorts newest-first so the crawler stops paginating once a page contains only older posts. Default 0 means no age filter.",
            "default": 0
          },
          "dedupAcrossCities": {
            "title": "Deduplicate reposts across cities",
            "type": "boolean",
            "description": "When true (default), keeps a per-run SHA-256 fingerprint of (normalised title + price + first image hostname) and drops any second occurrence — useful when scraping multiple metros where dealers post the same listing in several cities. Set false to keep every raw row.",
            "default": true
          },
          "monitorMode": {
            "title": "Only new listings (monitoring)",
            "type": "boolean",
            "description": "Return only listings not seen in earlier runs with the same monitor name. Pair with a schedule to get new posts only; you pay only for new rows.",
            "default": false
          },
          "monitorKey": {
            "title": "Monitor name",
            "type": "string",
            "description": "Name that keeps one monitor's memory apart from another. Used only when 'Only new listings' is on.",
            "default": "default"
          },
          "searchRoute": {
            "title": "Search route (advanced)",
            "enum": [
              "auto",
              "pages"
            ],
            "type": "string",
            "description": "Auto reads Craigslist's fast search feed first and falls back to regular result pages. 'Pages only' skips the feed; use it only if the feed ever returns odd results.",
            "default": "auto"
          },
          "proxyMode": {
            "title": "Connection mode",
            "enum": [
              "auto",
              "none",
              "datacenter",
              "residential"
            ],
            "type": "string",
            "description": "Auto tries the cheapest connection first and steps up only if Craigslist blocks it. Leave on Auto unless you have a reason.",
            "default": "auto"
          },
          "proxyConfiguration": {
            "title": "Custom proxy (optional)",
            "type": "object",
            "description": "Only fill this in to force your own proxy. Leave empty to use the connection mode above."
          }
        }
      },
      "runsResponseSchema": {
        "type": "object",
        "properties": {
          "data": {
            "type": "object",
            "properties": {
              "id": {
                "type": "string"
              },
              "actId": {
                "type": "string"
              },
              "userId": {
                "type": "string"
              },
              "startedAt": {
                "type": "string",
                "format": "date-time",
                "example": "2025-01-08T00:00:00.000Z"
              },
              "finishedAt": {
                "type": "string",
                "format": "date-time",
                "example": "2025-01-08T00:00:00.000Z"
              },
              "status": {
                "type": "string",
                "example": "READY"
              },
              "meta": {
                "type": "object",
                "properties": {
                  "origin": {
                    "type": "string",
                    "example": "API"
                  },
                  "userAgent": {
                    "type": "string"
                  }
                }
              },
              "stats": {
                "type": "object",
                "properties": {
                  "inputBodyLen": {
                    "type": "integer",
                    "example": 2000
                  },
                  "rebootCount": {
                    "type": "integer",
                    "example": 0
                  },
                  "restartCount": {
                    "type": "integer",
                    "example": 0
                  },
                  "resurrectCount": {
                    "type": "integer",
                    "example": 0
                  },
                  "computeUnits": {
                    "type": "integer",
                    "example": 0
                  }
                }
              },
              "options": {
                "type": "object",
                "properties": {
                  "build": {
                    "type": "string",
                    "example": "latest"
                  },
                  "timeoutSecs": {
                    "type": "integer",
                    "example": 300
                  },
                  "memoryMbytes": {
                    "type": "integer",
                    "example": 1024
                  },
                  "diskMbytes": {
                    "type": "integer",
                    "example": 2048
                  }
                }
              },
              "buildId": {
                "type": "string"
              },
              "defaultKeyValueStoreId": {
                "type": "string"
              },
              "defaultDatasetId": {
                "type": "string"
              },
              "defaultRequestQueueId": {
                "type": "string"
              },
              "buildNumber": {
                "type": "string",
                "example": "1.0.0"
              },
              "containerUrl": {
                "type": "string"
              },
              "usage": {
                "type": "object",
                "properties": {
                  "ACTOR_COMPUTE_UNITS": {
                    "type": "integer",
                    "example": 0
                  },
                  "DATASET_READS": {
                    "type": "integer",
                    "example": 0
                  },
                  "DATASET_WRITES": {
                    "type": "integer",
                    "example": 0
                  },
                  "KEY_VALUE_STORE_READS": {
                    "type": "integer",
                    "example": 0
                  },
                  "KEY_VALUE_STORE_WRITES": {
                    "type": "integer",
                    "example": 1
                  },
                  "KEY_VALUE_STORE_LISTS": {
                    "type": "integer",
                    "example": 0
                  },
                  "REQUEST_QUEUE_READS": {
                    "type": "integer",
                    "example": 0
                  },
                  "REQUEST_QUEUE_WRITES": {
                    "type": "integer",
                    "example": 0
                  },
                  "DATA_TRANSFER_INTERNAL_GBYTES": {
                    "type": "integer",
                    "example": 0
                  },
                  "DATA_TRANSFER_EXTERNAL_GBYTES": {
                    "type": "integer",
                    "example": 0
                  },
                  "PROXY_RESIDENTIAL_TRANSFER_GBYTES": {
                    "type": "integer",
                    "example": 0
                  },
                  "PROXY_SERPS": {
                    "type": "integer",
                    "example": 0
                  },
                  "PROXY_UNBLOCKER_UNITS": {
                    "type": "integer",
                    "example": 0
                  }
                }
              },
              "usageTotalUsd": {
                "type": "number",
                "example": 0.00005
              },
              "usageUsd": {
                "type": "object",
                "properties": {
                  "ACTOR_COMPUTE_UNITS": {
                    "type": "integer",
                    "example": 0
                  },
                  "DATASET_READS": {
                    "type": "integer",
                    "example": 0
                  },
                  "DATASET_WRITES": {
                    "type": "integer",
                    "example": 0
                  },
                  "KEY_VALUE_STORE_READS": {
                    "type": "integer",
                    "example": 0
                  },
                  "KEY_VALUE_STORE_WRITES": {
                    "type": "number",
                    "example": 0.00005
                  },
                  "KEY_VALUE_STORE_LISTS": {
                    "type": "integer",
                    "example": 0
                  },
                  "REQUEST_QUEUE_READS": {
                    "type": "integer",
                    "example": 0
                  },
                  "REQUEST_QUEUE_WRITES": {
                    "type": "integer",
                    "example": 0
                  },
                  "DATA_TRANSFER_INTERNAL_GBYTES": {
                    "type": "integer",
                    "example": 0
                  },
                  "DATA_TRANSFER_EXTERNAL_GBYTES": {
                    "type": "integer",
                    "example": 0
                  },
                  "PROXY_RESIDENTIAL_TRANSFER_GBYTES": {
                    "type": "integer",
                    "example": 0
                  },
                  "PROXY_SERPS": {
                    "type": "integer",
                    "example": 0
                  },
                  "PROXY_UNBLOCKER_UNITS": {
                    "type": "integer",
                    "example": 0
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}