---
canonical_url: "https://docs.composio.dev/toolkits/narwhal_api"
markdown_url: "https://docs.composio.dev/toolkits/narwhal_api.md"
product: "platform"
version: null
last_updated: null
---

# Narwhal API

Financial and economic data APIs for global and localized markets, including economics, equities, FX, commodities, crypto, calendars, filings, predictions, and webhooks.

- **Category:** analytics
- **Auth:** API_KEY
- **Composio-managed OAuth available?** N/A
- **Tools:** 143
- **Triggers:** 0
- **Slug:** `NARWHAL_API`
- **Version:** 00000000_00

## Tools

### Convert Gregorian Date

**Slug:** `NARWHAL_API_CONVERT_DATES`

Convert one Gregorian date into selected regional, lunisolar, Hijri, Persian, and Hindu calendars.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `tz` | string | No | IANA time zone used with coordinates. |
| `lat` | number | No | Latitude used only for Hindu conversion; send with lon and tz. |
| `lon` | number | No | Longitude used only for Hindu conversion; send with lat and tz. |
| `date` | string | Yes | Gregorian date to convert. |
| `scheme` | string ("amanta" | "purnimanta") | No | Hindu month scheme. |
| `country` | string | No | Country whose official Hijri date to add. |
| `ayanamsa` | string | No | Hindu ayanamsa; only lahiri is supported. |
| `calendars` | string | Yes | One to 13 unique comma-separated keys: chinese, vietnamese, korean, japanese, hijri, persian, hindu, tamil, malayalam, bengali, odia, nepali, or indian_national. |
| `adjustment` | integer | No | Day adjustment for calculated Hijri date. |
| `after_sunset` | boolean | No | For Hijri, return the evening's next day. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Convert FX Currency

**Slug:** `NARWHAL_API_CONVERT_FX_CURRENCY`

Convert a decimal amount between two currencies using the current Narwhal FX rate.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `amount` | string | Yes | Non-negative decimal amount to convert. |
| `to_currency` | string | Yes | Three-letter destination currency code. |
| `from_currency` | string | Yes | Three-letter source currency code. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Calendar Subscription

**Slug:** `NARWHAL_API_CREATE_CALENDAR_SUBSCRIPTION`

Create a revocable ICS calendar subscription for selected countries, dates, economic releases, and holidays. The response includes a secret feed URL that is returned only once.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `scope` | string | No | Optional holiday scope accepted by the subscription feed. |
| `end_date` | string | Yes | Subscription end date from 1900 through 2200 in YYYY-MM-DD format. |
| `families` | array | No | Economic release families to include, with at most five values. |
| `countries` | array | Yes | Uppercase three-letter country codes to include (1-50). |
| `start_date` | string | Yes | Subscription start date from 1900 through 2200 in YYYY-MM-DD format. |
| `include_holidays` | boolean | No | Whether to include published holidays. |
| `include_releases` | boolean | No | Whether to include economic release events. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Webhook Destination

**Slug:** `NARWHAL_API_CREATE_WEBHOOK_DESTINATION`

Create an HTTPS webhook destination with country, data-family, and optional company filters. The response contains a signing secret exactly once; store it securely and do not log, publish, or share it.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `url` | string | Yes | Public HTTPS callback URL that can receive Narwhal deliveries. |
| `enabled` | boolean | No | Whether webhook delivery starts enabled. |
| `families` | array | Yes | Event families to deliver (1-8). |
| `companies` | array | No | Company IDs to watch, such as usa:0000320193. Required when families contains filings and not accepted otherwise; at most 1,000. |
| `countries` | array | Yes | Uppercase three-letter country codes from the active profile's catalogue, or WLD for worldwide events (1-60). |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Webhook Destination

**Slug:** `NARWHAL_API_DELETE_WEBHOOK_DESTINATION`

Permanently delete a webhook destination and stop future deliveries to it. This destructive action cannot be undone; verify the destination ID and confirm that the destination should be removed.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `destination_id` | string | Yes | Webhook destination UUID to permanently delete. This cannot be undone; verify the destination ID before calling. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Find Gregorian Dates

**Slug:** `NARWHAL_API_FIND_CALENDAR_DATES`

Find Gregorian date or dates matching a date written in another calendar.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `tz` | string | No | IANA time zone used with coordinates. |
| `day` | integer | No | Native day; for Hindu, tithi 1-15. |
| `era` | string ("vikram" | "shaka") | No | Required Hindu era. |
| `lat` | number | No | Latitude for Hindu dates; send with lon and tz. |
| `lon` | number | No | Longitude for Hindu dates; send with lat and tz. |
| `year` | integer | No | Native calendar year. |
| `month` | integer | No | Native month, except for Hindu dates. |
| `adhika` | boolean | No | Whether the Hindu month is adhika. |
| `paksha` | string ("shukla" | "krishna") | No | Required Hindu lunar fortnight. |
| `scheme` | string ("amanta" | "purnimanta") | No | Hindu month scheme. |
| `country` | string | No | Country whose official Hijri dates to add. |
| `ayanamsa` | string | No | Hindu ayanamsa. |
| `calendar` | string ("chinese" | "vietnamese" | "korean" | "japanese" | "hijri" | "persian" | "hindu" | "tamil" | "malayalam" | "bengali" | "odia" | "nepali" | "indian_national") | Yes | Native calendar key. |
| `month_key` | string ("chaitra" | "vaishakha" | "jyeshtha" | "ashadha" | "shravana" | "bhadrapada" | "ashwina" | "kartika" | "margashirsha" | "pausha" | "magha" | "phalguna") | No | Hindu month key. |
| `adjustment` | integer | No | Hijri day adjustment. |
| `leap_month` | boolean | No | Whether the lunisolar month is a leap month. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get As Reported

**Slug:** `NARWHAL_API_GET_AS_REPORTED`

Get As Reported.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `filing_id` | string | Yes | Filing id. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Binary Prediction

**Slug:** `NARWHAL_API_GET_BINARY_PREDICTION`

Get the latest or historical binary probability for an event.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `at` | string | No | Historical snapshot time; omit for the latest snapshot. |
| `event_id` | string | Yes | Binary prediction event ID. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Binary Prediction History

**Slug:** `NARWHAL_API_GET_BINARY_PREDICTION_HISTORY`

Get one page of binary prediction probability bars for a time window.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `end` | string | Yes | Inclusive history end time. |
| `start` | string | Yes | Inclusive history start time. |
| `cursor` | string | No | Opaque next_cursor from the previous page; retain the same window and interval. |
| `event_id` | string | Yes | Binary prediction event ID. |
| `interval` | string | No | Probability bar interval, such as 1h. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Central Bank Balance Sheet

**Slug:** `NARWHAL_API_GET_CENTRAL_BANK_BALANCE_SHEET`

Get a central bank balance-sheet total for a country and month.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `period` | string | No | Monthly period; omit for latest. |
| `country` | string | Yes | Uppercase three-letter country code. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Central Bank Reserves

**Slug:** `NARWHAL_API_GET_CENTRAL_BANK_RESERVES`

Get central bank reserves for a country and month.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `period` | string | No | Monthly period; omit for latest. |
| `country` | string | Yes | Uppercase three-letter country code. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Commodity Price History

**Slug:** `NARWHAL_API_GET_COMMODITY_PRICE_HISTORY`

Get closed price bars for one commodity and quote currency from one minute to one day.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `end` | string | Yes | Exclusive history end timestamp. |
| `limit` | integer | No | Maximum bars on this page. |
| `start` | string | Yes | Inclusive history start timestamp. |
| `cursor` | string | No | Opaque next_cursor from the previous page. |
| `currency` | string | Yes | Uppercase quote currency. |
| `interval` | string ("1m" | "5m" | "15m" | "1h" | "4h" | "1d") | No | Closed-bar interval. |
| `commodity` | string | Yes | Uppercase commodity symbol. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Commodity Spot Price

**Slug:** `NARWHAL_API_GET_COMMODITY_SPOT_PRICE`

Get the current indicative spot price for a commodity symbol in a quote currency.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `currency` | string | Yes | Uppercase three-letter quote currency code, such as USD. |
| `commodity` | string | Yes | Uppercase commodity symbol such as XAU; use a symbol, not a name such as GOLD. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Company

**Slug:** `NARWHAL_API_GET_COMPANY`

Get one filing-registry company and its industry, historical names, securities, relationships, and current listing IDs by Narwhal company ID.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `as_of` | string | No | Historical as-of date in YYYY-MM-DD format. |
| `language` | string ("en" | "original") | No | Return English-normalized or original-language fields. |
| `company_id` | string | Yes | Narwhal registry-qualified company ID, such as usa:0000320193. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Company Financials

**Slug:** `NARWHAL_API_GET_COMPANY_FINANCIALS`

Get normalized financial statements for one company, with optional statement, period, year, basis, version, field, and segment filters.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `as_of` | string | No | Historical as-of date in YYYY-MM-DD format. |
| `basis` | string ("consolidated" | "standalone") | No | Consolidated or standalone reporting basis. |
| `fields` | string | No | Comma-separated normalized line-item fields to return; omit for the default set. |
| `period` | string ("annual" | "semiannual" | "quarterly") | No | Reporting period frequency. |
| `version` | string ("latest" | "first_reported") | No | Use latest restated values or values as first reported. |
| `statement` | string ("income" | "balance" | "cash_flow" | "per_share" | "shares" | "other") | No | Statement family to return. |
| `company_id` | string | Yes | Narwhal registry-qualified company ID, such as usa:0000320193. |
| `fiscal_year` | integer | No | Fiscal year to return (1800-9999). |
| `include_segments` | boolean | No | Include supported segment, product, and geography breakdowns. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Company Sections

**Slug:** `NARWHAL_API_GET_COMPANY_SECTIONS`

Get Company Sections.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `form` | string ("10-K" | "10-Q" | "20-F" | "8-K" | "YUHO" | "HANKI" | "SHIHANKI" | "RINJI" | "사업보고서" | "반기보고서" | "분기보고서") | Yes | `10-K`, `10-Q`, `20-F` or `8-K`; Japan's `YUHO`, `HANKI`, `SHIHANKI` or `RINJI`; Korea's `사업보고서`, `반기보고서` or `분기보고서`. |
| `item` | string | No | One item, for example `1A`. For an 8-K the answer is the newest of the company's last 10 8-Ks that has the item (an 8-K reports one event, so the newest one often lacks it); without `item` it is the newest 8-K. |
| `part` | string | No | Part. |
| `year` | integer | No | Fiscal year of a 10-K, 10-Q or 20-F; the year it was filed for an 8-K. Omit it for the newest filing. |
| `format` | string ("json" | "html") | No | Format. |
| `quarter` | integer | No | Fiscal quarter, of a quarterly report only (10-Q, `SHIHANKI`, `분기보고서`). |
| `company_id` | string | Yes | Company id. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get CPI

**Slug:** `NARWHAL_API_GET_CPI`

Get the latest headline consumer price index for a country, or the value for a specific monthly period or publication version.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `period` | string | No | Monthly period in YYYY-MM format; omit for the latest period. |
| `country` | string | Yes | Uppercase three-letter country code, such as USA. |
| `version_id` | string | No | Immutable publication version UUID; omit for the current version. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get CPI History

**Slug:** `NARWHAL_API_GET_CPI_HISTORY`

Get headline CPI observations by period, oldest first.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `end` | string | No | Last period to include. |
| `as_of` | string | No | Return the series as published by the end of this UTC day. |
| `limit` | integer | No | Maximum periods per page. |
| `start` | string | No | First period to include. |
| `cursor` | string | No | Next cursor from the previous page. |
| `country` | string | Yes | Uppercase three-letter country code. |
| `version` | string | No | Use first_reported to return the first stored value per period. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Crypto Bars

**Slug:** `NARWHAL_API_GET_CRYPTO_BARS`

Get daily or one-minute price bars for one cryptocurrency pair.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `end` | string | No | Last daily bar or exclusive one-minute end time. |
| `pair` | string | Yes | Pair such as BTC-USD or ETH-EUR; case-insensitive and slash is accepted. |
| `start` | string | No | Inclusive first bar date or UTC timestamp. |
| `cursor` | string | No | Previous next_cursor; keep all other parameters unchanged. |
| `interval` | string ("1d" | "1m") | No | Daily or one-minute bars. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Crypto Price

**Slug:** `NARWHAL_API_GET_CRYPTO_PRICE`

Get the latest price, 24-hour change, and freshness for one cryptocurrency pair.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `pair` | string | Yes | Pair such as BTC-USD or ETH-EUR; case-insensitive and slash is accepted. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Crypto Prices

**Slug:** `NARWHAL_API_GET_CRYPTO_PRICES`

Get latest prices for up to 50 cryptocurrency pairs, including 24-hour changes and freshness data, with per-pair errors for unavailable prices.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `pairs` | string | Yes | Comma-separated cryptocurrency trading pairs such as BTC-USD,ETH-USD, with at most 50 pairs after duplicates are removed. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Delivery Event

**Slug:** `NARWHAL_API_GET_DELIVERY_EVENT`

Get one Narwhal dataset or release delivery event by UUID.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `event_id` | string | Yes | Delivery event UUID. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Dividends Calendar

**Slug:** `NARWHAL_API_GET_DIVIDENDS_CALENDAR`

Get company dividends going ex in an inclusive date window of up to seven days.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `end` | string | No | Last ex-date, inclusive; defaults to start and may be at most seven days later. |
| `start` | string | No | First ex-date, inclusive; defaults to today UTC. |
| `country` | string | No | Three-letter listing country; defaults to USA, currently the only covered country. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Economic Release

**Slug:** `NARWHAL_API_GET_ECONOMIC_RELEASE`

Get one economic release calendar entry by release ID.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `release_id` | string | Yes | Economic release UUID. |
| `version_id` | string | No | Immutable release version; omit for current. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Equity Bars

**Slug:** `NARWHAL_API_GET_EQUITY_BARS`

Get adjusted daily or one-minute price bars for one stock.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Listing ID such as XNAS:MSFT, or an unambiguous US ticker. |
| `end` | string | No | Last daily bar or exclusive one-minute end time. |
| `start` | string | No | Inclusive first bar date or UTC timestamp. |
| `cursor` | string | No | Previous next_cursor; keep all other parameters unchanged. |
| `interval` | string ("1d" | "1m") | No | Daily or one-minute bars. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Equity Cost of Capital

**Slug:** `NARWHAL_API_GET_EQUITY_COST_OF_CAPITAL`

Get beta, cost of equity, cost of debt, capital weights, and WACC for one stock.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Listing ID such as XNAS:MSFT, or an unambiguous US ticker. |
| `erp` | string | No | Caller-supplied equity risk premium in percent. |
| `beta` | string ("raw" | "adjusted") | No | Beta used in cost of equity. |
| `period` | string ("ttm" | "annual") | No | Interest-expense period. |
| `window` | string ("2y" | "5y") | No | Return lookback window. |
| `tax_rate` | string | No | Caller-supplied tax rate in percent. |
| `benchmark` | string | No | Listing ID of the market proxy used for beta. |
| `frequency` | string ("weekly" | "monthly") | No | Return interval. |
| `risk_free` | string | No | Caller-supplied risk-free rate in percent. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Equity Dividends

**Slug:** `NARWHAL_API_GET_EQUITY_DIVIDENDS`

Get dividend history for one stock, newest ex-date first.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Listing ID such as XNAS:MSFT, or an unambiguous US ticker. |
| `cursor` | string | No | Previous next_cursor. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Equity Earnings

**Slug:** `NARWHAL_API_GET_EQUITY_EARNINGS`

Get past earnings reports and EPS surprises for one stock.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Listing ID such as XNAS:MSFT, or an unambiguous US ticker. |
| `cursor` | string | No | Previous next_cursor. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Equity Movers

**Slug:** `NARWHAL_API_GET_EQUITY_MOVERS`

Get the top US equity gainers, losers, or most active names.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `market` | string | No | Market to rank; currently only us. |
| `direction` | string ("gainers" | "losers" | "active") | No | Mover ranking to return. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Equity Price

**Slug:** `NARWHAL_API_GET_EQUITY_PRICE`

Get the latest price, change, session, and freshness for one stock.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Listing ID such as XNAS:MSFT, or an unambiguous US ticker. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Equity Prices

**Slug:** `NARWHAL_API_GET_EQUITY_PRICES`

Get latest prices for up to 50 equity listing IDs, including change and freshness data, with per-ID errors for listings that have no price.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `ids` | string | Yes | Comma-separated equity listing IDs from Search Equities, with at most 50 IDs after duplicates are removed. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Equity Profile

**Slug:** `NARWHAL_API_GET_EQUITY_PROFILE`

Get the listing and company profile for one stock.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Listing ID such as XNAS:MSFT, or an unambiguous US ticker. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Equity Risk Premium

**Slug:** `NARWHAL_API_GET_EQUITY_RISK_PREMIUM`

Get an equity risk premium for a country and source date.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `date` | string | No | Source date; omit for latest. |
| `country` | string | Yes | Uppercase three-letter country code. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Equity Risk Premium History

**Slug:** `NARWHAL_API_GET_EQUITY_RISK_PREMIUM_HISTORY`

Get equity risk premiums by source date for a country.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `end` | string | No | Last source date to include. |
| `limit` | integer | No | Maximum observations per page. |
| `start` | string | No | First source date to include. |
| `cursor` | string | No | Next cursor from the previous page. |
| `country` | string | Yes | Uppercase three-letter country code. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Equity Splits

**Slug:** `NARWHAL_API_GET_EQUITY_SPLITS`

Get stock split history for one listing, newest first.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Listing ID such as XNAS:MSFT, or an unambiguous US ticker. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Equity Valuation

**Slug:** `NARWHAL_API_GET_EQUITY_VALUATION`

Get market cap, valuation ratios, dividend yield, and their filing inputs for one stock.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Listing ID such as XNAS:MSFT, or an unambiguous US ticker. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Equity Valuation History

**Slug:** `NARWHAL_API_GET_EQUITY_VALUATION_HISTORY`

Get fiscal-period valuation history for one stock, oldest first.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Listing ID such as XNAS:MSFT, or an unambiguous US ticker. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Exchange Closures

**Slug:** `NARWHAL_API_GET_EXCHANGE_CLOSURES`

Get exchange closure, early-close, and late-open days with normal sessions.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `mic` | string | Yes | Market Identifier Code, such as XNYS. |
| `year` | integer | No | Calendar year; omit for all available days. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Extreme Prediction

**Slug:** `NARWHAL_API_GET_EXTREME_PREDICTION`

Get the latest or historical threshold probabilities for an extreme event.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `at` | string | No | Historical snapshot time; omit for the latest snapshot. |
| `event_id` | string | Yes | Extreme prediction event ID. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Extreme Prediction History

**Slug:** `NARWHAL_API_GET_EXTREME_PREDICTION_HISTORY`

Get one page of extreme prediction probability bars for a time window.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `end` | string | Yes | Inclusive history end time. |
| `start` | string | Yes | Inclusive history start time. |
| `cursor` | string | No | Opaque next_cursor from the previous page; retain the same window and interval. |
| `event_id` | string | Yes | Extreme prediction event ID. |
| `interval` | string | No | Probability bar interval, such as 1h. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Filing

**Slug:** `NARWHAL_API_GET_FILING`

Get Filing.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `lang` | string ("en" | "original") | No | Lang. |
| `filing_id` | string | Yes | Filing id. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Fund Bars

**Slug:** `NARWHAL_API_GET_FUND_BARS`

Get adjusted daily price or NAV bars for a fund, or one-minute bars for an ETF.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Fund ID such as ARCX:SPY or FUND:VFIAX, or an unambiguous US ticker. |
| `end` | string | No | Last daily bar or exclusive one-minute end time. |
| `start` | string | No | Inclusive first bar date or UTC timestamp. |
| `cursor` | string | No | Previous next_cursor; keep all other parameters unchanged. |
| `interval` | string ("1d" | "1m") | No | Daily bars for any fund, or one-minute bars for ETFs. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Fund Distributions

**Slug:** `NARWHAL_API_GET_FUND_DISTRIBUTIONS`

Get income and capital-gain distributions for one fund, newest ex-date first.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Fund ID such as ARCX:SPY or FUND:VFIAX, or an unambiguous US ticker. |
| `cursor` | string | No | Previous next_cursor. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Fund Price

**Slug:** `NARWHAL_API_GET_FUND_PRICE`

Get the latest exchange price for an ETF or daily NAV for a mutual fund.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Fund ID such as ARCX:SPY or FUND:VFIAX, or an unambiguous US ticker. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Fund Prices

**Slug:** `NARWHAL_API_GET_FUND_PRICES`

Get latest prices or NAVs for up to 50 ETFs and mutual funds, with per-ID errors.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `ids` | string | Yes | Comma-separated fund IDs, with at most 50 after deduplication. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Fund Profile

**Slug:** `NARWHAL_API_GET_FUND_PROFILE`

Get the profile of one ETF or mutual fund.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Fund ID such as ARCX:SPY or FUND:VFIAX, or an unambiguous US ticker. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get FX Rate Bars

**Slug:** `NARWHAL_API_GET_FX_RATE_BARS`

Get closed OHLC bars for one foreign-exchange pair and time range.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `end` | string | Yes | Exclusive UTC end timestamp. |
| `base` | string | Yes | Three-letter base currency code. |
| `limit` | integer | No | Maximum bars on this page. |
| `start` | string | Yes | Inclusive UTC start timestamp. |
| `cursor` | string | No | Previous next_cursor; keep all other parameters unchanged. |
| `currency` | string | Yes | Three-letter quote currency code. |
| `interval` | string ("1m" | "5m" | "15m" | "1h" | "4h" | "1d") | No | Bar interval. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get FX Rate History

**Slug:** `NARWHAL_API_GET_FX_RATE_HISTORY`

Get daily historical rates from one base currency to selected quote currencies.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `base` | string | Yes | Three-letter base currency code. |
| `limit` | integer | No | Maximum daily observations on this page. |
| `cursor` | string | No | Previous next_cursor; keep all other parameters unchanged. |
| `end_date` | string | Yes | Inclusive last date. |
| `currencies` | string | Yes | Comma-separated quote currency codes. |
| `start_date` | string | Yes | Inclusive first date. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get FX Rates

**Slug:** `NARWHAL_API_GET_FX_RATES`

Get current foreign-exchange rates from one base currency, optionally limited to selected quote currencies.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `base` | string | Yes | Uppercase three-letter base currency code. |
| `currencies` | string | No | Comma-separated uppercase quote currency codes, such as EUR,GBP; omit for every available rate. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get GDP

**Slug:** `NARWHAL_API_GET_GDP`

Get latest GDP at current prices or one quarterly period for a country.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `period` | string | No | Quarterly period; omit for latest. |
| `country` | string | Yes | Uppercase three-letter country code. |
| `version_id` | string | No | Immutable publication version; omit for the current version. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get GDP Growth

**Slug:** `NARWHAL_API_GET_GDP_GROWTH`

Get latest real GDP growth or one quarterly period for a country.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `period` | string | No | Quarterly period; omit for latest. |
| `country` | string | Yes | Uppercase three-letter country code. |
| `version_id` | string | No | Immutable publication version; omit for the current version. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get GDP Growth History

**Slug:** `NARWHAL_API_GET_GDP_GROWTH_HISTORY`

Get real GDP-growth observations by period, oldest first.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `end` | string | No | Last period to include. |
| `as_of` | string | No | Return the series as published by the end of this UTC day. |
| `limit` | integer | No | Maximum periods per page. |
| `start` | string | No | First period to include. |
| `cursor` | string | No | Next cursor from the previous page. |
| `country` | string | Yes | Uppercase three-letter country code. |
| `version` | string | No | Use first_reported to return the first stored value per period. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get GDP History

**Slug:** `NARWHAL_API_GET_GDP_HISTORY`

Get GDP-at-current-prices observations by period, oldest first.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `end` | string | No | Last period to include. |
| `as_of` | string | No | Return the series as published by the end of this UTC day. |
| `limit` | integer | No | Maximum periods per page. |
| `start` | string | No | First period to include. |
| `cursor` | string | No | Next cursor from the previous page. |
| `country` | string | Yes | Uppercase three-letter country code. |
| `version` | string | No | Use first_reported to return the first stored value per period. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Official Hijri Year

**Slug:** `NARWHAL_API_GET_HIJRI_YEAR`

Get calculated and official starts for all twelve Hijri months in a country and AH year.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `year` | integer | Yes | Hijri year. |
| `country` | string | Yes | Country with an official Hijri authority. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Holidays On Date

**Slug:** `NARWHAL_API_GET_HOLIDAYS_ON_DATE`

Get published public holidays on one date for a country.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `date` | string | Yes | Date to inspect. |
| `scope` | string ("national_public" | "regional_public" | "bank" | "federal_government" | "central_government" | "collective_leave" | "public_sector" | "private_sector") | No | Holiday scope to include. |
| `country` | string | Yes | Uppercase three-letter country code. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get HS Code

**Slug:** `NARWHAL_API_GET_HS_CODE`

Get one Harmonized System code and its immediate children.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `code` | string | Yes | HS code with 2, 4, or 6 digits. |
| `edition` | string | No | HS edition to use. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Inflation

**Slug:** `NARWHAL_API_GET_INFLATION`

Get latest headline inflation or one monthly period for a country.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `period` | string | No | Monthly period; omit for latest. |
| `country` | string | Yes | Uppercase three-letter country code. |
| `version_id` | string | No | Immutable publication version; omit for the current version. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Inflation History

**Slug:** `NARWHAL_API_GET_INFLATION_HISTORY`

Get headline inflation observations by period, oldest first.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `end` | string | No | Last period to include. |
| `as_of` | string | No | Return the series as published by the end of this UTC day. |
| `limit` | integer | No | Maximum periods per page. |
| `start` | string | No | First period to include. |
| `cursor` | string | No | Next cursor from the previous page. |
| `country` | string | Yes | Uppercase three-letter country code. |
| `version` | string | No | Use first_reported to return the first stored value per period. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Insider Activity

**Slug:** `NARWHAL_API_GET_INSIDER_ACTIVITY`

Get Insider Activity.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `sort` | string ("transaction_date.desc" | "transaction_date.asc") | No | Sort. |
| `limit` | integer | No | Limit. |
| `cursor` | string | No | Cursor. |
| `country` | string | No | Three-letter country code of the registry. Left out means USA. A country the route does not cover is 404 not_covered. |
| `filed_to` | string | No | Filed to. |
| `company_id` | string | No | Company id. |
| `filed_from` | string | No | Filed from. |
| `transaction_date` | string | No | Transaction date. |
| `transaction_date_gt` | string | No | Transaction date gt. |
| `transaction_date_lt` | string | No | Transaction date lt. |
| `transaction_date_gte` | string | No | Transaction date gte. |
| `transaction_date_lte` | string | No | Transaction date lte. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Labour Force Participation

**Slug:** `NARWHAL_API_GET_LABOUR_FORCE_PARTICIPATION`

Get the latest labour-force participation rate or one period for a country.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `period` | string | No | Annual, monthly, or quarterly period; omit for latest. |
| `country` | string | Yes | Uppercase three-letter country code. |
| `version_id` | string | No | Immutable publication version; omit for the current version. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Labour Force Participation History

**Slug:** `NARWHAL_API_GET_LABOUR_FORCE_PARTICIPATION_HISTORY`

Get labour-force participation observations by period, oldest first.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `end` | string | No | Last period to include. |
| `as_of` | string | No | Return the series as published by the end of this UTC day. |
| `limit` | integer | No | Maximum periods per page. |
| `start` | string | No | First period to include. |
| `cursor` | string | No | Next cursor from the previous page. |
| `country` | string | Yes | Uppercase three-letter country code. |
| `version` | string | No | Use first_reported to return the first stored value per period. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Next Holiday

**Slug:** `NARWHAL_API_GET_NEXT_HOLIDAY`

Get the next published public holiday on or after a date.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `scope` | string ("national_public" | "regional_public" | "bank" | "federal_government" | "central_government" | "collective_leave" | "public_sector" | "private_sector") | No | Holiday scope to include. |
| `country` | string | Yes | Uppercase three-letter country code. |
| `from_date` | string | Yes | Date from which to search, inclusive. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Palm Oil Physical Observations

**Slug:** `NARWHAL_API_GET_PALMOIL_PHYSICAL_OBSERVATIONS`

Get native-period scalar or age-schedule observations for one palm-oil series.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `end` | string | No | First date to exclude; supply with start. |
| `limit` | integer | No | Maximum observations on this page. |
| `start` | string | No | First date to include; supply with end. |
| `cursor` | string | No | Opaque next_cursor from the previous page. |
| `series_id` | string | Yes | Palm-oil series ID. |
| `price_month` | string | No | MPOB CPO month in YYYY-MM format. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Palm Oil Physical Price

**Slug:** `NARWHAL_API_GET_PALMOIL_PHYSICAL_PRICE`

Get the latest approved scalar or age-schedule price for one palm-oil series.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `series_id` | string | Yes | Palm-oil series ID. |
| `price_month` | string | No | MPOB CPO month in YYYY-MM format. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Latest Physical Commodity Price

**Slug:** `NARWHAL_API_GET_PHYSICAL_LATEST`

Get the latest published price and revision for one physical commodity series.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `series_id` | string | Yes | Physical price series ID; latest is not an ID. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Physical Commodity Observations

**Slug:** `NARWHAL_API_GET_PHYSICAL_OBSERVATIONS`

Get published observations for one physical commodity series in an optional half-open date range.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `end` | string | No | First day to exclude; supply with start. |
| `limit` | integer | No | Maximum observations on this page. |
| `start` | string | No | First day to include; supply with end. |
| `cursor` | string | No | Opaque next_cursor from the previous page. |
| `series_id` | string | Yes | Physical price series ID; latest is not an ID. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Physical Commodity Series

**Slug:** `NARWHAL_API_GET_PHYSICAL_SERIES`

Get the complete definition, units, attribution, and coverage of one physical price series.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `series_id` | string | Yes | Physical price series ID; latest is not an ID. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Policy Path

**Slug:** `NARWHAL_API_GET_POLICY_PATH`

Get current cut, hold, and hike odds across an authority's meetings.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `authority` | string ("federal-reserve" | "european-central-bank" | "bank-of-england" | "bank-of-japan" | "bank-of-canada" | "reserve-bank-of-australia" | "bank-indonesia") | Yes | Central-bank authority key. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Policy Path History

**Slug:** `NARWHAL_API_GET_POLICY_PATH_HISTORY`

Get daily historical policy-path odds for an authority and time window.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `end` | string | Yes | Inclusive history end time. |
| `start` | string | Yes | Inclusive history start time. |
| `authority` | string ("federal-reserve" | "european-central-bank" | "bank-of-england" | "bank-of-japan" | "bank-of-canada" | "reserve-bank-of-australia" | "bank-indonesia") | Yes | Central-bank authority key. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Policy Rate

**Slug:** `NARWHAL_API_GET_POLICY_RATE`

Get a central bank policy rate for a country.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `date` | string | No | Effective date; omit for the latest rate. |
| `country` | string | Yes | Uppercase three-letter country code. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Policy Rate History

**Slug:** `NARWHAL_API_GET_POLICY_RATE_HISTORY`

Get central bank policy rates by effective date.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `end` | string | No | Last effective date to include. |
| `limit` | integer | No | Maximum rates per page. |
| `start` | string | No | First effective date to include. |
| `cursor` | string | No | Next cursor from the previous page. |
| `country` | string | Yes | Uppercase three-letter country code. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Population History

**Slug:** `NARWHAL_API_GET_POPULATION_HISTORY`

Get annual mid-year population observations, oldest first.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `end` | string | No | Last period to include. |
| `as_of` | string | No | Return the series as published by the end of this UTC day. |
| `limit` | integer | No | Maximum periods per page. |
| `start` | string | No | First period to include. |
| `cursor` | string | No | Next cursor from the previous page. |
| `country` | string | Yes | Uppercase three-letter country code. |
| `version` | string | No | Use first_reported to return the first stored value per period. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Prediction Topic

**Slug:** `NARWHAL_API_GET_PREDICTION_TOPIC`

Get one prediction topic with its open events and five most recent closed, settled, or void events.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `topic_id` | string | Yes | Prediction topic slug. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Rate Decisions

**Slug:** `NARWHAL_API_GET_RATE_DECISIONS`

Get central bank rate decisions, newest first, including holds.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `end` | string | No | Last decision date to include. |
| `limit` | integer | No | Maximum decisions to return. |
| `start` | string | No | First decision date to include. |
| `country` | string | Yes | Country or monetary-union code. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Regional CPI

**Slug:** `NARWHAL_API_GET_REGIONAL_CPI`

Get the latest headline CPI for a supported region.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `period` | string | No | Monthly period; omit for latest. |
| `region` | string | Yes | ISO 3166-2 region code. |
| `country` | string | Yes | Country code; MYS is currently supported. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Regional GDP

**Slug:** `NARWHAL_API_GET_REGIONAL_GDP`

Get the latest GDP for a supported Malaysian or US region.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `period` | string | No | Annual Malaysian or quarterly US period; omit for latest. |
| `region` | string | Yes | ISO 3166-2 region code. |
| `country` | string | Yes | Country code: MYS or USA. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Scalar Prediction

**Slug:** `NARWHAL_API_GET_SCALAR_PREDICTION`

Get the latest or historical scalar probability distribution for an event.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `at` | string | No | Historical snapshot time; omit for the latest snapshot. |
| `event_id` | string | Yes | Scalar prediction event ID. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Scalar Prediction History

**Slug:** `NARWHAL_API_GET_SCALAR_PREDICTION_HISTORY`

Get one page of scalar prediction probability bars for a time window.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `end` | string | Yes | Inclusive history end time. |
| `start` | string | Yes | Inclusive history start time. |
| `cursor` | string | No | Opaque next_cursor from the previous page; retain the same window and interval. |
| `event_id` | string | Yes | Scalar prediction event ID. |
| `interval` | string | No | Probability bar interval, such as 1h. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Screen Filters

**Slug:** `NARWHAL_API_GET_SCREEN_FILTERS`

Get Screen Filters.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Sections

**Slug:** `NARWHAL_API_GET_SECTIONS`

Get Sections.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `item` | string | No | One item by its number, for example `1A` or `7`; a Japanese filing's heading id (`BusinessRisksTextBlock`); a Korean filing's part number (`II.1`; the number is the report's own, so an older report numbers some parts differently: `title` says what the item is, and a part the report splits further, such as `III.3`, returns its pieces). Omit it for every item. |
| `part` | string | No | The part (`I` to `IV`). A 10-Q has an Item 1 in Part I and another in Part II; without `part`, `item` returns both. |
| `format` | string ("json" | "html") | No | `html` returns the sections (and an 8-K's exhibits) as one HTML page. |
| `filing_id` | string | Yes | Filing id. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Splits Calendar

**Slug:** `NARWHAL_API_GET_SPLITS_CALENDAR`

Get company stock splits taking effect in an inclusive date window of up to seven days.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `end` | string | No | Last effective date, inclusive; defaults to start and may be at most seven days later. |
| `start` | string | No | First effective date, inclusive; defaults to today UTC. |
| `country` | string | No | Three-letter listing country; defaults to USA, currently the only covered country. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Timing Prediction

**Slug:** `NARWHAL_API_GET_TIMING_PREDICTION`

Get the latest or historical cumulative timing probabilities for an event.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `at` | string | No | Historical snapshot time; omit for the latest snapshot. |
| `event_id` | string | Yes | Timing prediction event ID. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Timing Prediction History

**Slug:** `NARWHAL_API_GET_TIMING_PREDICTION_HISTORY`

Get one page of timing prediction probability bars for a time window.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `end` | string | Yes | Inclusive history end time. |
| `start` | string | Yes | Inclusive history start time. |
| `cursor` | string | No | Opaque next_cursor from the previous page; retain the same window and interval. |
| `event_id` | string | Yes | Timing prediction event ID. |
| `interval` | string | No | Probability bar interval, such as 1h. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Trade

**Slug:** `NARWHAL_API_GET_TRADE`

Get latest merchandise trade or one period for a country.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `period` | string | No | Annual or monthly period; omit for latest. |
| `country` | string | Yes | Uppercase three-letter country code. |
| `version_id` | string | No | Immutable publication version; omit for the current version. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Trade Coverage

**Slug:** `NARWHAL_API_GET_TRADE_COVERAGE`

List the trade-data tiers and periods available for each country.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `country` | string | No | ISO 3166-1 alpha-3 country code to inspect. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Trade Flows

**Slug:** `NARWHAL_API_GET_TRADE_FLOWS`

Query exports and imports across reporters, partners, HS chapters, and available source tiers.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `hs` | string | No | Comma-separated HS chapter codes, up to 10. |
| `end` | string | No | Last month, YYYY-MM. |
| `flow` | string | No | Export or import flow. |
| `as_of` | string | No | Historical data snapshot selector. |
| `basis` | string | No | Source tier to require. |
| `limit` | integer | No | Maximum rows on this page. |
| `start` | string | No | First month, YYYY-MM. |
| `cursor` | string | No | next_cursor from the previous page. |
| `partner` | string | No | Comma-separated partner ISO3 codes, up to 10. |
| `version` | string | No | Data version selector. |
| `currency` | string | No | Output currency, including USD conversion when requested. |
| `reporter` | string | No | Comma-separated reporter ISO3 codes, up to 10. |
| `include_groups` | boolean | No | Include publisher-defined partner groups. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Trade History

**Slug:** `NARWHAL_API_GET_TRADE_HISTORY`

Get merchandise-trade observations by period, oldest first.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `end` | string | No | Last period to include. |
| `as_of` | string | No | Return the series as published by the end of this UTC day. |
| `limit` | integer | No | Maximum periods per page. |
| `start` | string | No | First period to include. |
| `cursor` | string | No | Next cursor from the previous page. |
| `country` | string | Yes | Uppercase three-letter country code. |
| `version` | string | No | Use first_reported to return the first stored value per period. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Trade Partners

**Slug:** `NARWHAL_API_GET_TRADE_PARTNERS`

Get a country's goods exports and imports by trading partner.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `hs` | string | No | HS code with 2, 4, or 6 digits. |
| `end` | string | No | Last month, YYYY-MM. |
| `top` | integer | No | Return the largest N rows. |
| `ytd` | boolean | No | Include year-to-date rows. |
| `flow` | string | No | Export or import flow. |
| `as_of` | string | No | Historical snapshot selector. |
| `basis` | string | No | Source tier to require. |
| `limit` | integer | No | Maximum rows on this page. |
| `share` | boolean | No | Calculate each row's share. |
| `start` | string | No | First month, YYYY-MM. |
| `change` | boolean | No | Calculate year-over-year changes. |
| `cursor` | string | No | next_cursor from the previous page. |
| `country` | string | Yes | Reporting country ISO3 code. |
| `partner` | string | No | Partner ISO3 code. |
| `version` | string | No | Data version selector. |
| `currency` | string | No | Output currency. |
| `include_groups` | boolean | No | Include publisher-defined partner groups. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Trade Product Partners

**Slug:** `NARWHAL_API_GET_TRADE_PRODUCT`

Get one HS product's trade for a country, broken down by partner.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `hs` | string | Yes | HS code with 2, 4, or 6 digits. |
| `end` | string | No | Last month, YYYY-MM. |
| `top` | integer | No | Return the largest N rows. |
| `ytd` | boolean | No | Include year-to-date rows. |
| `flow` | string | No | Export or import flow. |
| `as_of` | string | No | Historical snapshot selector. |
| `basis` | string | No | Source tier to require. |
| `limit` | integer | No | Maximum rows on this page. |
| `share` | boolean | No | Calculate each row's share. |
| `start` | string | No | First month, YYYY-MM. |
| `change` | boolean | No | Calculate year-over-year changes. |
| `cursor` | string | No | next_cursor from the previous page. |
| `country` | string | Yes | Reporting country ISO3 code. |
| `partner` | string | No | Partner ISO3 code. |
| `version` | string | No | Data version selector. |
| `currency` | string | No | Output currency. |
| `include_groups` | boolean | No | Include publisher-defined partner groups. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Trade Products

**Slug:** `NARWHAL_API_GET_TRADE_PRODUCTS`

Get a country's goods exports and imports by HS product.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `hs` | string | No | HS code prefix. |
| `end` | string | No | Last month, YYYY-MM. |
| `top` | integer | No | Return the largest N rows. |
| `ytd` | boolean | No | Include year-to-date rows. |
| `flow` | string | No | Export or import flow. |
| `as_of` | string | No | Historical snapshot selector. |
| `basis` | string | No | Source tier to require. |
| `level` | integer | No | HS level: 2, 4, or 6 digits. |
| `limit` | integer | No | Maximum rows on this page. |
| `share` | boolean | No | Calculate each row's share. |
| `start` | string | No | First month, YYYY-MM. |
| `change` | boolean | No | Calculate year-over-year changes. |
| `cursor` | string | No | next_cursor from the previous page. |
| `country` | string | Yes | Reporting country ISO3 code. |
| `partner` | string | No | Partner ISO3 code. |
| `version` | string | No | Data version selector. |
| `currency` | string | No | Output currency. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Unemployment

**Slug:** `NARWHAL_API_GET_UNEMPLOYMENT`

Get the latest unemployment rate or one period for a country.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `period` | string | No | Annual, monthly, or quarterly period; omit for latest. |
| `country` | string | Yes | Uppercase three-letter country code. |
| `version_id` | string | No | Immutable publication version; omit for the current version. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Unemployment History

**Slug:** `NARWHAL_API_GET_UNEMPLOYMENT_HISTORY`

Get unemployment-rate observations by period, oldest first.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `end` | string | No | Last period to include. |
| `as_of` | string | No | Return the series as published by the end of this UTC day. |
| `limit` | integer | No | Maximum periods per page. |
| `start` | string | No | First period to include. |
| `cursor` | string | No | Next cursor from the previous page. |
| `country` | string | Yes | Uppercase three-letter country code. |
| `version` | string | No | Use first_reported to return the first stored value per period. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Webhook Configuration History

**Slug:** `NARWHAL_API_GET_WEBHOOK_CONFIGURATION_HISTORY`

Get the recorded configuration versions of one webhook destination.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `destination_id` | string | Yes | Webhook destination UUID. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Webhook Destination

**Slug:** `NARWHAL_API_GET_WEBHOOK_DESTINATION`

Get one webhook destination and its current configuration.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `destination_id` | string | Yes | Webhook destination UUID. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Yield Curve

**Slug:** `NARWHAL_API_GET_YIELD_CURVE`

Get a government bond yield curve for one source date.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `date` | string | No | Source date; omit for latest. |
| `country` | string | Yes | Uppercase three-letter country code. |
| `maturity` | string | No | Comma-separated maturities; omit for all. |
| `curve_type` | string ("nominal_par" | "zero_coupon" | "constant_maturity_ytm" | "nominal_zero_coupon" | "spot_svensson" | "constant_maturity_benchmark" | "spot_svensson_aaa" | "spot_svensson_all_issuers") | No | Yield-curve methodology filter. |
| `version_id` | string | No | Immutable publication version. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Yield Curve History

**Slug:** `NARWHAL_API_GET_YIELD_CURVE_HISTORY`

Get government bond yield curves by source date, oldest first.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `end` | string | No | Last source date to include. |
| `as_of` | string | No | Curves published by the end of this UTC day. |
| `limit` | integer | No | Maximum curves per page. |
| `start` | string | No | First source date to include. |
| `cursor` | string | No | Next cursor from the previous page. |
| `country` | string | Yes | Uppercase three-letter country code. |
| `maturity` | string | No | Comma-separated maturities; omit for all. |
| `curve_type` | string ("nominal_par" | "zero_coupon" | "constant_maturity_ytm" | "nominal_zero_coupon" | "spot_svensson" | "constant_maturity_benchmark" | "spot_svensson_aaa" | "spot_svensson_all_issuers") | No | Yield-curve methodology filter. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Beneficial Owners

**Slug:** `NARWHAL_API_LIST_BENEFICIAL_OWNERS`

List Beneficial Owners.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `type` | string ("activist" | "passive") | No | Type. |
| `filed` | string | No | Filed. |
| `limit` | integer | No | Limit. |
| `cursor` | string | No | Cursor. |
| `history` | boolean | No | History. |
| `filed_gt` | string | No | Filed gt. |
| `filed_lt` | string | No | Filed lt. |
| `filed_to` | string | No | Filed to. |
| `schedule` | string ("13D" | "13G") | No | Schedule. |
| `filed_gte` | string | No | Filed gte. |
| `filed_lte` | string | No | Filed lte. |
| `is_latest` | boolean | No | Is latest. |
| `company_id` | string | Yes | Company id. |
| `filed_from` | string | No | Filed from. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Company Filings

**Slug:** `NARWHAL_API_LIST_COMPANY_FILINGS`

List Company Filings.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `form` | string | No | Form. |
| `lang` | string ("en" | "original") | No | Lang. |
| `type` | string ("annual" | "semiannual" | "quarterly" | "event" | "ownership" | "insider" | "other") | No | Type. |
| `limit` | integer | No | Limit. |
| `cursor` | string | No | Cursor. |
| `filed_to` | string | No | Filed to. |
| `company_id` | string | Yes | Company id. |
| `filed_from` | string | No | Filed from. |
| `include_amendments` | boolean | No | Include amendments. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Company Insiders

**Slug:** `NARWHAL_API_LIST_COMPANY_INSIDERS`

List Company Insiders.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | No | Name. |
| `limit` | integer | No | Limit. |
| `cursor` | string | No | Cursor. |
| `company_id` | string | Yes | Company id. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Crypto Pairs

**Slug:** `NARWHAL_API_LIST_CRYPTO_PAIRS`

List every cryptocurrency pair Narwhal currently prices, optionally by quote currency.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `quote` | string ("USD" | "EUR" | "GBP") | No | Return only pairs in this quote currency. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Data Events

**Slug:** `NARWHAL_API_LIST_DATA_EVENTS`

List recorded Narwhal dataset and release events in oldest-first order, optionally filtered by country.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Maximum events to return on this page (1-100). |
| `cursor` | string | No | Cursor or next_cursor from an earlier page. Keep countries and limit unchanged when continuing. |
| `countries` | array | No | Uppercase three-letter country codes, or EMU for the euro area; omit for all countries. Values are sent as repeated countries parameters. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Economic Releases

**Slug:** `NARWHAL_API_LIST_ECONOMIC_RELEASES`

List economic release calendar entries by country and date window.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `view` | string | No | Deprecated and ignored by Narwhal. |
| `limit` | integer | No | Maximum releases per page. |
| `cursor` | string | No | Next cursor from the previous page. |
| `end_date` | string | No | Last date to include. |
| `countries` | array | No | Country codes to include; omit for all. |
| `start_date` | string | No | First date to include. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Equity Risk Premium

**Slug:** `NARWHAL_API_LIST_EQUITY_RISK_PREMIUM`

List current equity risk premiums for all covered countries.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Holders

**Slug:** `NARWHAL_API_LIST_HOLDERS`

List Holders.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `lang` | string ("en" | "original") | No | Lang. |
| `limit` | integer | No | Limit. |
| `security` | string | No | Security. |
| `company_id` | string | Yes | Company id. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Holidays

**Slug:** `NARWHAL_API_LIST_HOLIDAYS`

List published holidays and calendar coverage for a country and year, optionally restricted by holiday scope or immutable version.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `year` | integer | Yes | Calendar year from 1900 through 2200. |
| `scope` | string ("national_public" | "regional_public" | "bank" | "federal_government" | "central_government" | "collective_leave" | "public_sector" | "private_sector") | No | Holiday coverage scope to return; omit to return every published scope. |
| `country` | string | Yes | Uppercase three-letter country code, such as USA. |
| `version_id` | string | No | Immutable calendar version UUID from a holiday event. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List HS Codes

**Slug:** `NARWHAL_API_LIST_HS_CODES`

Search or list Harmonized System codes from one HS edition.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `q` | string | No | Text to search in HS code names. |
| `level` | integer | No | Code length to return: 2, 4, or 6. |
| `limit` | integer | No | Maximum codes on this page. |
| `cursor` | string | No | next_cursor from the previous page. |
| `parent` | string | No | HS code whose immediate children to list. |
| `edition` | string | No | HS edition to use. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Insider Feed

**Slug:** `NARWHAL_API_LIST_INSIDER_FEED`

List Insider Feed.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | No | Name. |
| `sort` | string ("filing_date.desc" | "filing_date.asc" | "transaction_date.desc" | "transaction_date.asc") | No | Sort. |
| `limit` | integer | No | Limit. |
| `cursor` | string | No | Cursor. |
| `country` | string | No | Three-letter country code of the registry. Left out means USA. A country the route does not cover is 404 not_covered. |
| `filed_to` | string | No | Filed to. |
| `form_type` | string ("3" | "3/A" | "4" | "4/A" | "5" | "5/A" | "YUHO" | "YUHO/A" | "임원ㆍ주요주주특정증권등소유상황보고서") | No | Form type. |
| `owner_cik` | string | No | Owner cik. |
| `filed_from` | string | No | Filed from. |
| `filing_date` | string | No | Filing date. |
| `filing_date_gt` | string | No | Filing date gt. |
| `filing_date_lt` | string | No | Filing date lt. |
| `transaction_code` | string | No | Transaction code. |
| `transaction_date` | string | No | Transaction date. |
| `transaction_date_gt` | string | No | Transaction date gt. |
| `transaction_date_lt` | string | No | Transaction date lt. |
| `transaction_date_gte` | string | No | Transaction date gte. |
| `transaction_date_lte` | string | No | Transaction date lte. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Insider Ownership

**Slug:** `NARWHAL_API_LIST_INSIDER_OWNERSHIP`

List Insider Ownership.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | No | Name. |
| `limit` | integer | No | Limit. |
| `cursor` | string | No | Cursor. |
| `filed_to` | string | No | Filed to. |
| `form_type` | string ("3" | "3/A" | "4" | "4/A" | "5" | "5/A" | "YUHO" | "YUHO/A" | "임원ㆍ주요주주특정증권등소유상황보고서") | No | Form type. |
| `owner_cik` | string | No | Owner cik. |
| `company_id` | string | Yes | Company id. |
| `filed_from` | string | No | Filed from. |
| `filing_date` | string | No | Filing date. |
| `filing_date_gt` | string | No | Filing date gt. |
| `filing_date_lt` | string | No | Filing date lt. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Insider Person Trades

**Slug:** `NARWHAL_API_LIST_INSIDER_PERSON_TRADES`

List Insider Person Trades.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `cik` | string | Yes | SEC Central Index Key for the insider, with optional usa: prefix. |
| `name` | string | No | Name. |
| `sort` | string ("filing_date.desc" | "filing_date.asc" | "transaction_date.desc" | "transaction_date.asc") | No | Sort. |
| `limit` | integer | No | Limit. |
| `cursor` | string | No | Cursor. |
| `filed_to` | string | No | Filed to. |
| `form_type` | string ("3" | "3/A" | "4" | "4/A" | "5" | "5/A" | "YUHO" | "YUHO/A" | "임원ㆍ주요주주특정증권등소유상황보고서") | No | Form type. |
| `owner_cik` | string | No | Owner cik. |
| `filed_from` | string | No | Filed from. |
| `filing_date` | string | No | Filing date. |
| `filing_date_gt` | string | No | Filing date gt. |
| `filing_date_lt` | string | No | Filing date lt. |
| `transaction_code` | string | No | Transaction code. |
| `transaction_date` | string | No | Transaction date. |
| `transaction_date_gt` | string | No | Transaction date gt. |
| `transaction_date_lt` | string | No | Transaction date lt. |
| `transaction_date_gte` | string | No | Transaction date gte. |
| `transaction_date_lte` | string | No | Transaction date lte. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Insider Statements

**Slug:** `NARWHAL_API_LIST_INSIDER_STATEMENTS`

List Insider Statements.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | No | Name. |
| `limit` | integer | No | Limit. |
| `cursor` | string | No | Cursor. |
| `filed_to` | string | No | Filed to. |
| `form_type` | string ("3" | "3/A" | "4" | "4/A" | "5" | "5/A" | "YUHO" | "YUHO/A" | "임원ㆍ주요주주특정증권등소유상황보고서") | No | Form type. |
| `owner_cik` | string | No | Owner cik. |
| `company_id` | string | Yes | Company id. |
| `filed_from` | string | No | Filed from. |
| `filing_date` | string | No | Filing date. |
| `filing_date_gt` | string | No | Filing date gt. |
| `filing_date_lt` | string | No | Filing date lt. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Insider Trades

**Slug:** `NARWHAL_API_LIST_INSIDER_TRADES`

List Insider Trades.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | No | Name. |
| `sort` | string ("filing_date.desc" | "filing_date.asc" | "transaction_date.desc" | "transaction_date.asc") | No | Sort. |
| `limit` | integer | No | Limit. |
| `cursor` | string | No | Cursor. |
| `filed_to` | string | No | Filed to. |
| `form_type` | string ("3" | "3/A" | "4" | "4/A" | "5" | "5/A" | "YUHO" | "YUHO/A" | "임원ㆍ주요주주특정증권등소유상황보고서") | No | Form type. |
| `owner_cik` | string | No | Owner cik. |
| `company_id` | string | Yes | Company id. |
| `filed_from` | string | No | Filed from. |
| `filing_date` | string | No | Filing date. |
| `filing_date_gt` | string | No | Filing date gt. |
| `filing_date_lt` | string | No | Filing date lt. |
| `transaction_code` | string | No | Transaction code. |
| `transaction_date` | string | No | Transaction date. |
| `transaction_date_gt` | string | No | Transaction date gt. |
| `transaction_date_lt` | string | No | Transaction date lt. |
| `transaction_date_gte` | string | No | Transaction date gte. |
| `transaction_date_lte` | string | No | Transaction date lte. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Insider Transaction Codes

**Slug:** `NARWHAL_API_LIST_INSIDER_TRANSACTION_CODES`

List Insider Transaction Codes.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Institutional Holders

**Slug:** `NARWHAL_API_LIST_INSTITUTIONAL_HOLDERS`

List Institutional Holders.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Limit. |
| `cursor` | string | No | Cursor. |
| `period` | string | No | Period. |
| `company_id` | string | Yes | Company id. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Investor Beneficial Ownership

**Slug:** `NARWHAL_API_LIST_INVESTOR_BENEFICIAL_OWNERSHIP`

List Investor Beneficial Ownership.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `cik` | string | Yes | Regulator identifier for the investor: an SEC CIK with optional usa: prefix, a Japanese E-number, or a Korean registration number. |
| `type` | string ("activist" | "passive") | No | Type. |
| `filed` | string | No | Filed. |
| `limit` | integer | No | Limit. |
| `cursor` | string | No | Cursor. |
| `ticker` | string | No | Ticker. |
| `history` | boolean | No | History. |
| `filed_gt` | string | No | Filed gt. |
| `filed_lt` | string | No | Filed lt. |
| `filed_to` | string | No | Filed to. |
| `schedule` | string ("13D" | "13G") | No | Schedule. |
| `filed_gte` | string | No | Filed gte. |
| `filed_lte` | string | No | Filed lte. |
| `is_latest` | boolean | No | Is latest. |
| `filed_from` | string | No | Filed from. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Investor Filings

**Slug:** `NARWHAL_API_LIST_INVESTOR_FILINGS`

List Investor Filings.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `cik` | string | Yes | SEC Central Index Key for the investor, with optional usa: prefix. |
| `form` | string | No | Form. |
| `limit` | integer | No | Limit. |
| `cursor` | string | No | Cursor. |
| `report_period_gt` | string | No | Report period gt. |
| `report_period_lt` | string | No | Report period lt. |
| `report_period_gte` | string | No | Report period gte. |
| `report_period_lte` | string | No | Report period lte. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Investor Holdings

**Slug:** `NARWHAL_API_LIST_INVESTOR_HOLDINGS`

List Investor Holdings.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `cik` | string | Yes | SEC Central Index Key for the investor, with optional usa: prefix. |
| `limit` | integer | No | Limit. |
| `cursor` | string | No | Cursor. |
| `period` | string | No | Period. |
| `report_period_gt` | string | No | Report period gt. |
| `report_period_lt` | string | No | Report period lt. |
| `report_period_gte` | string | No | Report period gte. |
| `report_period_lte` | string | No | Report period lte. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Latest Filings

**Slug:** `NARWHAL_API_LIST_LATEST_FILINGS`

List Latest Filings.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `lang` | string ("en" | "original") | No | Lang. |
| `type` | string ("annual" | "semiannual" | "quarterly" | "event" | "ownership" | "insider" | "other") | No | Type. |
| `limit` | integer | No | Limit. |
| `country` | string | No | Country. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Palm Oil Physical Series

**Slug:** `NARWHAL_API_LIST_PALMOIL_PHYSICAL_SERIES`

List approved palm-oil physical price series using combinable market and product filters.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `area` | string | No | Area code inside the country. |
| `limit` | integer | No | Maximum series on this page. |
| `cursor` | string | No | Opaque next_cursor from the previous page. |
| `country` | string | No | Country code. |
| `product` | string ("ffb" | "cpo") | No | Palm-oil product. |
| `currency` | string | No | Quote currency. |
| `price_type` | string ("official_purchase_schedule" | "government_reference" | "market_average") | No | Price definition. |
| `producer_type` | string | No | Producer type; only smallholder is supported. |
| `producer_arrangement` | string ("purchase_agreement" | "supported_scheme") | No | Producer arrangement. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Physical Commodity Series

**Slug:** `NARWHAL_API_LIST_PHYSICAL_SERIES`

List physical commodity price series using combinable commodity, category, market, price-type, and currency filters.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Maximum series on this page. |
| `cursor` | string | No | Opaque next_cursor from the previous page. |
| `country` | string | No | Market country, WLD, or EUU. |
| `category` | string ("metals" | "energy" | "grains" | "oils-oilseeds" | "softs" | "livestock-dairy" | "forestry" | "fertilizers" | "emissions") | No | Commodity category. |
| `currency` | string | No | Quote currency. |
| `commodity` | string | No | Commodity slug. |
| `price_type` | string ("government_reference" | "official_buy" | "official_sell" | "official_reference_rate" | "retail_buy" | "retail_sell" | "retail_average" | "wholesale_average" | "farmgate_average" | "market_average" | "export_unit_value" | "import_unit_value" | "auction_clearing" | "regulated_average" | "international_benchmark") | No | Price definition. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Prediction Events

**Slug:** `NARWHAL_API_LIST_PREDICTION_EVENTS`

List prediction-market events, optionally filtered by topic, outcome shape, status, linked release, or resolution time range.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Maximum events to return on this page (1-100). |
| `shape` | string ("scalar" | "extreme" | "timing" | "binary" | "categorical" | "set") | No | Prediction outcome shape to include. |
| `topic` | string | No | Topic slug to filter by. |
| `cursor` | string | No | Opaque next_cursor from the previous page. Keep all filters and limit unchanged when continuing. |
| `status` | string ("upcoming" | "trading" | "closed" | "settled" | "void") | No | Prediction event lifecycle status to include. |
| `to_time` | string | No | Inclusive latest resolves_at timestamp in ISO 8601 date-time format. |
| `from_time` | string | No | Inclusive earliest resolves_at timestamp in ISO 8601 date-time format. |
| `release_id` | string | No | Linked economic release UUID to filter by. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Prediction Topics

**Slug:** `NARWHAL_API_LIST_PREDICTION_TOPICS`

List prediction-market topics, optionally restricted to one group.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `group` | string ("central_banks" | "us_prices" | "us_jobs" | "us_activity" | "metals" | "energy" | "global_activity" | "global_prices") | No | Restrict topics to one prediction group. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Registrations

**Slug:** `NARWHAL_API_LIST_REGISTRATIONS`

List IPO and other securities-registration filings by date, country, company, class, or form.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `cik` | string | No | SEC CIK filter. |
| `end` | string | No | Last filing day, inclusive; defaults to today UTC. |
| `form` | string ("S-1" | "S-1/A" | "F-1" | "F-1/A" | "424B4" | "424B1" | "TODOKE" | "TODOKE/A" | "증권신고서(지분증권)" | "증권신고서(지분증권)/A" | "투자설명서" | "투자설명서/A") | No | Registration form filter. |
| `limit` | integer | No | Maximum registrations on this page. |
| `start` | string | No | First filing day, inclusive; defaults to 30 days before end. |
| `cursor` | string | No | Opaque next_cursor from the previous page. |
| `ticker` | string | No | Ticker filter. |
| `country` | string | No | Registry country; defaults to USA. |
| `registration_class` | string ("ipo" | "spac" | "shell" | "resale" | "other") | No | Registration class filter. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Section Items

**Slug:** `NARWHAL_API_LIST_SECTION_ITEMS`

List Section Items.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `form` | string ("10-K" | "10-Q" | "20-F" | "8-K" | "YUHO" | "HANKI" | "SHIHANKI" | "RINJI" | "사업보고서" | "반기보고서" | "분기보고서") | No | One form's items; omit it for every form. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Webhook Deliveries

**Slug:** `NARWHAL_API_LIST_WEBHOOK_DELIVERIES`

List one webhook destination's delivery attempts one page at a time.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Maximum deliveries on this page (1-100). |
| `cursor` | string | No | Opaque next_cursor from the previous page; retain the same destination and limit. |
| `destination_id` | string | Yes | Webhook destination UUID. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Webhook Destinations

**Slug:** `NARWHAL_API_LIST_WEBHOOK_DESTINATIONS`

List webhook destinations configured for the connected Narwhal account and its destination limit.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Read Catalogue Latest Batch

**Slug:** `NARWHAL_API_READ_CATALOGUE_LATEST_BATCH`

Read the latest observation for a batch of catalogue series IDs.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `ids` | string | Yes | Comma-separated catalogue series IDs. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Read Catalogue Observations

**Slug:** `NARWHAL_API_READ_CATALOGUE_OBSERVATIONS`

Read observations of one extended catalogue series, oldest first.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Provider-qualified catalogue series ID. |
| `end` | string | No | Last period to include. |
| `limit` | integer | No | Maximum observations per page. |
| `start` | string | No | First period to include. |
| `cursor` | string | No | Next cursor from the previous page. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Read Catalogue Series

**Slug:** `NARWHAL_API_READ_CATALOGUE_SERIES`

Read metadata for one extended catalogue series.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Provider-qualified catalogue series ID. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Read Series Observations

**Slug:** `NARWHAL_API_READ_SERIES_OBSERVATIONS`

Read observations of one economic series, oldest first.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `end` | string | No | Last period to include. |
| `as_of` | string | No | Series as published by the end of this UTC day. |
| `limit` | integer | No | Maximum observations per page. |
| `start` | string | No | First period to include. |
| `cursor` | string | No | Next cursor from the previous page. |
| `version` | string | No | Use first_reported for first stored values. |
| `series_id` | string | Yes | Economic series UUID. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Replay Webhook Delivery

**Slug:** `NARWHAL_API_REPLAY_WEBHOOK_DELIVERY`

Replay a webhook delivery. This irreversible action emits another real request to the destination's callback URL.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `delivery_id` | string | Yes | Delivery UUID to send again. This emits another callback request. |
| `destination_id` | string | Yes | Webhook destination UUID. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Revoke Calendar Subscription

**Slug:** `NARWHAL_API_REVOKE_CALENDAR_SUBSCRIPTION`

Permanently revoke a calendar subscription and invalidate its secret ICS feed URL.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `subscription_id` | string | Yes | Calendar subscription UUID returned by Create Calendar Subscription. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Rotate Webhook Secret

**Slug:** `NARWHAL_API_ROTATE_WEBHOOK_SECRET`

Permanently invalidate a webhook destination's current signing secret and return its replacement exactly once. Store the new secret securely and do not log, publish, or share it.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `destination_id` | string | Yes | Webhook destination UUID whose signing secret will be invalidated and replaced. Verify the destination before calling. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Screen Companies

**Slug:** `NARWHAL_API_SCREEN_COMPANIES`

Screen Companies.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `lang` | string ("en" | "original") | No | Language for company names. |
| `as_of` | string | No | Historical screen date. |
| `basis` | string ("annual" | "quarterly" | "ttm") | No | Financial period basis used to screen each company. |
| `limit` | integer | No | Maximum companies on this page. |
| `order` | string ("asc" | "desc") | No | Result ordering direction. |
| `cursor` | string | No | Opaque cursor from the previous page. |
| `fields` | array | No | Numeric fields to return. |
| `filters` | array | No | Up to 20 field comparisons. |
| `currency` | string | No | Reporting currency filter; amounts are not converted. |
| `order_by` | string | No | Numeric field used to order results. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Search Beneficial Ownership Companies

**Slug:** `NARWHAL_API_SEARCH_BENEFICIAL_OWNERSHIP_COMPANIES`

Search Beneficial Ownership Companies.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | Yes | Name. |
| `limit` | integer | No | Limit. |
| `country` | string | No | Three-letter country code of the registry to search. Left out means USA. A country the route does not cover is 404 not_covered. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Search Beneficial Ownership Filers

**Slug:** `NARWHAL_API_SEARCH_BENEFICIAL_OWNERSHIP_FILERS`

Search Beneficial Ownership Filers.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | Yes | Name. |
| `limit` | integer | No | Limit. |
| `country` | string | No | Three-letter country code of the registry to search. Left out means USA. A country the route does not cover is 404 not_covered. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Search Companies

**Slug:** `NARWHAL_API_SEARCH_COMPANIES`

Search filing registries for companies and return company IDs used by company and financial-statement tools.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `as_of` | string | No | Historical as-of date in YYYY-MM-DD format. |
| `limit` | integer | No | Maximum companies to return (1-100). |
| `query` | string | No | Company name, ticker, or registry identifier to search for. |
| `country` | string | No | Uppercase three-letter country code filter. |
| `language` | string ("en" | "original") | No | Return English-normalized or original-language names. |
| `registry` | string ("usa" | "jpn" | "kor" | "gbr" | "twn" | "aut" | "bel" | "cyp" | "cze" | "dnk" | "est" | "esp" | "fin" | "fra" | "grc" | "hrv" | "hun" | "isl" | "ita" | "ltu" | "lux" | "lva" | "mlt" | "nld" | "nor" | "pol" | "prt" | "rou" | "swe" | "svn" | "svk") | No | Registry code to search. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Search Economics Catalogue

**Slug:** `NARWHAL_API_SEARCH_ECONOMICS_CATALOGUE`

Search the extended economic series catalogue.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `q` | string | No | Title or series text to search for. |
| `limit` | integer | No | Maximum series per page. |
| `cursor` | string | No | Next cursor from the previous page. |
| `source` | string | No | Provider source slug to include. |
| `country` | string | No | Country code to include. |
| `frequency` | string ("daily" | "monthly" | "quarterly" | "annual") | No | Observation frequency to include. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Search Equities

**Slug:** `NARWHAL_API_SEARCH_EQUITIES`

Search equity listings by ticker or company-name prefix and return listing IDs for equity price tools, plus company IDs when a listing matches a company.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `query` | string | Yes | Ticker or company-name prefix, at least 2 characters. |
| `cursor` | string | No | Opaque next_cursor from the previous page. Keep query, country, and security_type unchanged when continuing. |
| `country` | string | No | Optional three-letter country code filter. |
| `security_type` | string ("common_stock" | "preferred_stock" | "depositary_receipt" | "reit" | "closed_end_fund" | "unit" | "right" | "warrant" | "other") | No | Optional listing type filter. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Search Funds

**Slug:** `NARWHAL_API_SEARCH_FUNDS`

Search ETFs and mutual funds by ticker or fund-name prefix and return stable fund IDs.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `query` | string | Yes | Ticker or fund-name prefix, at least 2 characters. |
| `cursor` | string | No | Opaque next_cursor from the previous page. Keep query, country, and fund_type unchanged when continuing. |
| `country` | string | No | Optional three-letter country code filter. |
| `fund_type` | string ("etf" | "mutual_fund") | No | Restrict results to ETFs or mutual funds. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Search Investors

**Slug:** `NARWHAL_API_SEARCH_INVESTORS`

Search Investors.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | Yes | Name. |
| `limit` | integer | No | Limit. |
| `cursor` | string | No | Cursor. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Search Line Items

**Slug:** `NARWHAL_API_SEARCH_LINE_ITEMS`

Search Line Items.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Maximum periods per company. |
| `period` | string ("annual" | "semiannual" | "quarterly" | "ttm") | No | Reporting period frequency. |
| `tickers` | array | Yes | Company IDs, registry tickers, or bare US tickers. |
| `end_date` | string | No | Only periods ending on or before this date. |
| `line_items` | array | Yes | Standard financial line-item names. |
| `start_date` | string | No | Only periods ending on or after this date. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Test Webhook Destination

**Slug:** `NARWHAL_API_TEST_WEBHOOK_DESTINATION`

Send a provider-generated test delivery to an existing webhook destination and return its queueing result. This has an external side effect: Narwhal sends a real webhook request to the destination's configured callback URL.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `destination_id` | string | Yes | Webhook destination UUID to test. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Webhook Destination

**Slug:** `NARWHAL_API_UPDATE_WEBHOOK_DESTINATION`

Replace the URL, filters, and enabled state of an existing webhook destination. This PATCH is a full replacement, so provide the complete destination configuration.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `url` | string | Yes | Public HTTPS callback URL that can receive Narwhal deliveries. |
| `enabled` | boolean | No | Whether delivery is enabled in the replacement configuration. Omit to use the provider default of true, which enables delivery. |
| `families` | array | Yes | One to eight event families to deliver. |
| `companies` | array | No | Company IDs to watch. Required with filings and refused without the filings family; at most 1,000. |
| `countries` | array | Yes | One to 60 uppercase three-letter country codes, or WLD for worldwide events. |
| `destination_id` | string | Yes | Webhook destination UUID. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |
