StatusInvest APIstatusinvest.com.br ↗
Access Brazilian stock prices, financial indicators, dividend history, FII distributions, and full stock listings from StatusInvest via a structured JSON API.
What is the StatusInvest API?
This API exposes 6 endpoints covering the Brazilian equity market as tracked by StatusInvest, returning data across search, detailed indicators, price history, dividends, FII distributions, and a full stock universe listing. The get_details endpoint alone surfaces over a dozen financial ratios — P/L, P/VP, ROE, DY, CAGR, and operating margins — keyed by their Portuguese-language names, giving you structured access to the same indicators displayed on each ticker's detail page.
curl -X GET 'https://api.parse.bot/scraper/e22d137f-9aa8-4df2-8485-91eeea290359/search?query=PETR4' \ -H 'X-API-Key: $PARSE_API_KEY'
Search for stocks by ticker symbol or company name. Returns matching stocks and BDRs with current price and daily variation. Each result includes the ticker code, company name, current price (in BRL, comma-decimal formatted), daily variation percentage, and a relative URL path.
| Param | Type | Description |
|---|---|---|
| queryrequired | string | Search query — a ticker symbol (e.g. PETR4) or company name (e.g. Petrobras). |
{
"type": "object",
"fields": {
"items": "array of matching stock objects, each containing code (ticker), name, price, variation, variationUp, type, and url"
},
"sample": {
"data": {
"items": [
{
"id": 530,
"url": "/acoes/petr4",
"code": "PETR4",
"name": "PETROBRAS",
"type": 1,
"price": "41,83",
"parentId": 408,
"variation": "1,830",
"variationUp": true,
"nameFormated": "PETR4 - PETROBRAS",
"normalizedName": "petrobras"
}
]
},
"status": "success"
}
}About the StatusInvest API
Search and Stock Lookup
The search endpoint accepts a ticker symbol or company name (e.g. PETR4 or Petrobras) and returns matching stocks and BDRs with their current price in BRL, daily variation percentage, and a relative URL path. The get_details endpoint takes a single ticker parameter (case-insensitive) and returns two structured blocks: a summary object with current_price and dividend_yield as strings, and an indicators map where each key is the Portuguese-language indicator name and each value is the formatted string shown on the site — covering ratios like P/L, P/VP, ROE, ROA, ROIC, CAGR, and profit margins.
Price History and Dividends
The get_history endpoint returns approximately 30 trading days of closing prices for a given ticker. Each entry in the items array carries a currencyType, currency name, symbol (e.g. R$), and a prices array with numeric price values and dd/MM/yy HH:mm formatted date strings. The get_dividends endpoint queries announced and paid dividend events by year and month (both optional, defaulting to the current UTC period). It returns two arrays — announced and payments — where each event includes the ticker code, company name, dividend type description, absolute value, ex-date (dateCom), and payment date.
FII Distributions and Full Stock Universe
The get_fii_dividends endpoint returns the complete earnings history for a Brazilian FII or FIAGRO ticker, from the fund's first distribution to the latest announced one, ordered newest-first. Each row includes ticker, type, typeDescription, dateCom in dd/MM/yyyy format, and the distribution amount. The total field gives the row count. The list_stocks endpoint requires no inputs and returns all listed Brazilian stocks with companyid, companyname, ticker, price, and valuation indicators including dy, p_l, p_vp, roe, roa, roic, and liquidezmediadiaria (average daily liquidity).
The StatusInvest API is a managed, monitored endpoint for statusinvest.com.br — not a raw scraper you maintain. Every endpoint is automatically health-checked on a schedule, and when statusinvest.com.br changes and a check fails, the API is automatically queued for repair and re-verified. It is built to keep working as the site underneath it changes.
This isn't an official statusinvest.com.br API — it's an independent, maintained REST wrapper over public data. Where the source has no official API (or only a limited one), Parse gives you a stable contract over a source that never promised one, and keeps it current. Need a new endpoint or field? You can revise it yourself in plain English and the agent rebuilds it against the live site in minutes — contributing the change back to the shared API is free.
Will this API break when the source site changes?+
Is this an official API from the source site?+
Can I fix or extend this API myself if I need a new endpoint or field?+
What happens if I call an endpoint that has an issue?+
- Screen all listed Brazilian stocks by P/L, P/VP, and ROE using the
list_stocksendpoint to build a quantitative filter. - Track monthly dividend calendars for Brazilian equities by querying
get_dividendswith specific year and month parameters. - Build a FII income tracker by pulling the full distribution history for multiple tickers via
get_fii_dividends. - Monitor recent price movement for individual tickers using the ~30-day closing price series from
get_history. - Populate a stock detail view with fundamental ratios like CAGR, margins, and DY retrieved from
get_details. - Implement a ticker autocomplete feature in a portfolio app using the
searchendpoint with company name or symbol queries. - Compare dividend yield and liquidity across the full stock universe by ingesting the
list_stocksresponse into a local database.
| Tier | Price | Credits/month | Rate limit |
|---|---|---|---|
| Free | $0/mo | 200 | 5 req/min |
| Hobby | $30/mo | 1,000 | 20 req/min |
| Developer | $100/mo | 5,000 | 100 req/min |
| Team | $300/mo | 20,000 | 300 req/min |
| Company | $1,000/mo | 100,000 | 500 req/min |
Each endpoint has a fixed posted price per successful call — most fall between 1 and 10 credits — shown on this API's page before you run it. Exceeding the rate limit returns a 429 response. Authenticate with the X-API-Key header.
Does StatusInvest have an official developer API?+
What does `get_details` return and how are indicator names formatted?+
summary object with current_price and dividend_yield, plus an indicators map where keys are Portuguese-language names (as shown on the StatusInvest site) and values are formatted strings. This means field names like 'P/L', 'P/VP', 'ROE', and 'Margem Líquida' appear directly as keys. There is no English-language alias layer in the response.Does `get_history` return intraday price data or longer historical ranges?+
Does the API cover fixed-income securities, debentures, or options listed on B3?+
How are prices and numeric values formatted in responses?+
1.234,56). The get_history prices array uses numeric types, but string fields from get_details and search use the comma-decimal format. Factor this in when parsing values programmatically.