FIDCs.com.brDevelopers

Páginas

Indústria e históricoAPI REST & PlaygroundGuia MCP & AgentesReferência OpenAPIChangelog

Categorias

Contrato OpenAPIAçõesCompanhiasCrédito privadoSéries diáriasInformes estruturadosTítulos públicosMacroeconomia e benchmarksIndústriaContratoIdentidadeCadastroDocumentosVisão geralCarteiraCotas e rentabilidadeDemonstrativoInvestidoresCoberturaRaio-X FIC-FIDCOperaçãoPlayground← Testar no Guia REST
Chave apenas na memória
FIDCs.com.brDevelopers
Todas as operações de Documentos

Contrato OpenAPI · Documentos

Pesquisar documentos da classe

GET
/v1/classes/{class_id}/documentos

Lista documentos da classe e do fundo relacionado com tipo, data e link oficial da CVM, sem baixar o arquivo.

Custo: 1 crédito.

Autorização

FIDCs API key
AuthorizationBearer <token>

Envie Authorization: Bearer fidc_live_.... No playground, informe somente a chave completa; a interface monta o header sem persistir o segredo.

In: header

Parâmetros da rota

class_id*Class Id

UUID persistente da classe, obtido em /v1/fundos/{fund_id}/classes ou /v1/resolve.

Parâmetros da consulta

document_type?string|null
start_year?integer|null
end_year?integer|null
limit?Limit

Quantidade de itens na página. Padrão 25; máximo 100.

Range1 <= value <= 100
Default50
offset?Offset
Range0 <= value
Default0

Corpo da resposta

application/json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

application/json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

curl -X GET "https://example.com/v1/classes/b2e1079e-53ab-4306-acc6-905c37ed1021/documentos?limit=25"
{  "data": [    {      "document_id": "string",      "scope": "class",      "document_type": "string",      "document_type_slug": "string",      "category": "string",      "document_date": "string",      "received_at": "string",      "reference_year": 0,      "file_name": "string",      "source_url": "string"    }  ],  "meta": {    "request_id": "string",    "data_release": "string",    "as_of": "string",    "row_count": 0,    "sources": [      {        "provider": "string",        "dataset": "string"      }    ],    "field_sources": {      "property1": "string",      "property2": "string"    },    "receivables_definitions": {},    "receivables_by_month": [      {}    ]  }}