# Stockanalysis — 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.

> Access comprehensive stock market data including real-time financials, income statements, statistics, and IPO calendars to research individual stocks and identify market movers. Search stocks, view detailed overviews, and monitor premarket activity all in structured, easy-to-use format.

**Category:** Finance & Markets | **Website:** [stockanalysis.com/](https://stockanalysis.com/) | **Docs:** [parse.bot/marketplace/c9e8ac45-0663-4195-91fb-b986563bdfe8/stockanalysis-com-api](https://parse.bot/marketplace/c9e8ac45-0663-4195-91fb-b986563bdfe8/stockanalysis-com-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/stockanalysis/`
**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 ipo calendar

Upcoming IPOs organized by time period: this week, next week, and later. Each IPO entry includes symbol, company name, IPO date, exchange, price range, shares offered, and estimated market cap. Revenue is included when available. Data refreshes as new filings are announced.

**Estimated cost:** Metered

_No parameters required._

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

### Get market movers premarket

Top gainers, losers, and most active stocks in the pre-market session. Each category contains query metadata and a data array of stock entries with symbol, name, premarket change percent, premarket price, premarket volume, and market cap. Active list may be empty outside pre-market hours.

**Estimated cost:** Metered

_No parameters required._

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

### Get stock financials income

Detailed income statement for a stock. Returns annual financial data including revenue, gross profit, operating income, net income, EPS, margins, and growth rates organized in a financialData object with arrays per metric keyed by fiscal year. Also includes display layout metadata (map) and source information (details).

**Estimated cost:** Metered

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `symbol` | string | Yes | Stock ticker symbol (e.g. 'AAPL', 'MSFT', 'NVDA'). |

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

### Get stock list

Stocks from a curated stock list by URL slug. Returns the list title, description, stock count, and an array of stock entries with symbol, name, market cap, price, change, and revenue. Slugs correspond to list pages on the site (e.g. 'mega-cap-stocks', 'most-shorted-stocks').

**Estimated cost:** Metered

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `slug` | string | Yes | List slug from the site URL path. |

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

### Get stock overview

Real-time quote overview for a stock symbol. Returns current price, change, volume, exchange, market status, 52-week range, and extended-hours data. Field keys are abbreviated: p (price), c (change), cp (change percent), v (volume), ex (exchange), h/l (high/low), o (open), h52/l52 (52-week high/low), ms (market status).

**Estimated cost:** Metered

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `symbol` | string | Yes | Stock ticker symbol (e.g. 'AAPL', 'MSFT', 'TSLA'). |

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

### Get stock statistics

Comprehensive statistics for a stock organized into categorized sections. Each section contains a text summary and a data array of key-value stat entries with id, title, value, and hover fields. Sections include valuation, ratios, shares, financialPosition, financialEfficiency, incomeStatement, balanceSheet, cashFlow, margins, dividends, analystForecasts, and more.

**Estimated cost:** Metered

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `symbol` | string | Yes | Stock ticker symbol (e.g. 'AAPL', 'NVDA', 'TSLA'). |

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

### Search stocks

Full-text search for stocks and ETFs by company name or ticker symbol. Returns matches across multiple global exchanges including US, international, and ETF listings. Results include basic price and market cap data.

**Estimated cost:** Metered

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `query` | string | Yes | Search keyword — a company name or ticker symbol (e.g. 'AAPL', 'Microsoft', 'Tesla'). |

```bash
curl -X POST https://api.paywithlocus.com/api/wrapped/credits/stockanalysis/search-stocks \
  -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.