{
  "openapi": "3.0.1",
  "info": {
    "title": "Craigslist Scraper: Every Listing, Past the 360 Cap",
    "description": "Scrape every Craigslist listing past the 360-per-search cap: 2,216 listings on a search the site stops at 360. One area, a state or all 707 sites, price, coordinates, photos, full ad text, no duplicates, new-listings monitoring.",
    "version": "0.1",
    "x-build-id": "hpXX3FKlJBFIFd84Y"
  },
  "servers": [
    {
      "url": "https://api.apify.com/v2"
    }
  ],
  "paths": {
    "/acts/alexmorain~craigslist-scraper/run-sync-get-dataset-items": {
      "post": {
        "operationId": "run-sync-get-dataset-items-alexmorain-craigslist-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/alexmorain~craigslist-scraper/runs": {
      "post": {
        "operationId": "runs-sync-alexmorain-craigslist-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/alexmorain~craigslist-scraper/run-sync": {
      "post": {
        "operationId": "run-sync-alexmorain-craigslist-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": {
          "searchUrls": {
            "title": "Craigslist search URLs",
            "type": "array",
            "description": "Search pages copied from your browser, one per line, such as <code>https://sfbay.craigslist.org/search/msa?query=guitar</code> or <code>https://newyork.craigslist.org/search/mnh/sss?min_price=100</code>. Keyword, category, sub-area, price range and the <code>purveyor</code>, <code>hasPic</code>, <code>postedToday</code>, <code>condition</code> and <code>searchNearby</code> filters are read from the URL. Single listing pages are not supported. Can be combined with the keyword and areas below.",
            "items": {
              "type": "string"
            }
          },
          "query": {
            "title": "Keyword",
            "type": "string",
            "description": "What to search for, such as <code>stratocaster</code> or <code>iphone 15</code>. Leave empty to list a whole category (then set <b>Max listings</b>: a big area holds hundreds of thousands)."
          },
          "category": {
            "title": "Category",
            "type": "string",
            "description": "Three-letter Craigslist category in the URL after <code>/search/</code>. <code>sss</code> = all for sale, <code>msa</code> = musical instruments, <code>ela</code> = electronics, <code>cta</code> = cars and trucks, <code>apa</code> = apartments, <code>jjj</code> = all jobs, <code>bbb</code> = all services. Empty = <code>sss</code> (all for sale)."
          },
          "areas": {
            "title": "Areas",
            "type": "array",
            "description": "One entry per line. Accepts a Craigslist site name (<code>sfbay</code>, <code>newyork</code>, <code>paris</code>), a country code (<code>US</code>, <code>FR</code>, <code>GB</code>; <code>CA</code> means Canada), a US state or Canadian province (<code>US-CA</code>, <code>US-NY</code>, <code>CA-ON</code>), or <code>all</code> for every one of the 707 sites. An unknown name stops the run before any request. Empty with a keyword = <code>sfbay</code>.",
            "items": {
              "type": "string"
            }
          },
          "minPrice": {
            "title": "Minimum price",
            "minimum": 0,
            "type": "integer",
            "description": "Only listings priced at or above this amount, in the local currency. Listings without a price are left out when a price limit is set."
          },
          "maxPrice": {
            "title": "Maximum price",
            "minimum": 0,
            "type": "integer",
            "description": "Only listings priced at or below this amount."
          },
          "postedWithin": {
            "title": "Posted within (days)",
            "minimum": 1,
            "maximum": 365,
            "type": "integer",
            "description": "Only listings posted in the last N days. Reads newest first and stops at the window, so a short window is a handful of requests whatever the size of the search."
          },
          "maxItems": {
            "title": "Max listings",
            "minimum": 0,
            "type": "integer",
            "description": "Stops after this many listings, all searches together. Each listing is one charged result, so this is also your cost cap. <b>0 = no limit</b>, except for a keyword-less whole-category search on several areas, which is capped at 10,000.",
            "default": 1000
          },
          "includeDetails": {
            "title": "Add the full ad (details)",
            "type": "boolean",
            "description": "Opens every listing to add the complete text, the attributes (brand, model, condition...), the real posting id, the last update time, the id of the ad it reposts and whether it carries contact info. One extra request per listing, charged at the higher <i>listing with details</i> price. Listings whose page is gone are delivered without details and charged the plain price.",
            "default": false
          },
          "includeUnpriced": {
            "title": "Include listings without a price",
            "type": "boolean",
            "description": "Craigslist price filters drop listings with no price (1 to 6 % of a search), so the actor runs a second pass for them on searches that need splitting. Turn it off to save requests when you only want priced listings.",
            "default": true
          },
          "newOnly": {
            "title": "New listings only (monitoring)",
            "type": "boolean",
            "description": "Remembers which listings it already delivered for this exact search and returns only the new ones on the next run. Listings already delivered are not charged again. Schedule it hourly or daily.",
            "default": false
          },
          "registryKey": {
            "title": "Monitoring key (optional)",
            "type": "string",
            "description": "Name your monitoring memory to keep several independent watches on the same search, or to change the areas without losing history. Empty = one memory per distinct search."
          },
          "webhookUrl": {
            "title": "Webhook URL (optional)",
            "type": "string",
            "description": "Receives a JSON summary (status, listings, run id, dataset id) when the run ends. Slack, Discord, Zapier and Make URLs work. Never logged."
          },
          "proxyConfiguration": {
            "title": "Proxy configuration",
            "type": "object",
            "description": "Apify datacenter proxy is enough: Craigslist answered 3,000 requests in a row on one datacenter IP. The actor rotates the IP on a repeated refusal.",
            "default": {
              "useApifyProxy": true
            }
          }
        }
      },
      "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
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}