// docs

Busca nos Sites

Configure buscas prontas em sites e marketplaces, combine diferentes fontes e receba um arquivo final com dados estruturados. Na API, este recurso usa os endpoints de workflows.

Buscas prontas

5

Etapas documentadas

19

Formatos de saída

JSON e CSV

Operação

Dashboard e API key

O que é uma busca nos sites?

É uma busca pronta da GeckoAPI que combina múltiplas chamadas, remove duplicidades e enriquece os dados em uma única execução. Em vez de chamar APIs manualmente uma a uma, você escolhe uma busca, informa os parâmetros e recebe o resultado final em JSON ou CSV.

1. Busca pronta

Cada busca já define a sequência de etapas, limites operacionais e lógica de deduplicação para um caso de uso específico.

2. Estimativa antes de rodar

O dashboard mostra uma estimativa máxima de créditos antes da criação da busca, detalhada por etapa.

3. Arquivo final

Ao final, você baixa um arquivo com metadados da execução, resumo operacional e itens prontos para análise, CRM ou enriquecimento.

Como usar no dashboard

  1. PASSO 1

    Selecione a busca que melhor representa o seu caso de uso e revise a descrição das etapas.

  2. PASSO 2

    Preencha os campos do formulário. As buscas aceitam listas, números e filtros específicos dependendo do fluxo.

  3. PASSO 3

    Revise a estimativa máxima de créditos e os limites operacionais antes de iniciar a execução.

  4. PASSO 4

    Acompanhe o status da execução, o progresso por etapa e os eventos enquanto a coleta está em andamento.

  5. PASSO 5

    Baixe o resultado em JSON para preservar a estrutura completa ou em CSV para uso rápido em planilhas e CRMs.

Executar via API key

As buscas também podem ser iniciadas fora do dashboard. Na API, este recurso usa os endpoints de workflows. A autenticação aceita Authorization: Bearer pk_live_... ou X-API-Key: pk_live_.... O contrato público desta v1 cobre criação, consulta de status e cancelamento da execução.

Iniciar busca

POST /v1/workflows/runs

Consultar status

GET /v1/workflows/runs/{runId}/status

Cancelar busca

POST /v1/workflows/runs/{runId}/cancel

Iniciar busca
curl -X POST https://api.geckoapi.com.br/v1/workflows/runs \
+  -H "Authorization: Bearer SUA_CHAVE" \
+  -H "Content-Type: application/json" \
+  -d '{
  "templateId": "ifood-store-idp-enrichment",
  "input": {
    "storeUrl": "https://www.ifood.com.br/delivery/curitiba-pr/fire-s-burger-jardim-gisela/cf787eb5-3689-4a46-b43c-2ceda85d1a76",
    "outputFormat": "csv"
  }
}'
Consultar status
curl https://api.geckoapi.com.br/v1/workflows/runs/wrk_123/status \
+  -H "Authorization: Bearer SUA_CHAVE"
Resposta de busca concluída
{
  "run": {
    "runId": "wrk_123",
    "templateId": "ifood-store-idp-enrichment",
    "status": "completed",
    "outputFormat": "csv",
    "createdAt": "2026-03-30T12:00:00.000Z",
    "updatedAt": "2026-03-30T12:07:41.000Z",
    "errorSummary": null,
    "artifactFileName": "workflow-run.csv",
    "artifactContentType": "text/csv; charset=utf-8",
    "artifactSizeBytes": 28491,
    "artifactAvailable": true,
    "downloadUrl": "https://puxapp-results-123.s3.us-east-1.amazonaws.com/workflows/user/run/file.csv?...",
    "downloadUrlExpiresAt": "2026-03-30T12:22:41.000Z",
    "progress": {
      "plannedTasks": 22,
      "completedTasks": 22,
      "failedTasks": 0,
      "plannedPlpTasks": 0,
      "completedPlpTasks": 0,
      "failedPlpTasks": 0,
      "plannedPdpTasks": 0,
      "completedPdpTasks": 0,
      "failedPdpTasks": 0,
      "discoveredStores": 0,
      "uniqueStores": 0,
      "steps": []
    }
  }
}
Cancelar busca
curl -X POST https://api.geckoapi.com.br/v1/workflows/runs/wrk_123/cancel \
+  -H "Authorization: Bearer SUA_CHAVE"

Cancelar uma busca descarta o acesso ao resultado final e deve ser usado com cautela. A coleta para nos próximos checkpoints do pipeline, então dados parciais podem já ter sido processados internamente, mas uma execução cancelada não expõe downloadUrl.

O que o arquivo final produz

Metadados da execução

Todo arquivo inclui a busca usada, os parâmetros enviados, a identificação da execução e o timestamp de geração.

Resumo operacional

Você vê quantas tarefas foram planejadas, concluídas, falharam e quantos registros únicos entraram no output.

Itens finais

A lista items muda conforme a busca: pode representar lojas, empresas ou imobiliárias enriquecidas.

Buscas disponíveis

Grátis para sempre

Executar uma busca real?

Abra o dashboard ou use sua API key para estimar créditos, iniciar a busca e baixar o resultado final em JSON ou CSV.