// docs hub

Documentação de Extract, Conta, Workflows e MCP

Guias técnicos e operacionais para integrar as APIs da GeckoAPI, consultar créditos, executar workflows prontos no dashboard ou via API key e entender os arquivos gerados por cada fluxo suportado hoje.

REST endpoint

POST /v1/extract

MCP endpoint

POST /v1/mcp

Conta

GET /v1/me/credits

Autenticação

Bearer ou X-API-Key

APIs suportadas

67

Workflows suportados

2

MCP hospedado

Guia do endpoint remoto `/v1/mcp`

Veja autenticação, naming de tools, `initialize`, `tools/list`, `tools/call`, formato de sucesso/erro e a limitação da v1 para chaves estáticas.

Conta autenticada

Guia de créditos e consumo recente

Consulte o saldo atual de créditos e o total consumido nas últimas 24 horas, 7 dias e 30 dias usando token do dashboard ou API key.

Workflows no dashboard

Guia dos workflows prontos da GeckoAPI

Entenda o que é um workflow, como configurar uma execução no dashboard ou via API key, como a estimativa de créditos funciona e quais dados saem em JSON ou CSV em cada template disponível.

Workflows disponíveis

Fontes suportadas no momento

123Milhas (1) Airbnb (2) AliExpress (2) Amazon (2) Booking (3) Casa dos Dados (1) Casas Bahia (3) Catho (2) Chaves na Mão (2) ClickBus (1) Correios (1) Decolar (1) Glassdoor (2) Google (2) Hoteis.com (3) KAYAK (1) LATAM (1) Magalu (3) MaxMilhas (1) Mercado Livre (3) Netshoes (2) OLX (2) Pede.ai (2) Portal Zuk (2) Reclame AQUI (4) Shopee (2) Smiles (1) Sympla (2) Temu (2) Trivago (2) VivaReal (2) Azul (1) GOL (1) Webmotors (2) X (1) Zapimoveis (2)

Esta documentação cobre apenas APIs com suporte ativo no backend atual.

Escolha uma API

123Milhas Flights Search

123milhas.com:plp

PLP

Extrai ofertas de voos da 123Milhas por aeroporto de origem/destino, datas e passageiros. A API abre a busca publica, autentica o fluxo web e consulta o endpoint de flight search, retornando grupos de ofertas e trechos normalizados em JSON estruturado.

Airbnb PDP

airbnb.com.br:pdp

PDP

Extrai dados detalhados de uma pagina de acomodacao no Airbnb.

Airbnb PLP

airbnb.com.br:plp

PLP

Extrai listagem de acomodacoes do Airbnb por destino e periodo, com filtro opcional por latitude/longitude.

AliExpress PDP

aliexpress.com:pdp

PDP

Extrai dados de produto (PDP) do AliExpress via MTOP mobile assinado. Custo: 5 creditos por request.

AliExpress PLP

aliexpress.com:plp

PLP

Extrai listagem de produtos (PLP) do AliExpress por URL ou keyword. Custo: 5 creditos por request.

Amazon PDP

amazon.com.br:pdp

PDP

Extrai dados completos de produto (PDP) da Amazon Brasil.

Amazon PLP

amazon.com.br:plp

PLP

Extrai listagem de produtos (PLP) da Amazon com paginação.

Booking PDP

booking.com.br:pdp

PDP

Extrai detalhes completos de hotel (PDP) do Booking, incluindo FAQ, traveler Q&A, restaurantes, amenities, facilities agrupadas, imagens de quarto, refeicoes e informacoes da area.

Booking PLP

booking.com.br:plp

PLP

Extrai listagem de hospedagens (PLP) do Booking com paginação.

Booking Review

booking.com.br:review

Review

Extrai avaliacoes de hotel no Booking com paginação, ordenacao e filtro por periodo do ano.

Casa dos Dados PDP (CNPJ)

casadosdados.com.br:pdp

PDP

Extrai dados cadastrais completos de empresa na Casa dos Dados a partir de um CNPJ.

Casas Bahia PDP

casasbahia.com.br:pdp

PDP

Extrai dados completos de produto (PDP) da Casas Bahia, incluindo oferta principal, sellers secundarios, atributos e variacoes.

Casas Bahia PLP

casasbahia.com.br:plp

PLP

Extrai listagem de produtos (PLP) da Casas Bahia, com paginacao e URL publica opcional a partir da keyword.

Casas Bahia Quote

casasbahia.com.br:quote

Quote

Extrai cotacoes de frete da Casas Bahia para um produto especifico por URL e CEP, resolvendo o seller a partir da oferta retornada pela origem.

Catho PDP

catho.com.br:pdp

PDP

Extrai detalhes completos de vaga (PDP) da Catho.

Catho PLP

catho.com.br:plp

PLP

Extrai listagem de vagas (PLP) da Catho com filtros e paginação.

Chaves na Mão PDP

chavesnamao.com.br:pdp

PDP

Extrai dados detalhados de um anúncio imobiliário da Chaves na Mão usando a URL pública do imóvel.

Chaves na Mão PLP

chavesnamao.com.br:plp

PLP

Extrai páginas de listagem imobiliária da Chaves na Mão para venda e aluguel. Aceita URL pública do PLP ou filtros amigáveis para montar a busca, com filtro opcional por latitude/longitude.

ClickBus PLP

clickbus.com.br:plp

PLP

Extrai listagem de viagens de onibus na ClickBus por origem/destino (cidade + UF) e data de saida, com retorno opcional e pagina.

Correios Quote

correios.com.br:quote

Quote

Extrai cotacoes de frete dos Correios por CEP de origem, CEP de destino e dimensoes do pacote, retornando opcoes como Sedex e PAC com prazo e preco.

Decolar Flights Search

decolar.com:plp

PLP

Extrai resultados de passagens aereas da Decolar por aeroporto de origem/destino, datas e ocupacao. O backend consulta o endpoint interno necessario, mas a resposta expoe apenas a URL publica de resultados da Decolar.

Glassdoor PDP

glassdoor.com.br:pdp

PDP

Extrai detalhes completos de vaga (PDP) do Glassdoor, com fallback para JSON-LD quando necessário.

Glassdoor PLP

glassdoor.com.br:plp

PLP

Extrai listagem de vagas (PLP) do Glassdoor com paginação, localização e suporte a remoto.

Google Search

google.com:plp

PLP

Extrai resultados orgânicos do Google Search por palavra-chave, com geolocalização fixa no Brasil e paginação por página.

Google Places

google.com:places

Places

Extrai locais do Google Maps por palavra-chave e endereço de referência.

Hoteis.com PDP

hoteis.com:pdp

PDP

Extrai detalhes de hotel (PDP) do Hoteis.com com o mesmo padrao de entrada do Booking PDP: URL + datas de estadia e ocupacao.

Hoteis.com PLP

hoteis.com:plp

PLP

Extrai listagem de hospedagens do Hoteis.com por localizacao, datas e ocupacao (adultos, criancas e quartos), com paginação.

Hoteis.com Review

hoteis.com:review

Review

Extrai avaliacoes de hotel do Hoteis.com com paginacao e ordenacao.

KAYAK Flights Search

kayak.com.br:plp

PLP

Extrai resultados de voos do KAYAK Brasil por aeroporto de origem/destino, datas e passageiros. A API usa o fluxo mobile do KAYAK, com sessão, replay e polling, retornando tarifas, segmentos, fornecedores e status da busca em JSON estruturado.

LATAM Flights Search

latamairlines.com:plp

PLP

Extrai opcoes de voos e tarifas da LATAM por aeroporto de origem/destino, datas, passageiros e modo dinheiro ou pontos em JSON estruturado.

Magalu PDP

magazineluiza.com.br:pdp

PDP

Extrai dados completos de produto (PDP) da Magalu via endpoint mobile GraphQL nao renderizado.

Magalu PLP

magazineluiza.com.br:plp

PLP

Extrai listagem de produtos (PLP) da Magalu via endpoint mobile nao renderizado, com paginação.

Magalu Quote

magazineluiza.com.br:quote

Quote

Extrai cotacoes de frete da Magalu para um produto especifico por URL e CEP, usando OAuth guest e o endpoint mobile de shipments.

MaxMilhas Flights Search

maxmilhas.com.br:plp

PLP

Extrai ofertas de voos da MaxMilhas por aeroporto de origem/destino, datas e passageiros. A API cria a busca, consulta as companhias retornadas e entrega ofertas normalizadas em JSON estruturado.

Mercado Livre PDP

mercadolivre.com.br:pdp

PDP

Extrai dados completos de produto (PDP) do Mercado Livre, com CEP opcional para frete e prazo.

Mercado Livre PLP

mercadolivre.com.br:plp

PLP

Extrai listagem de produtos (PLP) do Mercado Livre com paginação.

Mercado Livre Review

mercadolivre.com.br:review

Review

Extrai avaliacoes de produto no Mercado Livre com paginação.

Netshoes PDP

netshoes.com.br:pdp

PDP

Extrai dados detalhados de produto (PDP) da Netshoes a partir do HTML bruto nao renderizado, incluindo grade de tamanhos, recomendacao de reviews, atributos e dimensoes.

Netshoes PLP

netshoes.com.br:plp

PLP

Extrai listagem de produtos (PLP) da Netshoes com URL pronta opcional ou busca por keyword, incluindo ordenacao, paginacao, tamanhos e seller do impression layer.

OLX PDP

olx.com.br:pdp

PDP

Extrai dados detalhados de um anúncio da OLX com hash LGPD para sellerName e telefones.

OLX PLP

olx.com.br:plp

PLP

Extrai listagem de anuncios da OLX com URL pronta opcional ou filtros por keyword, categoria, regiao/cidade, ordenacao e faixa de preco.

Pede.ai PDP (Merchant)

pede.ai:pdp

PDP

Extrai merchant + catalogo do pede.ai por merchantId + CEP. O backend resolve a area automaticamente via /v1/extract/lookups/pede.ai/resolve-zip-code e retorna apenas URLs publicas sinteticas do pede.ai.

Pede.ai PLP

pede.ai:plp

PLP

Extrai merchants do pede.ai a partir de um CEP brasileiro. O backend resolve cityId + areaId internamente via /v1/extract/lookups/pede.ai/resolve-zip-code e retorna apenas URLs publicas sinteticas do pede.ai.

Portal Zuk PDP — detalhes do imóvel em leilão

portalzuk.com.br:pdp

PDP

Extrai uma página de imóvel em leilão do Portal Zuk com identificação do lote, endereço e coordenadas, fotos, ocupação, características, rodadas, valores, desconto, vendedor, matrícula, processo, visitação, pagamentos e documentos.

Portal Zuk PLP — busca de leilões de imóveis

portalzuk.com.br:plp

PLP

Busca e pagina imóveis em leilão no Portal Zuk. Aceita palavra-chave ou localização estruturada, modalidade/situação, tipo de imóvel, vendedor, ocupação, desconto, parcelamento, quartos, vagas, preço, área e ordenação.

Reclame AQUI PDP — Perfil da empresa

reclameaqui.com.br:pdp

PDP

Carrega o perfil público de uma empresa no Reclame AQUI com identidade, contatos, segmentos, verificação, recursos da página e histórico de reputação. Custo: 1 crédito por request.

Reclame AQUI IDP — Detalhes da reclamação

reclameaqui.com.br:idp

IDP

Carrega uma reclamação pública completa com relato, classificação, status, avaliação do consumidor e todas as interações públicas em ordem cronológica. Custo: 1 crédito por request.

Reclame AQUI PLP — Busca de empresas

reclameaqui.com.br:plp

PLP

Busca empresas no Reclame AQUI por URL ou palavra-chave e retorna identidade, localização, verificação, segmentos e um resumo de reputação. Custo: 1 crédito por request.

Reclame AQUI ILP — Lista de reclamações

reclameaqui.com.br:ilp

ILP

Lista reclamações públicas de uma empresa com paginação, busca textual, aliases de status, filtros de taxonomia e facets para novas consultas. O pageSize é fixo em 5. Custo: 1 crédito por request.

Shopee PDP

shopee.com.br:pdp

PDP

Extrai dados ricos de produto (PDP) da Shopee Brasil a partir do HTML bruto da pagina, incluindo seller, variacoes, midia, frete, estoque e atributos.

Shopee PLP

shopee.com.br:plp

PLP

Extrai resultados de busca/listagem (PLP) da Shopee Brasil com processamento renderizado e retorno estruturado em JSON. Custo: 25 creditos por request.

Smiles Flights Search

smiles.com.br:plp

PLP

Extrai ofertas de passagens da Smiles por aeroporto de origem/destino, datas e passageiros. A API consulta o endpoint mobile de flight search e retorna opções normalizadas com pontos, taxas, horários e trechos em JSON estruturado.

Sympla PDP

sympla.com.br:pdp

PDP

Extrai pagina de evento do Sympla com metadados do evento, produtor, local e tickets agrupados sem browser rendering, preservando a URL de entrada e expondo a URL canonica separadamente.

Sympla PLP

sympla.com.br:plp

PLP

Extrai resultados de busca do Sympla por keyword e pagina, com total de resultados, proxima pagina e cards de eventos sem browser rendering.

Temu PDP

temu.com:pdp

PDP

Extrai dados completos de produto (PDP) da Temu via fluxo app off-phone. Custo: 5 creditos por request.

Temu PLP

temu.com:plp

PLP

Extrai resultados de busca/listagem (PLP) da Temu via fluxo app off-phone. Custo: 5 créditos por request.

Trivago PDP

trivago.com.br:pdp

PDP

Extrai os detalhes de uma acomodação do Trivago, incluindo identidade, descrição, avaliação, endereço, imagens, comodidades, quartos e ofertas disponíveis.

Trivago PLP

trivago.com.br:plp

PLP

Busca acomodações no Trivago por destino, datas e ocupação, retornando preços previstos, avaliações, destaques e paginação em JSON estruturado.

VivaReal PDP

vivareal.com.br:pdp

PDP

Extrai todos os detalhes relevantes de um imóvel ou empreendimento do VivaReal, incluindo status, preços, atributos, endereço, anunciante, mídia, plantas, unidades e dados de construção.

VivaReal PLP

vivareal.com.br:plp

PLP

Extrai resultados de busca do VivaReal para venda, aluguel e lançamentos, com paginação, filtros imobiliários, anunciante, preços, mídia e atributos normalizados.

Azul Flights Search

voeazul.com.br:plp

PLP

Extrai disponibilidade, itinerarios e tarifas da Azul por aeroporto de origem/destino, datas e passageiros em JSON estruturado. A API retorna viagens, jornadas, segmentos, familias tarifarias, menor tarifa e calendario flexivel em dinheiro ou pontos TudoAzul.

GOL Itineraries Search

voegol.com.br:plp

PLP

Extrai itinerários e tarifas da GOL por aeroporto de origem/destino, datas e passageiros. A API retorna voos, segmentos, marcas tarifárias e a menor tarifa disponível por itinerário.

Webmotors PDP

webmotors.com.br:pdp

PDP

Extrai dados completos de anuncio de veiculo (PDP) do Webmotors.

Webmotors PLP

webmotors.com.br:plp

PLP

Extrai listagem de veiculos (PLP) do Webmotors por cidade/UF com filtros amigaveis para carros, motos, preco, ano, km, marca, modelo, opcionais e oportunidades.

X Tweets Search

x.com:plp

PLP

Extrai tweets de busca do X por palavra-chave usando Nitter como fonte publica, com dados de autor anonimizados por hash salgado, texto, metricas, links, midia e paginacao por cursor.

Zapimoveis PDP

zapimoveis.com.br:pdp

PDP

Extrai dados detalhados de um anúncio de imóvel do Zapimoveis.

Zapimoveis PLP

zapimoveis.com.br:plp

PLP

Extrai listagem de imoveis do Zapimoveis por cidade/UF e tipo de negocio, com keyword opcional, filtros de busca e filtro por latitude/longitude.

Erros comuns do endpoint

Quando a entidade consultada não existe na origem, o endpoint retorna 200 com data: null e notFound: true. A tabela abaixo cobre apenas respostas de erro.

Status errorCode Quando acontece
400 INVALID_PAYLOAD JSON inválido ou violação das regras de validação do payload.
401 UNAUTHORIZED Header Authorization ausente ou token/chave inválida.
402 INSUFFICIENT_CREDITS Saldo de créditos insuficiente para a API solicitada.
403 FORBIDDEN Usuário sem acesso ou API temporariamente desabilitada.
409 EXECUTION_CONFLICT executionId conflita com uma execução em estado incompatível.
429 RATE_LIMIT_EXCEEDED / TOO_MANY_INFLIGHT_REQUESTS Limite de taxa ou limite de requisições em voo excedido.
5xx UPSTREAM_TIMEOUT / UPSTREAM_HTTP_ERROR / WORKER_INVOCATION_FAILED / WORKER_FUNCTION_ERROR / WORKER_INVALID_RESPONSE / INTERNAL_ERROR Falha de servidor no worker, provider/proxy ou gateway. Nesses casos os créditos são estornados automaticamente.
Grátis para sempre

Pronto para integrar?

Use as páginas de API e workflows para copiar requests, entender o consumo de créditos e validar o formato do arquivo final antes de ir para produção.