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

# CoinMarketCal API reference

> API reference for CoinMarketCal: every `coinmarketcal.api.*` operation with input and output types.

> [!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).

## Categories

### list

`categories.list`

List event categories from CoinMarketCal

**Risk:** `read`

```ts theme={null}
await corsair.coinmarketcal.api.categories.list({});
```

**Input:** *empty object*

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `data` | `object[]` | No | — |

> [accordion] data full type
>
> ```ts theme={null}
> {
>   id: string | number,
>   name?: string,
>   slug?: string
> }[]
> ```

***

## Coins

### get

`coins.get`

Get a cryptocurrency by slug from CoinMarketCal

**Risk:** `read`

```ts theme={null}
await corsair.coinmarketcal.api.coins.get({ slug: 'bitcoin' });
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `slug` | `string` | Yes | — |

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `slug` | `string` | Yes | — |
| `symbol` | `string` | No | — |
| `name` | `string` | No | — |
| `rank` | `number \| null` | No | — |
| `tracked` | `boolean` | No | — |
| `iconUrl` | `string \| null` | No | — |
| `upcomingCount` | `number \| null` | No | — |
| `majorCount` | `number \| null` | No | — |
| `peakImpact` | `number \| null` | No | — |

***

### list

`coins.list`

List available cryptocurrencies from CoinMarketCal

**Risk:** `read`

```ts theme={null}
await corsair.coinmarketcal.api.coins.list({ q: 'bitcoin', tracked: true, limit: 50 });
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `q` | `string` | No | — |
| `tracked` | `boolean` | No | — |
| `limit` | `number` | No | — |
| `cursor` | `string` | No | — |

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `data` | `object[]` | No | — |
| `meta` | `object` | No | — |

> [accordion] data full type
>
> ```ts theme={null}
> {
>   slug: string,
>   symbol?: string,
>   name?: string,
>   rank?: number | null,
>   tracked?: boolean,
>   iconUrl?: string | null,
>   upcomingCount?: number | null,
>   majorCount?: number | null,
>   peakImpact?: number | null
> }[]
> ```

> [accordion] meta full type
>
> ```ts theme={null}
> {
>   total?: number,
>   limit?: number,
>   cursor?: string | null
> }
> ```

***

## Events

### get

`events.get`

Get a cryptocurrency event by id from CoinMarketCal

**Risk:** `read`

```ts theme={null}
await corsair.coinmarketcal.api.events.get({ id: '12345' });
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `id` | `string` | Yes | — |

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `id` | `string` | Yes | — |
| `slug` | `string` | No | — |
| `title` | `string` | No | — |
| `description` | `string \| null` | No | — |
| `date` | `string` | No | — |
| `dateEnd` | `string \| null` | No | — |
| `dateType` | `string` | No | — |
| `isEstimated` | `boolean` | No | — |
| `displayedDate` | `string` | No | — |
| `categories` | `string[]` | No | — |
| `coins` | `object[]` | No | — |
| `impact` | `number \| string \| null` | No | — |
| `impactSummary` | `string \| null` | No | — |
| `sourceUrl` | `string \| null` | No | — |
| `snapshotUrl` | `string \| null` | No | — |
| `lastVerifiedAt` | `string \| null` | No | — |
| `createdAt` | `string` | No | — |
| `updatedAt` | `string` | No | — |

> [accordion] coins full type
>
> ```ts theme={null}
> {
>   slug: string,
>   symbol: string,
>   name: string
> }[]
> ```

***

### list

`events.list`

List cryptocurrency events from CoinMarketCal

**Risk:** `read`

```ts theme={null}
await corsair.coinmarketcal.api.events.list({
	coins: 'bitcoin,ethereum',
	from: '2026-01-01',
	to: '2026-03-31',
	limit: 20,
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `coins` | `string` | No | — |
| `categories` | `string` | No | — |
| `from` | `string` | No | — |
| `to` | `string` | No | — |
| `keyword` | `string` | No | — |
| `impactMin` | `number` | No | — |
| `sortBy` | `date_asc \| date_desc \| created_desc \| created_desc_and_updated_desc \| impact_desc` | No | — |
| `limit` | `number` | No | — |
| `cursor` | `string` | No | — |

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `data` | `object[]` | No | — |
| `meta` | `object` | No | — |

> [accordion] data full type
>
> ```ts theme={null}
> {
>   id: string,
>   slug?: string,
>   title?: string,
>   description?: string | null,
>   date?: string,
>   dateEnd?: string | null,
>   dateType?: string,
>   isEstimated?: boolean,
>   displayedDate?: string,
>   categories?: string[],
>   coins?: {
>     slug: string,
>     symbol: string,
>     name: string
>   }[],
>   impact?: number | string | null,
>   impactSummary?: string | null,
>   sourceUrl?: string | null,
>   snapshotUrl?: string | null,
>   lastVerifiedAt?: string | null,
>   createdAt?: string,
>   updatedAt?: string
> }[]
> ```

> [accordion] meta full type
>
> ```ts theme={null}
> {
>   total?: number,
>   limit?: number,
>   cursor?: string | null
> }
> ```

***


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