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

> Access data from nyse.com.

**Category:** Finance & Markets | **Website:** [nyse.com/](https://nyse.com/) | **Docs:** [parse.bot/marketplace/5a942a4a-02c5-4672-84a5-a20022912387/nyse-com-api](https://parse.bot/marketplace/5a942a4a-02c5-4672-84a5-a20022912387/nyse-com-api)

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

## Access

**Base URL:** `https://api.beta.paywithlocus.com/api/wrapped/credits/nyse/`
**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 data products catalog

Retrieve a catalog of NYSE market data products with descriptions, links, and category tags. Paginated by offset and max results.

**Estimated cost:** Metered

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `max` | integer | No | Maximum results to return |
| `offset` | integer | No | Results offset for pagination |

```bash
curl -X POST https://api.beta.paywithlocus.com/api/wrapped/credits/nyse/get-data-products-catalog \
  -H "Authorization: Bearer $LOCUS_CREDITS_SECRET_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{"max":"<integer>","offset":"<integer>"}'
```

### Get listings

Search for NYSE-listed tickers and instruments by name or symbol. Returns matching quotes from the NYSE quotes collection with relevance scores. Paginates with zero-indexed page numbers.

**Estimated cost:** Metered

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `page_number` | integer | No | Page number for results (0-indexed) |
| `query` | string | No | Search query for ticker symbol or company name |

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

### Get market holidays

Retrieve the official NYSE market holiday schedule parsed from the NYSE hours and calendars page. Returns holiday dates grouped by year columns.

**Estimated cost:** Metered

_No parameters required._

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

### Get market movers

Retrieve NYSE market movers — stocks sorted by highest trading volume for the current session. Returns name, symbol, volume, last price, change, and percentage change.

**Estimated cost:** Metered

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `category` | string | No | Market category |

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

### Get market status

Retrieve historical market status and system notifications including outages, technical issues, self-help declarations, and their resolutions. Results are sorted by published date descending.

**Estimated cost:** Metered

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `page_number` | integer | No | Page number (0-indexed) |
| `page_size` | integer | No | Number of notifications per page |

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

### Get quote details

Retrieve comprehensive real-time quote data for a specific ticker symbol. Includes current price, volume, high/low, dividend info, beta, EPS, board members, company profile, options chains, total returns over various periods, and historical price data.

**Estimated cost:** Metered

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `symbol` | string | Yes | Ticker symbol (e.g. IBM, AAPL, F) |

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

### Get trader updates

Retrieve trader update notices and regulatory announcements including new listings, bond additions/redemptions, options changes, and self-help declarations. Results are sorted by published date descending.

**Estimated cost:** Metered

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `page_number` | integer | No | Page number (0-indexed) |
| `page_size` | integer | No | Number of notices per page |

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

### Get trading halts current

Retrieve the current day's trading halts. Returns halts that have not yet resumed, including the symbol, issuer name, exchange, reason, and halt time.

**Estimated cost:** Metered

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `max_results` | integer | No | Maximum results per page |
| `page_number` | integer | No | Page number (1-indexed) |

```bash
curl -X POST https://api.beta.paywithlocus.com/api/wrapped/credits/nyse/get-trading-halts-current \
  -H "Authorization: Bearer $LOCUS_CREDITS_SECRET_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{"max_results":"<integer>","page_number":"<integer>"}'
```

### Get trading halts historical

Retrieve historical trading halt records with optional filtering by symbol and date range. Returns halt details including symbol, issuer, reason, source exchange, halt date/time, and resumption date/time.

**Estimated cost:** Metered

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `halt_date_from` | string | No | Start date for search in YYYY-MM-DD format |
| `halt_date_to` | string | No | End date for search in YYYY-MM-DD format |
| `max_results` | integer | No | Maximum results per page |
| `page_number` | integer | No | Page number (1-indexed) |
| `symbol` | string | No | Ticker symbol to filter by |

```bash
curl -X POST https://api.beta.paywithlocus.com/api/wrapped/credits/nyse/get-trading-halts-historical \
  -H "Authorization: Bearer $LOCUS_CREDITS_SECRET_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{"halt_date_from":"<string>","halt_date_to":"<string>","max_results":"<integer>","page_number":"<integer>","symbol":"<string>"}'
```

### Search site

Global search across NYSE website pages and CMS content. Returns matching pages with titles, descriptions, relevance scores, and content type aggregations.

**Estimated cost:** Metered

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `page_number` | integer | No | Page number (0-indexed) |
| `query` | string | Yes | Search keyword |

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

## Next steps

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