Skip to content

// docs

OLX: Get listing details

Extracts detailed data from an ad from OLX with hash LGPD to sellerName and phones.

olx.com.br:pdp · 1 credit per request

Standard credit cost. Your account pricing is shown in the sandbox.

Try this operation in the sandbox

HTTP request

cURL
curl -X POST https://api.geckoapi.com.br/v1/extract \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "target": "olx.com.br",
  "type": "pdp",
  "url": "https://pr.olx.com.br/regiao-de-maringa/celulares/iphone-14-128gb-branco-1506913293"
}'

Keep your API key on your server. See the quickstart for authentication and response handling.

MCP request

The hosted MCP tool fixes target and type for this operation. Its remaining arguments use the same input rules as Extract.

POST /v1/mcp · Bearer or X-API-Key authentication

olx_com_br_pdp · tools/call
{
  "jsonrpc": "2.0",
  "id": 3,
  "method": "tools/call",
  "params": {
    "name": "olx_com_br_pdp",
    "arguments": {
      "url": "https://pr.olx.com.br/regiao-de-maringa/celulares/iphone-14-128gb-branco-1506913293",
      "executionId": "exec_example_123"
    }
  }
}

Supported inputs

Conditional fields depend on the alternatives and constraints in the rule column. Fields marked unsupported are omitted.

FieldTypeRequirementRuleDefaultExample
url
URL extraction target. For some PLPs it can be omitted when API assembles URL from other fields.
string (URL) Required URL from the ad in the domain olx.com.br. - https://pr.olx.com.br/regiao-de-maringa/celulares/iphone-14-128gb-branco-1506913293
target
Target source for extraction.
enum Required Always mandatory and must be olx.com.br. - olx.com.br
type
Extraction type: pdp, idp, plp, ilp, quote, review or places.
enum Required Always mandatory and must be pdp. - pdp

Request examples

PDP by URL

Send OLX public announcement URL. The backend validates the domain and hashes the sensitive data.

PDP by URL
{
  "target": "olx.com.br",
  "type": "pdp",
  "url": "https://pr.olx.com.br/regiao-de-maringa/celulares/iphone-14-128gb-branco-1506913293"
}

Response schema

Leaf paths and expected types. Field names and enum values are part of the API contract.

responseSchema
{
  "requestId": "string (uuid)",
  "executionId": "string (uuid)",
  "notFound": "boolean (optional; true when the upstream entity was not found and data is null)",
  "data.source": "string",
  "data.type": "string",
  "data.parser": "\"1.0.0\"",
  "data.requestUrl": "string",
  "data.extractedAt": "string (iso datetime)",
  "data.data.url": "string",
  "data.data.listingId": "string",
  "data.data.adId": "string",
  "data.data.title": "string",
  "data.data.description": "string",
  "data.data.price": "number",
  "data.data.currency": "string",
  "data.data.listedAt": "string (iso datetime)",
  "data.data.listedAtEpoch": "number",
  "data.data.category": "string",
  "data.data.mainCategory": "string",
  "data.data.subCategory": "string",
  "data.data.location.state": "string",
  "data.data.location.city": "string",
  "data.data.location.neighborhood": "string",
  "data.data.location.region": "string",
  "data.data.location.ddd": "string",
  "data.data.location.zipCode": "string",
  "data.data.seller.id": "string",
  "data.data.seller.isProfessional": "boolean (optional)",
  "data.data.seller.nameHash": "string",
  "data.data.phoneHashes[]": "string (optional)",
  "data.data.images[].url": "string",
  "data.data.attributes[].name": "string",
  "data.data.attributes[].label": "string",
  "data.data.attributes[].value": "string",
  "data.data.attributes[].url": "string (optional)",
  "data.data.olxPayEnabled": "boolean",
  "data.data.olxDeliveryEnabled": "boolean"
}

Example response

Illustrative response. Product names, reviews and other source content retain their original language. Missing and null values do not imply zero stock, free shipping or zero reviews.

responseExample
{
  "requestId": "9d0db4f1-b7d8-4d71-9dbe-9d61a41b9521",
  "executionId": "9d0db4f1-b7d8-4d71-9dbe-9d61a41b9522",
  "data": {
    "source": "olx.com.br",
    "type": "pdp",
    "parser": "1.0.0",
    "requestUrl": "https://pr.olx.com.br/regiao-de-maringa/celulares/iphone-14-128gb-branco-1506913293",
    "extractedAt": "2026-06-02T11:41:18.615Z",
    "data": {
      "url": "https://pr.olx.com.br/regiao-de-maringa/celulares/iphone-14-128gb-branco-1506913293",
      "listingId": "1506913293",
      "adId": "1780915956",
      "title": "iPhone 14 128GB Branco",
      "description": "iPhone 14 com 128GB de armazenamento, perfeito para suas fotos, videos e aplicativos.",
      "price": 2200,
      "currency": "BRL",
      "listedAt": "2026-06-01T02:37:38.000Z",
      "listedAtEpoch": 1780281458,
      "category": "Celulares e Smartphones",
      "mainCategory": "Celulares e Telefonia",
      "subCategory": "Celulares e Smartphones",
      "location": {
        "state": "PR",
        "city": "Maringá",
        "neighborhood": "Parque da Gávea",
        "region": "Maringá e região",
        "ddd": "44",
        "zipCode": "87053336"
      },
      "seller": {
        "id": "53757a3c-9496-49fe-a411-fc52ff341c4c",
        "nameHash": "d1862155c8a804c969883cb72c755dd3fa1591aac55aec154c8b2fbe42b3fb7f"
      },
      "phoneHashes": [],
      "images": [
        {
          "url": "https://img.olx.com.br/images/38/388649764309681.jpg"
        }
      ],
      "attributes": [
        {
          "name": "electronics_brand",
          "label": "Marca",
          "value": "APPLE"
        }
      ],
      "olxPayEnabled": true,
      "olxDeliveryEnabled": true
    }
  }
}

Complete field reference

PathTypeDescriptionExample
data.data.adId string ID. 1780915956
data.data.attributes[].label string Human-readable attribute label. Marca
data.data.attributes[].name string Technical identifier of the attribute. electronics_brand
data.data.attributes[].url string (optional) URL attribute-related navigation, when available. N/A
data.data.attributes[].value string Attribute value. APPLE
data.data.category string Ad category. Celulares e Smartphones
data.data.currency string Ad currency. BRL
data.data.description string Standard description of the ad. iPhone 14 com 128GB de armazenamento, perfeito para suas fotos, videos e aplicativos.
data.data.images[].url string URL ad image. https://img.olx.com.br/images/38/388649764309681.jpg
data.data.listedAt string (iso datetime) ISO Publish date/time. 2026-06-01T02:37:38.000Z
data.data.listedAtEpoch number Unix publishing timestamp (seconds). 1780281458
data.data.listingId string ID from listing OLX. 1506913293
data.data.location.city string City of advertisement. Maringá
data.data.location.ddd string DDD associated with the ad. 44
data.data.location.neighborhood string Ad neighborhood. Parque da Gávea
data.data.location.region string Region informed in the ad. Maringá e região
data.data.location.state string UF. PR
data.data.location.zipCode string CEP associated with the ad. 87053336
data.data.mainCategory string Main ad category. Celulares e Telefonia
data.data.olxDeliveryEnabled boolean Indicates whether OLX Delivery is enabled. true
data.data.olxPayEnabled boolean Indicates whether OLX Pay is enabled. true
data.data.phoneHashes[] string (optional) List of SHA-256 hashes of phones detected in the ad. N/A
data.data.price number Standard numeric price. 2200
data.data.seller.id string Public identifier of the selling account. 53757a3c-9496-49fe-a411-fc52ff341c4c
data.data.seller.isProfessional boolean (optional) Indicates whether the seller is professional, when available. N/A
data.data.seller.nameHash string Hash SHA-256 of seller name (LGPD). d1862155c8a804c969883cb72c755dd3fa1591aac55aec154c8b2fbe42b3fb7f
data.data.subCategory string Ad subcategory. Celulares e Smartphones
data.data.title string Main ad title. iPhone 14 128GB Branco
data.data.url string URL ad public. https://pr.olx.com.br/regiao-de-maringa/celulares/iphone-14-128gb-branco-1506913293
data.extractedAt string (iso datetime) Extraction Timestamp UTC. 2026-06-02T11:41:18.615Z
data.parser "1.0.0" Stable version of the API response format. 1.0.0
data.requestUrl string Same value as `data.data.url`; never exposes the queried internal endpoint. https://pr.olx.com.br/regiao-de-maringa/celulares/iphone-14-128gb-branco-1506913293
data.source string Extraction source. olx.com.br
data.type string Extraction type. pdp
executionId string (uuid) Field executionId returned in the response payload. 9d0db4f1-b7d8-4d71-9dbe-9d61a41b9522
notFound boolean (optional; true when the upstream entity was not found and data is null) Present and true when the upstream entity was not found. In this case data is null and the request still completes successfully. N/A
requestId string (uuid) Field requestId returned in the response payload. 9d0db4f1-b7d8-4d71-9dbe-9d61a41b9521

Errors and missing data

When supported by this operation, an entity not found upstream can return HTTP 200 with data: null and notFound: true. Check the documented response fields before interpreting an empty result. Source-specific behavior and exceptions are described above.

HTTP statusError codeMeaning
400INVALID_PAYLOADInvalid JSON or a request that violates the documented validation rules.
401UNAUTHORIZEDMissing authorization or an invalid API key or token.
402INSUFFICIENT_CREDITSThe account has insufficient credits for this operation.
403FORBIDDENThe account does not have access, or the API is temporarily disabled.
409EXECUTION_CONFLICTThe execution identifier conflicts with an incompatible execution state.
429RATE_LIMIT_EXCEEDED / TOO_MANY_INFLIGHT_REQUESTSA rate limit or simultaneous request limit was exceeded.
5xxUPSTREAM_TIMEOUT / UPSTREAM_HTTP_ERROR / WORKER_FUNCTION_ERRORAn upstream, worker or gateway failure. Failed requests follow the platform refund policy.

Other OLX operations