# BSE India — Wrapped API

> **You are on:** `https://api.beta.paywithlocus.com/api` | [llms.txt](https://beta.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.

> Retrieve live BSE India market data including top gainers and losers, 52-week highs and lows, bulk deals, and block deals for the most recent trading day.

**Category:** Finance & Markets | **Website:** [www.bseindia.com/](https://www.bseindia.com/) | **Docs:** [parse.bot/marketplace/8f57e615-a9c6-4540-bb82-215f394d1ed1/bseindia-com-api](https://parse.bot/marketplace/8f57e615-a9c6-4540-bb82-215f394d1ed1/bseindia-com-api)

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

## Access

**Base URL:** `https://api.beta.paywithlocus.com/api/wrapped/parse-bseindia-com-api-8f57e615/`
**Auth:** `Authorization: Bearer <LOCUS_API_KEY>`

## Endpoints

### Get 52week high

Get stocks hitting 52-week highs on BSE India for the most recent trading day. Optionally filter by BSE group code, index code, or specific scrip code. Returns stock price history including all-time high/low data.

**Estimated cost:** Metered

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `group_code` | string | No | BSE group code filter. Accepted values include 'A', 'B', 'M', 'X'. Omit or pass empty string for all groups. |
| `index_code` | string | No | Index code filter. Omit or pass empty string for no index filter. |
| `scrip_code` | string | No | Specific scrip code to filter results to a single stock. Omit or pass empty string for all stocks. |

```bash
curl -X POST https://api.beta.paywithlocus.com/api/wrapped/parse-bseindia-com-api-8f57e615/get_52week_high \
  -H "Authorization: Bearer YOUR_LOCUS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"group_code":"<string>","index_code":"<string>","scrip_code":"<string>"}'
```

### Get 52week low

Get stocks hitting 52-week lows on BSE India for the most recent trading day. Optionally filter by BSE group code or index code. Returns stock price history including all-time high/low data.

**Estimated cost:** Metered

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `group_code` | string | No | BSE group code filter. Accepted values include 'A', 'B', 'M', 'X'. Omit or pass empty string for all groups. |
| `index_code` | string | No | Index code filter. Omit or pass empty string for no index filter. |

```bash
curl -X POST https://api.beta.paywithlocus.com/api/wrapped/parse-bseindia-com-api-8f57e615/get_52week_low \
  -H "Authorization: Bearer YOUR_LOCUS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"group_code":"<string>","index_code":"<string>"}'
```

### Get block deals

Get block deals reported on BSE India for the most recent trading day with available data. Block deals are large single trades executed through a separate trading window. Each deal includes the client name, transaction type, quantity, and price.

**Estimated cost:** Metered

_No parameters required._

```bash
curl -X POST https://api.beta.paywithlocus.com/api/wrapped/parse-bseindia-com-api-8f57e615/get_block_deals \
  -H "Authorization: Bearer YOUR_LOCUS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'
```

### Get bulk deals

Get bulk deals reported on BSE India for the most recent trading day. Bulk deals are large volume trades that exceed a threshold percentage of a company's equity. Each deal includes the client name, transaction type, quantity, and price.

**Estimated cost:** Metered

_No parameters required._

```bash
curl -X POST https://api.beta.paywithlocus.com/api/wrapped/parse-bseindia-com-api-8f57e615/get_bulk_deals \
  -H "Authorization: Bearer YOUR_LOCUS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'
```

### Get gainers

Get top gaining stocks from BSE India for the most recent trading day. Returns all market stocks sorted by change percentage descending. Supports sorting by value or volume traded.

**Estimated cost:** Metered

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `order_by` | string | No | Sort order for results. Accepted values: 'all', 'value', 'volume'. |

```bash
curl -X POST https://api.beta.paywithlocus.com/api/wrapped/parse-bseindia-com-api-8f57e615/get_gainers \
  -H "Authorization: Bearer YOUR_LOCUS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"order_by":"<string>"}'
```

### Get losers

Get top losing stocks from BSE India for the most recent trading day. Returns all market stocks sorted by change percentage ascending. Supports sorting by value or volume traded.

**Estimated cost:** Metered

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `order_by` | string | No | Sort order for results. Accepted values: 'all', 'value', 'volume'. |

```bash
curl -X POST https://api.beta.paywithlocus.com/api/wrapped/parse-bseindia-com-api-8f57e615/get_losers \
  -H "Authorization: Bearer YOUR_LOCUS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"order_by":"<string>"}'
```