B3 listed companies and indices · Index portfolio
b3-com-br/companies/index_portfolioGet market and financial data with B3 listed companies and indices · Index portfolio from Alexandria through one Spiral API key. To get an index's composition; page through with page (default 120 rows covers IBOV in one call). It runs in the background and returns structured JSON. Pay as you go, with no subscription.
Pricing
$0.00873 per call.
Limits
- Runs
- In the background
- Returns
- json
- Longest queue wait
- 1 hour
- Run deadline
- 5 minutes
- Longest run, end to end
- 225 minutes
- Largest inline input
- 1 MB
- Largest input file
- 2 GB
- Largest output
- 5 GB
Input
| Field | Kind | Default | Description |
|---|---|---|---|
index required | text | — | Index acronym, e.g. |
page | number 1 to … | 1 | 1-based page number. |
page_size | number 1 to 120 | — | Rows per page; B3 returns an empty page above 120. |
portfolio | one of theoretical, day, preview | theoretical |
|
Same request in code
curl https://api.spiral.ai/v1/runs \
-H "Authorization: Bearer $SPIRAL_API_KEY" \
-H "Content-Type: application/json" \
-H "Idempotency-Key: $(uuidgen)" \
-d '{
"provider": "alexandria",
"model": "b3-com-br/companies/index_portfolio",
"input": {
"index": "<index>"
}
}'Frequently asked questions
How much does B3 listed companies and indices · Index portfolio cost?
$0.00873 per call. You pay as you go from one Spiral balance, with no subscription, and a failed run is not charged.
How do I use B3 listed companies and indices · Index portfolio through an API?
Send `POST /v1/runs` with `"provider": "alexandria"`, `"model": "b3-com-br/companies/index_portfolio"` and the input fields on this page, using one Spiral API key. It runs in the background: poll the run, or name a webhook to be told when it finishes.
Do I need an account with Alexandria to use B3 listed companies and indices · Index portfolio?
No. Spiral runs it on its own Alexandria account and charges your Spiral balance.
Can my AI agent use B3 listed companies and indices · Index portfolio?
Yes. Agents find and run it through Spiral's MCP server, CLI or agent skill, with the same API key.