# Shanghai Stock Exchange — 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.

> Monitor Shanghai Stock Exchange market activity with real-time equity quotes, index performance data, and daily trading statistics. Search for specific securities and view comprehensive market overviews to track stock prices and exchange trends.

**Category:** Finance & Markets | **Website:** [sse.com.cn/](https://sse.com.cn/) | **Docs:** [parse.bot/marketplace/2f90e63e-2d07-4147-88e6-6daa0f1929c0/sse-com-cn-api](https://parse.bot/marketplace/2f90e63e-2d07-4147-88e6-6daa0f1929c0/sse-com-cn-api)

Pay-per-use API proxy. Each call is automatically billed to your wallet in USDC.

## Access

**Base URL:** `https://api.paywithlocus.com/api/wrapped/parse-sse-com-cn-api-2f90e63e/`
**Auth:** `Authorization: Bearer <LOCUS_API_KEY>`

## Endpoints

### get_market_overview

Get overall market statistics across stocks, bonds, and funds. Returns trading amounts, total/negotiable market values, and security counts for each product type on a given trading day. When no date is supplied the latest available trading day is used.

**Estimated cost:** Metered

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `date` | string | No | Snapshot date in YYYYMMDD format. Omitting returns the latest available trading day. |

```bash
curl -X POST https://api.paywithlocus.com/api/wrapped/parse-sse-com-cn-api-2f90e63e/get_market_overview \
  -H "Authorization: Bearer YOUR_LOCUS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"date":"<string>"}'
```

### get_realtime_equity_list

Get real-time market quotations for SSE-listed equities. Returns a paginated window of equity quotes with code, name, open, high, low, last price, previous close, change rate, volume, and amount. Use begin/end to page through the full list.

**Estimated cost:** Metered

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `begin` | integer | No | Pagination start index (0-based). |
| `end` | integer | No | Pagination end index (exclusive). |

```bash
curl -X POST https://api.paywithlocus.com/api/wrapped/parse-sse-com-cn-api-2f90e63e/get_realtime_equity_list \
  -H "Authorization: Bearer YOUR_LOCUS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"begin":"<integer>","end":"<integer>"}'
```

### get_security_snapshot

Get a real-time snapshot for a specific security code including current price, bid/ask depth, price limits, and trading status. The bid and ask arrays contain interleaved [price, volume] pairs for 5 levels of depth.

**Estimated cost:** Metered

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `code` | string | Yes | 6-digit SSE security code (e.g. 600000, 600036). |

```bash
curl -X POST https://api.paywithlocus.com/api/wrapped/parse-sse-com-cn-api-2f90e63e/get_security_snapshot \
  -H "Authorization: Bearer YOUR_LOCUS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"code":"<string>"}'
```

### get_sse_index_list

Get the full list of SSE indices with metadata including index code, full name, English name, base day, base point, number of constituent stocks, and methodology description. No parameters needed.

**Estimated cost:** Metered

_No parameters required._

```bash
curl -X POST https://api.paywithlocus.com/api/wrapped/parse-sse-com-cn-api-2f90e63e/get_sse_index_list \
  -H "Authorization: Bearer YOUR_LOCUS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'
```

### get_sse_index_overview

Get performance overview for key SSE indices including composite, STAR, and sector indices. Returns close points, PE ratios, trading amounts, and constituent counts. No parameters needed — always returns the latest trading day.

**Estimated cost:** Metered

_No parameters required._

```bash
curl -X POST https://api.paywithlocus.com/api/wrapped/parse-sse-com-cn-api-2f90e63e/get_sse_index_overview \
  -H "Authorization: Bearer YOUR_LOCUS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'
```

### get_stock_trading_overview

Get daily trading statistics for different stock boards (Main A, Main B, STAR, combined). Returns volume, turnover, PE ratio, and market values per board for a given trading day.

**Estimated cost:** Metered

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `date` | string | No | Search date in YYYYMMDD format. Omitting returns the latest available trading day. |

```bash
curl -X POST https://api.paywithlocus.com/api/wrapped/parse-sse-com-cn-api-2f90e63e/get_stock_trading_overview \
  -H "Authorization: Bearer YOUR_LOCUS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"date":"<string>"}'
```

### search_securities

Search for SSE-listed securities by code, Chinese name, or pinyin abbreviation. Returns up to 50 matching results. Matches against the full securities dictionary including stocks, bonds, and funds.

**Estimated cost:** Metered

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `query` | string | Yes | Search keyword — a security code (e.g. 600000), Chinese name, or pinyin abbreviation (e.g. pfyx). |

```bash
curl -X POST https://api.paywithlocus.com/api/wrapped/parse-sse-com-cn-api-2f90e63e/search_securities \
  -H "Authorization: Bearer YOUR_LOCUS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"query":"<string>"}'
```