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

# CurrencyScoop API reference

> API reference for CurrencyScoop: every `currencyscoop.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).

## Currencies

### list

`currencies.list`

List supported CurrencyBeacon currency codes.

**Risk:** `read`

```ts theme={null}
await corsair.currencyscoop.api.currencies.list({});
```

**Input:** *empty object*

GET /currencies. A row is stored when short\_code is present.

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `currencies` | `object[]` | Yes | — |

> [accordion] currencies full type
>
> ```ts theme={null}
> {
>   id: string,
>   name?: string,
>   symbol?: string
> }[]
> ```

***

## Quotes

### convert

`quotes.convert`

Convert an amount between two currencies.

**Risk:** `read`

```ts theme={null}
await corsair.currencyscoop.api.quotes.convert({ from: 'USD', to: 'EUR', amount: 1 });
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `from` | `string` | Yes | — |
| `to` | `string` | Yes | — |
| `amount` | `number` | Yes | — |
| `date` | `string` | No | — |

GET /convert. Returns from, to, amount, value, and date. Nothing is stored.

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `from` | `string` | Yes | — |
| `to` | `string` | Yes | — |
| `amount` | `number` | Yes | — |
| `value` | `number` | Yes | — |
| `date` | `string` | Yes | — |

***

### historical

`quotes.historical`

Read mid-market rates for one date.

**Risk:** `read`

```ts theme={null}
await corsair.currencyscoop.api.quotes.historical({ date: '2024-01-01', base: 'USD' });
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `base` | `string` | No | — |
| `symbols` | `string` | No | — |
| `date` | `string` | Yes | — |

GET /historical. date is required. The stored row matches latest.

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `quotes` | `object[]` | Yes | — |

> [accordion] quotes full type
>
> ```ts theme={null}
> {
>   id: string,
>   date: string,
>   base: string,
>   code: string,
>   rate: number
> }[]
> ```

***

### latest

`quotes.latest`

Read the latest mid-market rates.

**Risk:** `read`

```ts theme={null}
await corsair.currencyscoop.api.quotes.latest({ base: 'USD', symbols: 'EUR' });
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `base` | `string` | No | — |
| `symbols` | `string` | No | — |

GET /latest. Each rate is stored as date, base, code, and rate.

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `quotes` | `object[]` | Yes | — |

> [accordion] quotes full type
>
> ```ts theme={null}
> {
>   id: string,
>   date: string,
>   base: string,
>   code: string,
>   rate: number
> }[]
> ```

***

### timeseries

`quotes.timeseries`

Read daily rates between two dates.

**Risk:** `read`

```ts theme={null}
await corsair.currencyscoop.api.quotes.timeseries({ start_date: '2024-01-01', end_date: '2024-01-02', base: 'USD' });
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `base` | `string` | No | — |
| `symbols` | `string` | No | — |
| `start_date` | `string` | Yes | — |
| `end_date` | `string` | Yes | — |

GET /timeseries. The API lists rates by date under response with no base, so the stored base is the one you asked for (USD when omitted). Stores one quote per date and currency code.

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `quotes` | `object[]` | Yes | — |

> [accordion] quotes full type
>
> ```ts theme={null}
> {
>   id: string,
>   date: string,
>   base: string,
>   code: string,
>   rate: number
> }[]
> ```

***


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