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

Primeira requisição

Objetivo: executar uma busca simples e entender cada campo da resposta.

Requisição

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

{
  "spec": {
    "kind": "account_query",
    "spec_version": "2.0",
    "entity": "company",
    "limit": 5,
    "filters": {
      "industry": {
        "cnae_any_of": ["6201-5/00"],
        "cnae_exclude": [],
        "secondary_cnae_mode": "off",
        "text_hints": []
      },
      "geo": {
        "uf_any_of": ["SP"],
        "municipality_ibge_any_of": [],
        "municipality_tom_any_of": []
      },
      "company": {
        "registration_status_any_of": [],
        "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": true,
        "require_phone": false,
        "require_any_contact": false
      }
    },
    "sort": [],
    "scoring": { "strategy": "balanced", "random_seed": null },
    "output": {
      "format": "json",
      "include_explain": false,
      "fields": ["cnpj", "legal_name", "uf", "municipality_ibge", "cnae_primary"]
    },
    "explain": {
      "assumptions": [],
      "warnings": [],
      "unmapped_constraints": [],
      "confidence": 0.9
    }
  }
}

Resposta (200 OK)

json
{
  "request_id": "req_01HX...",
  "snapshot": "2026-01",
  "snapshot_date": "2026-01-31",
  "provenance": {
    "rfb_snapshot": "2026-01",
    "ibge_population_year": "not_available",
    "ceis_as_of_date": "not_available"
  },
  "accounts": [
    {
      "cnpj": "00000000000000",
      "legal_name": "SOFTWARE EXEMPLO LTDA",
      "uf": "SP",
      "municipality_ibge": "3550308",
      "cnae_primary": "6201500"
    }
  ],
  "next_cursor": null,
  "has_more": false
}

Como interpretar

  • request_id: ID único para rastrear logs/erros.
  • snapshot: base do mês usada.
  • snapshot_date: data do snapshot (proveniencia).
  • provenance: metadados de origem (por fonte).
  • spec: filtros normalizados (reprodutiveis) sempre presentes na resposta completa (omitido no snippet acima).
  • accounts: resultados no formato solicitado.
  • next_cursor / has_more: paginação.

Dica sobre fields

Os campos disponíveis variam por plano. Para ver a lista atual, consulte GET /v1/status (ver Status).

Próximos passos: