Base URL: https://api.orbioapi.com.br

Exemplo — Export assíncrono

1) Criar export

http
POST https://api.orbioapi.com.br/v1/exports
Authorization: Bearer <API_KEY>
Content-Type: application/json

{
  "spec": {
    "kind": "account_query",
    "spec_version": "2.0",
    "entity": "company",
    "limit": 5000,
    "filters": {
      "industry": { "cnae_any_of": ["6201-5/00"], "cnae_exclude": [], "secondary_cnae_mode": "fallback", "text_hints": ["software B2B"] },
      "geo": { "uf_any_of": ["SP"], "municipality_ibge_any_of": [], "municipality_tom_any_of": [] },
      "company": { "registration_status_any_of": [2], "company_size_code_any_of": [], "headquarters_only": true, "simples_opt_in": null, "mei_opt_in": null, "started_after": null, "started_before": null },
      "contact": { "require_email": false, "require_phone": false, "require_any_contact": false }
    },
    "sort": [{ "field": "score", "direction": "desc" }],
    "scoring": { "strategy": "balanced", "random_seed": null },
    "output": { "format": "csv", "include_explain": false, "fields": ["cnpj", "legal_name", "uf"] },
    "explain": { "assumptions": [], "warnings": [], "unmapped_constraints": [], "confidence": 0.74 }
  },
  "output": { "format": "csv", "include_explain": false, "fields": ["cnpj", "legal_name", "uf"] },
  "limit": 5000
}

Resposta (201):

json
{
  "export": {
    "export_id": "exp_123",
    "status": "queued"
  }
}

2) Polling

http
GET https://api.orbioapi.com.br/v1/exports/exp_123
Authorization: Bearer <API_KEY>

Quando status for done, siga para download.

3) Download

http
GET https://api.orbioapi.com.br/v1/exports/exp_123/download
Authorization: Bearer <API_KEY>

A resposta é 303 com Location para a URL assinada.