{
"openapi": "3.0.1",
"info": {
"title": "OLX Scraper | Brazil Listings, Prices and Sellers",
"description": "OLX Brasil scraper for olx.com.br: 50 listings in 17 seconds, 43 fields each. Search by keyword, category, state or link and get price, full description, seller, CEP, photos and attributes, plus the FIPE price and OLX market price on cars, condo fee, IPTU and map position on homes. Filter by price.",
"version": "1.0",
"x-build-id": "CXcXvHmbFvnRRQadf"
},
"servers": [
{
"url": "https://api.apify.com/v2"
}
],
"paths": {
"/acts/silentflow~olx-scraper/run-sync-get-dataset-items": {
"post": {
"operationId": "run-sync-get-dataset-items-silentflow-olx-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/silentflow~olx-scraper/runs": {
"post": {
"operationId": "runs-sync-silentflow-olx-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/silentflow~olx-scraper/run-sync": {
"post": {
"operationId": "run-sync-silentflow-olx-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": {
"searchQueries": {
"title": "🔎 Keywords",
"type": "array",
"description": "What you would type in the OLX search box, one per line: Toyota Corolla, iPhone 13, apartamento 2 quartos. Each keyword is searched in the category and state picked below and gives up to Max listings rows.",
"items": {
"type": "string"
}
},
"startUrls": {
"title": "🔗 OLX links or ad numbers",
"type": "array",
"description": "Paste links copied from olx.com.br: a search or category page with your filters (https://www.olx.com.br/imoveis/aluguel/estado-rj/rio-de-janeiro-e-regiao), a single ad, or just an ad number (1543638559). A pasted search keeps its own filters; the filters below are added where it has none.",
"items": {
"type": "string"
}
},
"category": {
"title": "🗂️ Category",
"enum": [
"all",
"cars",
"motorcycles",
"trucks",
"auto_parts",
"real_estate",
"real_estate_sale",
"real_estate_rent",
"vacation_rentals",
"land",
"commercial_property",
"new_developments",
"cellphones",
"electronics",
"computers",
"games",
"tvs",
"audio",
"cameras",
"appliances",
"furniture",
"home",
"construction",
"fashion",
"sports",
"bikes",
"kids",
"pets",
"music_hobbies",
"agro",
"business",
"services"
],
"type": "string",
"description": "The OLX category your keywords are searched in. Cars, vans and pickups adds the FIPE price and the OLX market price range to each row. Pasted links keep their own category.",
"default": "all"
},
"state": {
"title": "📍 State",
"type": "string",
"description": "The Brazilian state your keywords are searched in. Pick one or type a UF code (SP) or a name (São Paulo, sao paulo). Leave on All of Brazil to search the whole country.",
"default": "all"
},
"maxItems": {
"title": "🔢 Max listings per keyword or link",
"minimum": 1,
"maximum": 5000,
"type": "integer",
"description": "How many ads to collect for each keyword and each search link, up to 5,000 (OLX shows at most 100 pages of 50 ads per search; split by state or category to go further). Single ad links count one row each.",
"default": 100
},
"sortBy": {
"title": "↕️ Sort by",
"enum": [
"relevance",
"newest",
"price_asc",
"price_desc"
],
"type": "string",
"description": "Newest first follows the date OLX shows on each ad; with a date filter below it also ends the search as soon as the ads get older.",
"default": "relevance"
},
"minPrice": {
"title": "💰 Minimum price (R$)",
"minimum": 0,
"type": "integer",
"description": "Only ads priced at or above this amount in reais, for example 30000. Leave empty for no minimum."
},
"maxPrice": {
"title": "💰 Maximum price (R$)",
"minimum": 0,
"type": "integer",
"description": "Only ads priced at or below this amount in reais, for example 90000. Leave empty for no maximum."
},
"sellerType": {
"title": "🏪 Seller type",
"enum": [
"all",
"private",
"business"
],
"type": "string",
"description": "Private sellers keeps individuals only (direct deals), Professional sellers keeps dealers, stores and real estate agencies only.",
"default": "all"
},
"postedWithinDays": {
"title": "📅 Posted in the last (days)",
"minimum": 0,
"maximum": 365,
"type": "integer",
"description": "Only ads published or renewed on OLX in the last N days, the date OLX shows on the ad: 1 for today's ads, 7 for this week. 0 keeps every date.",
"default": 0
}
}
},
"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
}
}
}
}
}
}
}
}
}
}