{
"openapi": "3.0.1",
"info": {
"title": "OLX Brazil Scraper | Listings, Prices & Seller Data",
"description": "[💰 $100/500] Scrape OLX Brazil listings at scale. Extract titles, prices, descriptions, photos, seller details, location and category data from Brazil's largest classifieds marketplace by keyword or URL. Premium flat rate, enrichment included.",
"version": "0.1",
"x-build-id": "ScQwJWdC9FPj7baCx"
},
"servers": [
{
"url": "https://api.apify.com/v2"
}
],
"paths": {
"/acts/pedrocadev~olx-brazil-scraper/run-sync-get-dataset-items": {
"post": {
"operationId": "run-sync-get-dataset-items-pedrocadev-olx-brazil-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/pedrocadev~olx-brazil-scraper/runs": {
"post": {
"operationId": "runs-sync-pedrocadev-olx-brazil-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/pedrocadev~olx-brazil-scraper/run-sync": {
"post": {
"operationId": "run-sync-pedrocadev-olx-brazil-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": "Search or Category URLs",
"type": "array",
"description": "Paste one or more OLX Brazil URLs. Search pages, category pages and state path URLs (e.g. https://www.olx.com.br/imoveis/venda/estado-sp) are all supported.",
"items": {
"type": "string"
}
},
"searchQueries": {
"title": "Search Queries",
"type": "array",
"description": "Plain-text search terms, for example iPhone 13, Gol G5 or Apartamento. Each query runs on OLX Brazil and returns matching listings.",
"default": [],
"items": {
"type": "string"
}
},
"maxResults": {
"title": "Max Results",
"minimum": 0,
"type": "integer",
"description": "Maximum number of listings to collect across all URLs and queries. Set to 0 for unlimited (capped internally at 50,000). OLX itself serves at most ~5,000 listings per search URL."
},
"sortBy": {
"title": "Sort Results By",
"enum": [
"relevance",
"newest",
"price_asc",
"price_desc"
],
"type": "string",
"description": "Order in which listings are collected, applied at OLX's own query layer. If a Search URL already specifies a sort order, that URL's sort wins and this setting is ignored for it.",
"default": "relevance"
},
"state": {
"title": "State",
"enum": [
"AC",
"AL",
"AP",
"AM",
"BA",
"CE",
"DF",
"ES",
"GO",
"MA",
"MT",
"MS",
"MG",
"PA",
"PB",
"PR",
"PE",
"PI",
"RJ",
"RN",
"RS",
"RO",
"RR",
"SC",
"SP",
"SE",
"TO"
],
"type": "string",
"description": "Restrict plain-text Search Queries to one Brazilian state by UF code. Search URLs already carry their own state and take precedence."
},
"minPrice": {
"title": "Minimum Price (R$)",
"minimum": 0,
"type": "integer",
"description": "Only include listings priced at or above this amount in Brazilian Reais. Applied at OLX's native query layer, so you never pay for out-of-budget rows."
},
"maxPrice": {
"title": "Maximum Price (R$)",
"minimum": 0,
"type": "integer",
"description": "Only include listings priced at or below this amount in Brazilian Reais. Applied at OLX's native query layer."
},
"includeBusinessOnly": {
"title": "Business Sellers Only",
"type": "boolean",
"description": "Only include ads posted by business sellers (lojas e profissionais) and exclude private individuals.",
"default": false
},
"enrichDetails": {
"title": "Add Full Description, Seller Name & Postal Code",
"type": "boolean",
"description": "Also collect each listing's full description, seller name and CEP postal code by visiting the listing page. Billed at the higher enriched rate and only when the details are actually found. Runs take longer with this on.",
"default": false
},
"proxyConfiguration": {
"title": "Proxy Configuration",
"type": "object",
"description": "Proxies to use for OLX requests. Residential proxies are recommended if runs get blocked from datacenter IPs.",
"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
}
}
},
"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
}
}
}
}
}
}
}
}
}
}