bolsixDocs
Get API key

Integrations

REST API

A versioned JSON API for backend applications. All public market endpoints require an API key and share the base URL below.

Base URLhttps://api.bolsix.io

Example: screen Brazilian stocks

Ratio filters are decimal fractions: min_roe=0.15 means 15% or greater.

curl "https://api.bolsix.io/v1/stocks/screen?asset_class=stock&min_roe=0.15&max_pe=12&sort_by=roe" \
  -H "Authorization: Bearer bx_live_..."

Conventions

  • Symbols: use B3 tickers such as PETR4, VALE3, or HGLG11.
  • Dates: ISO YYYY-MM-DD; timestamps are ISO 8601.
  • Pagination: listings use limit/offset; prices and filings return an opaque meta.next_cursor.
  • Timing: every HTTP response includes X-Took-Ms; JSON responses also expose meta.took_ms.
  • Sources: inspect meta.data_source and per-record provenance before presenting results.
Browse every endpoint →