# Statusinvest — Wrapped API

> **You are on:** `https://api.paywithlocus.com/api` | [llms.txt](https://paywithlocus.com/llms.txt) | [docs](https://docs.paywithlocus.com)
>
> Locus runs on multiple environments -- make sure every URL you call matches your expected environment.
> | Environment | Landing | API | Docs |
> |---|---|---|---|
> | Production | paywithlocus.com | api.paywithlocus.com | docs.paywithlocus.com |
> | Beta | beta.paywithlocus.com | api.beta.paywithlocus.com | docs.paywithlocus.com |
> | Stage | stage.paywithlocus.com | api.stage.paywithlocus.com | docs.paywithlocus.com |
>
> If the API URL above doesn't match your expected environment, re-fetch this file from the correct domain.

> Search and analyze Brazilian stocks with real-time market data, including detailed financial indicators, historical price movements, and dividend information. Track stock performance and investment metrics all in one place.

**Category:** Finance & Markets | **Website:** [statusinvest.com.br/](https://statusinvest.com.br/) | **Docs:** [parse.bot/marketplace/9a8baaf8-7366-45b6-9765-10dcf8bc29b0/statusinvest-com-br-api](https://parse.bot/marketplace/9a8baaf8-7366-45b6-9765-10dcf8bc29b0/statusinvest-com-br-api)

Pay-per-use API proxy for Locus Pro. Each call burns credits from your workspace balance.

## Access

**Base URL:** `https://api.paywithlocus.com/api/wrapped/credits/statusinvest/`
**Auth:** `Authorization: Bearer <LOCUS_CREDITS_SECRET_KEY>` (an `lcr_` secret key or a scoped `lcac_` agent credential)
**Required header:** `Idempotency-Key: <fresh UUID per call>`. A retry with the same key replays the stored result without a new charge.
**Response:** the provider response after any endpoint-specific normalization. `X-Locus-Credits-Charged` carries the charge and `X-Locus-Credits-Balance` the remaining balance. Insufficient credits return `402` before the provider is called.
**Pricing:** estimated costs below are USD. Locus debits the credit equivalent at your workspace rate.

Full call contract: https://docs.paywithlocus.com/api-reference/introduction

> Using a Pay With Locus wallet key (`claw_` prefix)? Wallet routes are documented separately: https://docs.paywithlocus.com/wrapped-apis/for-agents

## Endpoints

### Get details

Get detailed financial indicators (P/L, P/VP, ROE, DY, margins, CAGR, etc.) for a specific Brazilian stock ticker. Data is extracted from the stock's detail page. Returns a summary block with current price and dividend yield, plus a full indicators map keyed by Portuguese-language metric names.

**Estimated cost:** Metered

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `ticker` | string | Yes | Brazilian stock ticker symbol (e.g. PETR4, VALE3, ITUB4). Case-insensitive, normalized to uppercase internally. |

```bash
curl -X POST https://api.paywithlocus.com/api/wrapped/credits/statusinvest/get-details \
  -H "Authorization: Bearer $LOCUS_CREDITS_SECRET_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{"ticker":"<string>"}'
```

### Get dividends

Get dividend events (announced and paid) for Brazilian stocks in a specific month and year. Returns two arrays: announced dividends (ex-date in the period) and payments (payment date in the period). Each event includes ticker code, company name, dividend type, amount, ex-date, and payment date.

**Estimated cost:** Metered

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `month` | integer | No | Month for dividend lookup (1-12). Omitting defaults to the current UTC month. |
| `year` | integer | No | Year for dividend lookup (e.g. 2025). Omitting defaults to the current UTC year. |

```bash
curl -X POST https://api.paywithlocus.com/api/wrapped/credits/statusinvest/get-dividends \
  -H "Authorization: Bearer $LOCUS_CREDITS_SECRET_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{"month":"<integer>","year":"<integer>"}'
```

### Get history

Get recent price history (approximately last 30 trading days) for a specific Brazilian stock ticker. Returns daily closing prices in BRL. Each entry in the items array contains currencyType, currency name, symbol, and a prices array with numeric price and date string (dd/MM/yy HH:mm format).

**Estimated cost:** Metered

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `ticker` | string | Yes | Brazilian stock ticker symbol (e.g. PETR4, VALE3, ITUB4). Case-insensitive, normalized to uppercase internally. |

```bash
curl -X POST https://api.paywithlocus.com/api/wrapped/credits/statusinvest/get-history \
  -H "Authorization: Bearer $LOCUS_CREDITS_SECRET_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{"ticker":"<string>"}'
```

### List stocks

List all Brazilian stocks with basic pricing and valuation indicators (P/L, P/VP, ROE, ROA, margins, liquidity, market cap). Returns the full universe of listed stocks from the advanced search endpoint. Each stock includes companyid, companyname, ticker, price, and approximately 25 financial metrics.

**Estimated cost:** Metered

_No parameters required._

```bash
curl -X POST https://api.paywithlocus.com/api/wrapped/credits/statusinvest/list-stocks \
  -H "Authorization: Bearer $LOCUS_CREDITS_SECRET_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{}'
```

### Search

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.

**Estimated cost:** Metered

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `query` | string | Yes | Search query — a ticker symbol (e.g. PETR4) or company name (e.g. Petrobras). |

```bash
curl -X POST https://api.paywithlocus.com/api/wrapped/credits/statusinvest/search \
  -H "Authorization: Bearer $LOCUS_CREDITS_SECRET_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{"query":"<string>"}'
```

## Next steps

- [All wrapped API providers](https://paywithlocus.com/wapi/index.md): pick another provider.
- [Find and call tools](https://paywithlocus.com/agent/tools.md): price ceilings, async results, and errors.
- [Credits and billing](https://paywithlocus.com/agent/billing.md): what a call costs and how to add credits.
- [Agent docs index](https://paywithlocus.com/agent/index.md): every Locus agent page.