Access Brazil CVM Filings with Lua

Need a Lua CVM filings API client for Brazilian public companies? apicvm is plain HTTPS JSON. Use Lua's HTTP stack with a Bearer token — there is no official Lua package.

The problem

Lua developers building research CLIs or services often scrape brittle portal HTML or unpack yearly ZIPs without stable document UUIDs. A thin HTTP client against /v1 keeps code close to the wire.

Setup

export APICVM_URL='https://apicvm.dev'
export APICVM_KEY='apicvm_...'   # from /signup

Resolve a ticker

curl -H "Authorization: Bearer $APICVM_KEY" \
  "$APICVM_URL/v1/companies/resolve?query=PETR4&by=ticker"

Mirror the same request from Lua's HTTP client.

List DFP documents

curl -H "Authorization: Bearer $APICVM_KEY" \
  "$APICVM_URL/v1/documents?ticker=PETR4&type=DFP&year=2024&perPage=20"

Parse the JSON data array for id values before downloading.

Download a PDF

curl -OJ -H "Authorization: Bearer $APICVM_KEY" \
  "$APICVM_URL/v1/documents/<document-id>/file"

File download does not consume extraction credits.

Python cross-check

import os, requests

BASE = os.environ["APICVM_URL"]
H = {"Authorization": f"Bearer {os.environ['APICVM_KEY']}"}

docs = requests.get(
    f"{BASE}/v1/documents",
    headers=H,
    params={"ticker": "PETR4", "type": "DFP", "year": 2024, "perPage": 20},
).json()
print(len(docs["data"]))

Current limitations

Text extraction (POST /v1/document-text-extractions) is async via callback — not a sync Lua await of markdown.
perPage max is 50; paginate with page.
Corpus coverage depends on ingestion; empty lists are not "company never filed".

Next steps

Ready to integrate?

Get an API key and start querying Brazilian CVM filings programmatically.

Read the API docs Get API key