// 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
53
Workflows suportados
5
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
iFood Restaurants Enriched
ifood-restaurants-enriched
Busca restaurantes do iFood por keywords e CEPs, pagina os resultados e entrega uma base deduplicada de lojas com os principais dados do merchant.
iFood Store -> IDP
ifood-store-idp-enrichment
Recebe a URL de uma loja do iFood, percorre o cardapio e enriquece cada item com detailUrl usando a API iFood IDP.
Google Places -> iFood -> Casa dos Dados
google-places-ifood-cdd-company-enrichment
Parte de buscas no Google Places, valida presenca no iFood, identifica CNPJ e entrega um artifact company-centric com enrichments da Casa dos Dados.
Zapimoveis -> Google -> Website -> Casa dos Dados
zapimoveis-google-website-cdd-imobiliaria-enrichment
Parte de anuncios no Zapimoveis, consolida imobiliarias unicas, encontra o site oficial, coleta contatos e entrega um artifact com dados da empresa e CNPJ enriquecido.
Mercado Livre -> Google -> AI -> Website -> Casa dos Dados
mercadolivre-google-website-cdd-seller-enrichment
Parte de produtos no Mercado Livre, consolida vendedores unicos, usa uma escada de buscas no Google, valida sites oficiais com IA e pode usar diretorios de CNPJ como fallback para descobrir empresa e contatos.
Fontes suportadas no momento
Esta documentação cobre apenas APIs com suporte ativo no backend atual.
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. |
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.