API Arkivu

Documentação pública da API Arkivu — a plataforma de automação de download e gestão de documentos fiscais brasileiros (SPED) da Receita Federal.

Beta

A API está em Beta. Endpoints e contratos podem mudar sem aviso prévio enquanto não houver versionamento formal (v1) e política de compatibilidade.

Por onde começar

• :material-book-open-variant: Guia de consumo

  ---

  Como reproduzir, apenas por chamadas de API, tudo o que a interface faz: autenticação, certificados, pesquisa, solicitação, acompanhamento e download.

  :octicons-arrow-right-24: Abrir o guia

• :material-api: Referência da API

  ---

  Referência interativa (Redoc, somente leitura) gerada a partir do schema OpenAPI da API Arkivu.

  :octicons-arrow-right-24: Abrir a referência

Fundamentos

• Base URL: https://api.arkivu.com.br/api
• Autenticação: header Authorization: Bearer <access_token> em todas as chamadas. A única exceção é GET /filtros/ (endpoint público de descoberta).
• Operações longas: seguem o padrão assíncrono — iniciar devolve um operationId e o resultado é obtido por polling. Veja o bloco Acompanhamento no guia.

Versionamento

Durante o Beta não há garantia de compatibilidade retroativa. Acompanhe esta documentação para mudanças de contrato.