> ## Documentation Index
> Fetch the complete documentation index at: https://docs.corsair.dev/llms.txt
> Use this file to discover all available pages before exploring further.

# Nasdaq Data Link API reference

> API reference for the Nasdaq Data Link plugin in Corsair: every `nasdaq.api.*` operation with its input and output types, taken from the plugin's Zod schemas.

> [!NOTE]
>
> **New to Corsair?** See [API access](https://docs.corsair.dev/concepts/api.md), [authentication](https://docs.corsair.dev/concepts/auth.md), and [error handling](https://docs.corsair.dev/concepts/error-handling).

## Tables

### export

`tables.export`

Queue a bulk export of a table and return the signed zip link, valid for 30 minutes; the first call usually reports the file as still being built

**Risk:** `read`

```ts theme={null}
await corsair.nasdaq.api.tables.export({ table: 'NDAQ/RTAT10', filters: { 'date.gte': '2024-01-01' } });
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `table` | `string` | Yes | The table code, e.g. NDAQ/RTAT10. |
| `filters` | `Record<string, string \| number \| boolean>` | No | Row filters as column name to value, e.g. \{ ticker: "AAPL" }. Operators append to the name: `date.gte`, `date.lte`, `ticker.in[]`. Only columns the table marks filterable are accepted. |
| `columns` | `string[]` | No | Only these columns in the export. |

The first call usually answers status creating with a null link; poll until fresh (lowercase, as sent). The link expires after 30 minutes.

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `file` | `object \| null` | No | — |
| `datatable` | `object \| null` | No | — |
| `status` | `string \| null` | No | fresh, creating or regenerating, lowercase as Nasdaq sends it (its docs capitalise them). Only fresh means the link is ready. |

> [accordion] file full type
>
> ```ts theme={null}
> {
>   link?: string | null,
>   status?: string | null,
>   data_snapshot_time?: string | null
> } | null
> ```

> [accordion] datatable full type
>
> ```ts theme={null}
> {
>   last_refreshed_time?: string | null
> } | null
> ```

***

### metadata

`tables.metadata`

Read a table definition: its columns and types, the columns that can filter a query, its primary key and when it last refreshed

**Risk:** `read`

```ts theme={null}
await corsair.nasdaq.api.tables.metadata({ table: 'NDAQ/RTAT10' });
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `table` | `string` | Yes | The table code, e.g. NDAQ/RTAT10. |

The filters array lists the only columns that can be used in a query filter.

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `vendor_code` | `string \| null` | No | — |
| `datatable_code` | `string \| null` | No | — |
| `name` | `string \| null` | No | — |
| `description` | `string \| null` | No | — |
| `columns` | `object[]` | Yes | — |
| `filters` | `string[] \| null` | No | — |
| `primary_key` | `string[] \| null` | No | — |
| `premium` | `boolean \| null` | No | — |
| `status` | `object \| null` | No | — |
| `data_version` | `object \| null` | No | — |

> [accordion] columns full type
>
> ```ts theme={null}
> {
>   name: string,
>   type?: string | null
> }[]
> ```

> [accordion] status full type
>
> ```ts theme={null}
> {
>   refreshed_at?: string | null,
>   status?: string | null,
>   expected_at?: string | null,
>   update_frequency?: string | null
> } | null
> ```

> [accordion] data\_version full type
>
> ```ts theme={null}
> {
>   code?: string | null,
>   default?: boolean | null,
>   description?: string | null
> } | null
> ```

***

### rows

`tables.rows`

Read one page of rows from a Nasdaq Data Link table, filtered by the columns that table marks filterable; page with the returned cursor

**Risk:** `read`

```ts theme={null}
await corsair.nasdaq.api.tables.rows({ table: 'NDAQ/RTAT10', per_page: 100, filters: { 'date.gte': '2024-01-01', ticker: 'AAPL,MSFT' } });
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `table` | `string` | Yes | The table code, e.g. NDAQ/RTAT10. |
| `filters` | `Record<string, string \| number \| boolean>` | No | Row filters as column name to value, e.g. \{ ticker: "AAPL" }. Operators append to the name: `date.gte`, `date.lte`, `ticker.in[]`. Only columns the table marks filterable are accepted. |
| `columns` | `string[]` | No | Only these columns, sent as qopts.columns. |
| `per_page` | `number` | No | Rows per page, up to 10000. Nasdaq returns at most 10000 rows per call whatever this says. |
| `cursor_id` | `string` | No | The `next_cursor_id` from the previous page. Nasdaq answers 400 QESx06 for an expired cursor. |

Rows are arrays aligned to columns, not objects. Pass next\_cursor\_id back as cursor\_id to reach the next page.

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `columns` | `object[]` | Yes | — |
| `rows` | `(string \| number \| boolean \| null)[][]` | Yes | — |
| `next_cursor_id` | `string \| null` | No | The cursor for the next page. Null or absent on the last page; check for either. Nasdaq sends no other paging state. |

> [accordion] columns full type
>
> ```ts theme={null}
> {
>   name: string,
>   type?: string | null
> }[]
> ```

***


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.