{
  "openapi": "3.0.1",
  "info": {
    "title": "Craigslist Scraper — Listings, Prices, Deal Alerts",
    "description": "Craigslist listings from any city, state or country: price, location, map point, dates, car and housing details, images and full text. Search any category with price, date and owner filters. New-listings alert mode. Free status row per search. No login.",
    "version": "0.1",
    "x-build-id": "hynIfOagtHfW9YThA"
  },
  "servers": [
    {
      "url": "https://api.apify.com/v2"
    }
  ],
  "paths": {
    "/acts/dottti~craigslist-listings/run-sync-get-dataset-items": {
      "post": {
        "operationId": "run-sync-get-dataset-items-dottti-craigslist-listings",
        "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/dottti~craigslist-listings/runs": {
      "post": {
        "operationId": "runs-sync-dottti-craigslist-listings",
        "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/dottti~craigslist-listings/run-sync": {
      "post": {
        "operationId": "run-sync-dottti-craigslist-listings",
        "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": {
          "sites": {
            "title": "Craigslist sites",
            "type": "array",
            "description": "Site names from the Craigslist link, for example sfbay (https://sfbay.craigslist.org), newyork, chicago, london, toronto. You can also paste a site link, use the site's full name (\"SF bay area\"), or add one part of a site with a slash: sfbay/sby (south bay), newyork/brk (Brooklyn). Empty sites, states, countries and links = sfbay.",
            "items": {
              "type": "string"
            }
          },
          "regions": {
            "title": "Whole states or provinces",
            "type": "array",
            "description": "Search every Craigslist site in a state or province. Use US-TX or just TX for a US state, CA-ON for a Canadian province. Texas alone has 27 sites, so keep 'Max listings per search' small.",
            "items": {
              "type": "string"
            }
          },
          "countries": {
            "title": "Whole countries",
            "type": "array",
            "description": "Search every Craigslist site in a country. Use 2-letter codes: US, CA, GB, AU, DE. The US has over 400 sites.",
            "items": {
              "type": "string"
            }
          },
          "categories": {
            "title": "Categories",
            "type": "array",
            "description": "Craigslist category codes or plain words. For sale: sss (all), cta (cars & trucks), cto (cars by owner), ctd (cars by dealer), mca (motorcycles), boa (boats), rva (RVs), bia (bikes), fua (furniture), ela (electronics), zip (free stuff), tia (tickets). Housing: hhh (all), apa (for rent), roo (rooms), sub (sublets), rea (for sale). Jobs: jjj. Gigs: ggg. Services: bbb. Community: ccc. Events: eee. Words like \"cars\", \"housing\", \"jobs\" also work.",
            "default": [
              "sss"
            ],
            "items": {
              "type": "string"
            }
          },
          "searchQueries": {
            "title": "Search words",
            "type": "array",
            "description": "Words to search for, one search per line, for example \"honda civic\" or \"standing desk\". Leave empty for all listings in the category.",
            "items": {
              "type": "string"
            }
          },
          "titlesOnly": {
            "title": "Search titles only",
            "type": "boolean",
            "description": "Match the search words in the listing title only. Off = title and text.",
            "default": false
          },
          "minPrice": {
            "title": "Minimum price",
            "minimum": 0,
            "type": "integer",
            "description": "In the site's own currency (USD in the US, CAD in Canada, GBP in the UK)."
          },
          "maxPrice": {
            "title": "Maximum price",
            "minimum": 0,
            "type": "integer",
            "description": "In the site's own currency."
          },
          "postedToday": {
            "title": "Posted today only",
            "type": "boolean",
            "description": "Craigslist's own 'posted today' filter.",
            "default": false
          },
          "postedWithinDays": {
            "title": "Posted or renewed within N days",
            "minimum": 1,
            "maximum": 60,
            "type": "integer",
            "description": "Keep only listings posted or renewed in the last N days. Craigslist sorts by this date. Empty = no limit."
          },
          "hasImages": {
            "title": "Has images",
            "type": "boolean",
            "description": "Only listings with at least one photo.",
            "default": false
          },
          "sellerType": {
            "title": "Owner or dealer",
            "enum": [
              "any",
              "owner",
              "dealer"
            ],
            "type": "string",
            "description": "For 'for sale' categories. owner = private sellers only. dealer = dealers and businesses only.",
            "default": "any"
          },
          "postalCode": {
            "title": "ZIP or postal code",
            "type": "string",
            "description": "Search around this code. Use with 'Distance from ZIP'."
          },
          "searchDistanceMiles": {
            "title": "Distance from ZIP (miles)",
            "minimum": 1,
            "maximum": 500,
            "type": "integer",
            "description": "Only listings within this many miles of the ZIP or postal code."
          },
          "searchUrls": {
            "title": "Craigslist search links (optional)",
            "type": "array",
            "description": "Paste search links copied from your browser, for example https://www.craigslist.org/search/area/sfbay?cat=bik&query=trek. Every filter in the link is kept. Filters above are added when the link does not set them.",
            "items": {
              "type": "string"
            }
          },
          "sort": {
            "title": "Sort",
            "enum": [
              "newest",
              "relevance",
              "priceAsc",
              "priceDesc",
              "oldest"
            ],
            "type": "string",
            "description": "Order of results. Alert mode always uses newest first.",
            "default": "newest"
          },
          "maxListingsPerSearch": {
            "title": "Max listings per search",
            "minimum": 1,
            "maximum": 50000,
            "type": "integer",
            "description": "Each site x category x search word is one search. This caps each one.",
            "default": 20
          },
          "maxListings": {
            "title": "Max listings in total",
            "minimum": 0,
            "type": "integer",
            "description": "Stops the whole run after this many listings. 0 = no total limit.",
            "default": 0
          },
          "includeDetails": {
            "title": "Open each listing (full text and attributes)",
            "type": "boolean",
            "description": "Adds the full listing text, every attribute (make/model, year, title status, bathrooms, laundry, pets and more), the first-posted and updated dates and an exact map point. One extra request per listing, so runs are slower. Phone numbers and emails in the text are removed.",
            "default": false
          },
          "skipDuplicates": {
            "title": "Skip duplicate posts",
            "type": "boolean",
            "description": "Craigslist marks posts that repeat another post. On = keep only the newest one of each group.",
            "default": true
          },
          "includeNearby": {
            "title": "Include nearby sites",
            "type": "boolean",
            "description": "Small sites add results from nearby sites to fill the page. Off = only listings from the sites you chose.",
            "default": false
          },
          "onlyNew": {
            "title": "Only new listings (deal alert mode)",
            "type": "boolean",
            "description": "Remembers the listings each search returned. The first run returns the newest listings as a baseline. Later runs return only listings that were not returned before. Use it on a schedule.",
            "default": false
          },
          "stateName": {
            "title": "Alert list name",
            "type": "string",
            "description": "Separate names keep separate memory, for example 'bike-deals' and 'apartments-sf'. Stored in the named key-value store 'craigslist-listings-state'.",
            "default": "default"
          },
          "proxyConfiguration": {
            "title": "Proxy (optional)",
            "type": "object",
            "description": "Leave off to use the automatic fallback below. If you set a proxy here, it is used for every request and the fallback is off."
          },
          "autoProxyFallback": {
            "title": "Automatic proxy fallback",
            "type": "boolean",
            "description": "Starts without a proxy. If Craigslist keeps refusing requests, switches to Apify datacenter proxy, then residential.",
            "default": true
          },
          "allowResidentialFallback": {
            "title": "Allow residential proxy as the last step",
            "type": "boolean",
            "description": "Turn off to never use residential proxy.",
            "default": true
          },
          "maxConcurrency": {
            "title": "Searches in parallel",
            "minimum": 1,
            "maximum": 5,
            "type": "integer",
            "description": "Requests are still spaced out across all searches. Higher is faster and more likely to be rate-limited.",
            "default": 2
          }
        }
      },
      "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
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}