> ## Documentation Index
> Fetch the complete documentation index at: https://composio-preview.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# API Ninjas

> API Ninjas offers over 120 unique APIs across various categories, enabling developers to build real applications with real data.

![API Ninjas logo](https://mintcdn.com/composio-preview/6S5R4NszqpnVIZRD/images/toolkits/api_ninjas.svg?fit=max\&auto=format\&n=6S5R4NszqpnVIZRD\&q=85\&s=7be09bc7d6d856d7d6214a14f78fdd1d)

* **Category:** developer tools
* **Auth:** API\_KEY
* **Composio-managed OAuth available?** N/A
* **Tools:** 259
* **Triggers:** 0
* **Slug:** `API_NINJAS`
* **Version:** 20261101\_00
* **Instant:** Supported on the latest version. Support varies by tool.

## Tools

> [accordion] Analyze Nutrition
>
> **Slug:** `API_NINJAS_ANALYZE_NUTRITION`
>
> Tool to extract nutrition information from text query. Use when you need to parse food-related text (e.g., recipes, menus) to calculate corresponding nutrition data.
>
> #### Input Parameters
>
> **query** `string` *required*
>
> Text to extract nutrition information from. Specify quantities if needed (e.g., '1lb brisket and fries').
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Analyze Text Sentiment
>
> **Slug:** `API_NINJAS_ANALYZE_SENTIMENT`
>
> Tool to analyze the sentiment of text. Returns a numerical sentiment score from -1 to 1 and a classification (POSITIVE, WEAK\_POSITIVE, NEUTRAL, WEAK\_NEGATIVE, or NEGATIVE). Use when you need to determine the emotional tone or sentiment of text content.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** \$0.059 per 100 API requests
>
> **Discount:** 95
>
> #### Input Parameters
>
> **text** `string` *required*
>
> Text to analyze for sentiment. Maximum 2000 characters.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Assess NAICS Risk
>
> **Slug:** `API_NINJAS_ASSESS_NAICS_RISK`
>
> Assess documented compliance risk indicators for NAICS codes. Requires Business tier and above.
>
> #### Input Parameters
>
> **code** `string`
>
> One 2- to 6-digit NAICS 2022 code. Supply exactly one of code or codes.
>
> **codes** `string`
>
> Comma-separated 2- to 6-digit NAICS codes for batch lookup, up to 500 codes. Supply exactly one of code or codes.
>
> **framework** `string ("kyb" | "card" | "lending")`
>
> Risk lens; omit for kyb.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Calculate Airport Distance
>
> **Slug:** `API_NINJAS_CALCULATE_AIRPORT_DISTANCE`
>
> Calculate great-circle distance, initial bearing, and estimated flight time between two airports. Requires Premium only.
>
> #### Input Parameters
>
> **to** `string` *required*
>
> Destination airport — IATA (3 chars) or ICAO (4 chars) code.
>
> **from** `string` *required*
>
> Origin airport — IATA (3 chars) or ICAO (4 chars) code.
>
> **units** `string ("km" | "mi" | "nm")`
>
> Distance units. Must be one of: km (default), mi , nm .
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Calculate Calories Burned
>
> **Slug:** `API_NINJAS_CALCULATE_CALORIES_BURNED`
>
> Tool to calculate calories burned for an activity based on duration and body weight. Use when you need to estimate energy expenditure for physical activities.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** \$0.059 per 100 API requests
>
> **Discount:** 95
>
> #### Input Parameters
>
> **weight** `number`
>
> Body weight in pounds, between 50 and 500. Default is 160 pounds.
>
> **activity** `string` *required*
>
> Name of the activity (e.g., 'running', 'swimming', 'cycling').
>
> **duration** `integer`
>
> Duration in minutes. If not provided, API uses default (typically 60 minutes).
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Calculate Currency Volatility
>
> **Slug:** `API_NINJAS_CALCULATE_CURRENCY_VOLATILITY`
>
> Calculate realized volatility and percentile context for a currency pair. Requires Premium only.
>
> #### Input Parameters
>
> **pair** `string` *required*
>
> Currency pair to query, in the form currency1\_currency2 (e.g. EUR\_USD ).
>
> **method** `string ("close_to_close" | "ewma")`
>
> Volatility method: close\_to\_close (default) or ewma .
>
> **window** `integer`
>
> Lookback window for the headline realized volatility, in trading days. Defaults to 30 . Must be between 2 and 1000.
>
> **day\_count** `integer ("252" | "365")`
>
> Annualization factor: 252 trading days (default) or 365 calendar days.
>
> **annualized** `boolean`
>
> Whether to treat the annualized figure as the headline value. Defaults to true .
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Calculate Income Tax
>
> **Slug:** `API_NINJAS_CALCULATE_INCOME_TAX`
>
> Tool to calculate income taxes for US and Canada. Use when you need detailed breakdown of federal, state/provincial, and FICA taxes. Country and region codes must be correct.
>
> #### Input Parameters
>
> **income** `number` *required*
>
> Annual income amount; must be non-negative.
>
> **region** `string` *required*
>
> State/province code (e.g., 'CA', 'NY', 'ON').
>
> **country** `string ("US" | "CA")` *required*
>
> 2-letter country code (e.g., 'US' for United States, 'CA' for Canada). Currently only US and CA are supported.
>
> **credits** `number`
>
> Total tax credits amount; non-negative. Defaults to 0.
>
> **deductions** `number`
>
> Total tax deductions amount; non-negative. Defaults to 0.
>
> **filing\_status** `string ("single" | "married" | "married_separate" | "head_of_household")`
>
> Tax filing status; required for US. Possible values: 'single', 'married', 'married\_separate', or 'head\_of\_household'.
>
> **self\_employed** `boolean`
>
> Set to true for self-employed tax calculations (US only). Defaults to false.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Calculate Mortgage
>
> **Slug:** `API_NINJAS_CALCULATE_MORTGAGE`
>
> Tool to calculate mortgage payments and breakdowns. Use when you need to determine monthly/annual payments, including mortgage, property tax, HOA, and insurance components.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** \$0.059 per 100 API requests
>
> **Discount:** 95
>
> #### Input Parameters
>
> **home\_value** `number`
>
> Total value of the home or asset. Must be greater than downpayment.
>
> **downpayment** `number`
>
> Downpayment on the home or asset. Cannot exceed home\_value.
>
> **loan\_amount** `number`
>
> Principal loan amount. Either this OR (home\_value + downpayment) must be provided.
>
> **monthly\_hoa** `number`
>
> Monthly homeowner association fees
>
> **interest\_rate** `number` *required*
>
> Annual interest rate (in %). For example, a 3.5% interest rate would be 3.5
>
> **duration\_years** `integer`
>
> Loan duration in years (1-10000). Defaults to 30.
>
> **annual\_property\_tax** `number`
>
> Annual property tax owed
>
> **annual\_home\_insurance** `number`
>
> Annual homeowner's insurance bill
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Calculate Paycheck Withholding
>
> **Slug:** `API_NINJAS_CALCULATE_PAYCHECK_WITHHOLDING`
>
> Calculate federal, FICA, and optional state paycheck withholding. Requires Premium only.
>
> #### Input Parameters
>
> **state** `string`
>
> Two-letter state code; omit for federal-only.
>
> **tax\_year** `integer`
>
> Tax year; currently 2026.
>
> **gross\_pay** `number` *required*
>
> Gross pay for this period in USD.
>
> **ytd\_gross** `number`
>
> Year-to-date gross before this paycheck in USD.
>
> **allowances** `integer`
>
> Pre-2020 W-4 allowances.
>
> **deductions** `number`
>
> Annual deductions over the standard deduction in USD.
>
> **pay\_period** `string ("weekly" | "biweekly" | "semimonthly" | "monthly" | "quarterly" | "semiannually" | "annually" | "daily")` *required*
>
> Payroll period.
>
> **w4\_version** `string ("2020_or_later" | "pre_2020")`
>
> W-4 worksheet version.
>
> **other\_income** `number`
>
> Annual other income in USD.
>
> **filing\_status** `string ("single" | "married" | "married_separate" | "head_of_household")` *required*
>
> Tax filing status.
>
> **multiple\_jobs** `boolean`
>
> W-4 multiple-jobs checkbox.
>
> **dependents\_amount** `number`
>
> Annual dependent credit in USD.
>
> **extra\_withholding** `number`
>
> Extra per-period federal withholding in USD.
>
> **pretax\_deductions** `number`
>
> Pre-tax deductions for this paycheck in USD.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Calculate Sales Tax
>
> **Slug:** `API_NINJAS_CALCULATE_SALES_TAX`
>
> Tool to calculate sales tax for a purchase amount at a US location. Use when you need to determine the sales tax for a purchase based on ZIP code or city/state. Premium features include detailed breakdowns by city, county, and special districts.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** \$0.059 per 100 API requests
>
> **Discount:** 95
>
> #### Input Parameters
>
> **city** `string`
>
> City name (must be used with state parameter). Use this with state OR use zip\_code for location.
>
> **state** `string`
>
> State name (must be used with city parameter). Use this with city OR use zip\_code for location.
>
> **amount** `number` *required*
>
> Purchase amount to calculate sales tax on. Must be non-negative.
>
> **zip\_code** `string`
>
> Valid US ZIP code (5 digits). Use this OR both city and state parameters for location.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Check Bank Holiday
>
> **Slug:** `API_NINJAS_CHECK_BANK_HOLIDAY`
>
> Check whether banks are closed on a date in a country or subdivision.
>
> #### Input Parameters
>
> **date** `string` *required*
>
> Date in YYYY-MM-DD format. Free supports past and current calendar years; future calendar years require Premium.
>
> **country** `string` *required*
>
> Country code or exact English country name.
>
> **subdivision** `string`
>
> ISO 3166-2 subdivision code.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Check Disposable Email
>
> **Slug:** `API_NINJAS_CHECK_DISPOSABLE_EMAIL`
>
> Tool to check whether an email address is from a disposable email provider. Use when validating user emails prior to sending communications.
>
> #### Input Parameters
>
> **email** `string` *required*
>
> The email address to check for disposability.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Check Domain Availability
>
> **Slug:** `API_NINJAS_CHECK_DOMAIN`
>
> Tool to check domain availability and retrieve registration information. Use when you need to verify if a domain is available for registration or get details about an existing domain.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** \$0.059 per 100 API requests
>
> **Discount:** 95
>
> #### Input Parameters
>
> **domain** `string` *required*
>
> Valid domain to check (e.g., example.com). For top-level domains other than .com, a premium subscription is required.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Check Holiday
>
> **Slug:** `API_NINJAS_CHECK_HOLIDAY`
>
> Return all documented holiday categories on a date across every country when country is omitted; use Check Is Public Holiday for a country-specific public-holiday boolean or Check Bank Holiday for bank closures.
>
> #### Input Parameters
>
> **date** `string` *required*
>
> Date in YYYY-MM-DD format. Free supports past and current calendar years; future calendar years require Premium.
>
> **country** `string`
>
> Country code or exact English country name.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Check If Date Is Public Holiday
>
> **Slug:** `API_NINJAS_CHECK_IS_PUBLIC_HOLIDAY`
>
> Tool to check if a specific date is a public holiday in a given country. Use when you need to verify holiday status for scheduling, planning, or calendar-related tasks. Returns holiday name if applicable.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** \$0.059 per 100 API requests
>
> **Discount:** 95
>
> #### Input Parameters
>
> **date** `string` *required*
>
> Date to check in YYYY-MM-DD format (e.g., '2026-01-01'). Must be between 1980-01-01 and 2050-12-31.
>
> **country** `string` *required*
>
> 2-letter ISO 3166-1 alpha-2 country code (e.g., 'US' for United States, 'GB' for United Kingdom, 'JP' for Japan). This determines which country's public holidays are checked.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Check If Date Is Working Day
>
> **Slug:** `API_NINJAS_CHECK_IS_WORKING_DAY`
>
> Check whether a date is a working day in a country, with configurable weekend days and optional inclusion of public holidays.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** \$0.059 per 100 API requests
>
> **Discount:** 95
>
> #### Input Parameters
>
> **date** `string` *required*
>
> Date in YYYY-MM-DD format. Must be between 1980-01-01 and 2050-12-31 (inclusive).
>
> **country** `string` *required*
>
> Country code (2-letter ISO 3166-1 alpha-2 code, e.g., 'US' for United States, 'GB' for United Kingdom).
>
> **weekend\_days** `string`
>
> Comma-separated list of weekend days (mon,tue,wed,thu,fri,sat,sun). Optional: if not provided, default weekend days are determined by country.
>
> **include\_holidays** `boolean`
>
> Whether to include public holidays as non-working days. Defaults to true if not specified.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Check Lottery Ticket
>
> **Slug:** `API_NINJAS_CHECK_LOTTERY_TICKET`
>
> Score a supported lottery ticket against a draw. Requires Premium only.
>
> #### Input Parameters
>
> **date** `string` *required*
>
> Draw date in YYYY-MM-DD format. Developer covers the last two years; Business tier and above covers any supported draw.
>
> **game** `string ("powerball" | "megamillions" | "millionaireforlife")` *required*
>
> Supported lottery game slug.
>
> **bonus** `string` *required*
>
> Ticket bonus ball.
>
> **numbers** `string` *required*
>
> Comma-separated main ticket numbers.
>
> **multiplier** `string ("2" | "3" | "4" | "5" | "10")`
>
> Mega Millions printed multiplier.
>
> **power\_play** `boolean`
>
> Whether a Powerball ticket has Power Play.
>
> **double\_play** `boolean`
>
> Set to true to score the Double Play draw.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Check Sales Tax Nexus
>
> **Slug:** `API_NINJAS_CHECK_SALES_TAX_NEXUS`
>
> Evaluate supplied sales and transaction totals against a state's economic-nexus rules. Requires Premium only.
>
> #### Input Parameters
>
> **state** `string`
>
> Two-letter state code or full state name.
>
> **revenue** `number`
>
> Revenue in US dollars measured using the state's threshold definition.
>
> **gross\_sales** `number`
>
> Gross sales in US dollars delivered into the state.
>
> **retail\_sales** `number`
>
> Retail sales in US dollars delivered into the state.
>
> **transactions** `integer`
>
> Count of transactions delivered into the state.
>
> **taxable\_sales** `number`
>
> Taxable sales in US dollars delivered into the state.
>
> **marketplace\_sales** `number`
>
> Marketplace-facilitated sales in US dollars.
>
> **marketplace\_transactions** `integer`
>
> Count of marketplace-facilitated transactions.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Check Spelling
>
> **Slug:** `API_NINJAS_CHECK_SPELLING`
>
> Tool to check spelling and get corrections for text. Returns the original text, corrected version, and detailed corrections with alternative suggestions.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** \$0.059 per 100 API requests
>
> **Discount:** 95
>
> #### Input Parameters
>
> **text** `string` *required*
>
> The text to be spell-checked. Can be a single word or multiple words.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Classify Business NAICS
>
> **Slug:** `API_NINJAS_CLASSIFY_BUSINESS_NAICS`
>
> Classify a business description to a NAICS code. Requires Business tier and above.
>
> #### Input Parameters
>
> **description** `string` *required*
>
> Business or establishment description, up to 2000 characters.
>
> **min\_confidence** `number`
>
> Minimum confidence from 0 to 1.
>
> **include\_alternatives** `boolean`
>
> Whether to return rejected candidate codes.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Compute Text Similarity
>
> **Slug:** `API_NINJAS_COMPUTE_TEXT_SIMILARITY`
>
> Tool to compute semantic similarity between two texts. Returns a similarity score from 0 to 1 using NLP embeddings and cosine similarity. Use when comparing text content, detecting duplicates, or measuring semantic relatedness.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** \$0.059 per 100 API requests
>
> **Discount:** 95
>
> #### Input Parameters
>
> **text\_1** `string` *required*
>
> First text to compare for similarity.
>
> **text\_2** `string` *required*
>
> Second text to compare for similarity.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Convert Airport Code
>
> **Slug:** `API_NINJAS_CONVERT_AIRPORT_CODE`
>
> Resolve an IATA, ICAO, GPS, ident, or local airport code to the matching airport record.
>
> #### Input Parameters
>
> **code** `string`
>
> Any airport identifier: IATA, ICAO, ident, GPS, or local code. Supply exactly one of iata, icao, or code; the matching type is detected automatically.
>
> **iata** `string`
>
> 3-character IATA airport code. Supply exactly one of iata, icao, or code.
>
> **icao** `string`
>
> 4-character ICAO airport code. Supply exactly one of iata, icao, or code.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Convert Currency
>
> **Slug:** `API_NINJAS_CONVERT_CURRENCY`
>
> Convert between currencies using current exchange rates. Returns the converted amount with both source and target currency details. Use this when you need to know how much a specific amount in one currency is worth in another currency.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** \$0.059 per 100 API requests
>
> **Discount:** 95
>
> #### Input Parameters
>
> **have** `string` *required*
>
> Source currency code (e.g., USD, EUR, GBP, JPY). The currency you currently have.
>
> **want** `string` *required*
>
> Target currency code (e.g., USD, EUR, GBP, AUD). The currency you want to convert to.
>
> **amount** `number` *required*
>
> Amount to convert in the source currency. Must be a positive number.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Convert Unit
>
> **Slug:** `API_NINJAS_CONVERT_UNIT`
>
> Convert between measurement units across different categories. Returns converted values for all units in the same category. Use this when you need to convert measurements (length, weight, temperature, volume, area, time, speed, etc.) from one unit to another.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** \$0.059 per 100 API requests
>
> **Discount:** 95
>
> #### Input Parameters
>
> **unit** `string` *required*
>
> The source unit to convert from (e.g., 'meter', 'kilogram', 'celsius', 'gallon'). If the unit name has spaces, replace them with underscores (e.g., 'square\_meter').
>
> **amount** `number` *required*
>
> The numerical value to convert. Must be a positive or negative number.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Detect Faces
>
> **Slug:** `API_NINJAS_DETECT_FACES`
>
> Detect faces and return their pixel bounding boxes in a JPEG or PNG image.
>
> #### Input Parameters
>
> **image** `object` *required*
>
> Image file containing faces. Must be either JPEG or PNG format.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Detect Objects
>
> **Slug:** `API_NINJAS_DETECT_OBJECTS`
>
> Detect labeled objects and bounding boxes in a JPEG or PNG image smaller than 2000 by 2000 pixels.
>
> #### Input Parameters
>
> **image** `object` *required*
>
> JPEG or PNG image smaller than 2000 by 2000 pixels.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Detect Text Language
>
> **Slug:** `API_NINJAS_DETECT_TEXT_LANGUAGE`
>
> Tool to detect the language of input text. Returns the ISO language code and full language name. For best accuracy, use text with 10 or more words.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** \$0.059 per 100 API requests
>
> **Discount:** 95
>
> #### Input Parameters
>
> **text** `string` *required*
>
> Input text to detect language from. Maximum 1000 characters. For best results, use 10 words or more.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Extract Text From Image
>
> **Slug:** `API_NINJAS_EXTRACT_TEXT_FROM_IMAGE`
>
> Extract text blocks and pixel bounding boxes from a JPEG or PNG image.
>
> #### Input Parameters
>
> **image** `object` *required*
>
> JPEG or PNG image. Free accounts accept up to 200 KB; premium accounts accept up to 5 MB.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Extract Webpage Content
>
> **Slug:** `API_NINJAS_EXTRACT_WEBPAGE_CONTENT`
>
> Retrieve URL information and webpage metadata, including domain, path, title, description, meta tags, and favicon.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** \$0.059 per 100 API requests
>
> **Discount:** 95
>
> #### Input Parameters
>
> **url** `string` *required*
>
> The URL of the webpage to extract content from. Must be a valid HTTP or HTTPS URL.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Filter Profanity from Text
>
> **Slug:** `API_NINJAS_FILTER_PROFANITY`
>
> Tool to detect and censor profanity in text. Returns the original text, censored version with profane words replaced by asterisks, and whether profanity was detected.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** \$0.059 per 100 API requests
>
> **Discount:** 95
>
> #### Input Parameters
>
> **text** `string` *required*
>
> Text to filter for profanity. Maximum 1000 characters.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Find Closest Airport
>
> **Slug:** `API_NINJAS_FIND_CLOSEST_AIRPORT`
>
> Find airports near coordinates, with distance and optional size, runway, and IATA filters. Requires Premium only.
>
> #### Input Parameters
>
> **lat** `number` *required*
>
> Latitude of the search center, in decimal degrees (-90 to 90).
>
> **lon** `number` *required*
>
> Longitude of the search center, in decimal degrees (-180 to 180).
>
> **size** `string ("large" | "medium" | "small")`
>
> Restrict to size: large , medium , or small .
>
> **limit** `integer`
>
> Maximum number of results. Must be between 1 and 50. Default is 10.
>
> **units** `string ("km" | "mi")`
>
> Distance units. Must be km (default) or mi .
>
> **radius** `number`
>
> Search radius in kilometres. Default is 50, maximum is 500.
>
> **has\_iata** `boolean`
>
> Filter by whether the airport has an IATA code ( true or false ).
>
> **min\_runway\_length** `number`
>
> Minimum runway length in feet.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Find EV Charging Stations
>
> **Slug:** `API_NINJAS_FIND_EV_CHARGING_STATIONS`
>
> Tool to find electric vehicle charging stations near a specified location. Use when you need to locate EV charging infrastructure by geographic coordinates.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** \$0.059 per 100 API requests
>
> **Discount:** 95
>
> #### Input Parameters
>
> **lat** `number` *required*
>
> Latitude coordinate of the search location.
>
> **lon** `number` *required*
>
> Longitude coordinate of the search location.
>
> **level** `integer`
>
> Filter by charging level: 1 (slow), 2 (medium), or 3 (fast/DC).
>
> **limit** `integer`
>
> Maximum number of results to return. Range: 1-30, default 3.
>
> **offset** `integer`
>
> Number of results to skip for pagination.
>
> **distance** `number`
>
> Search distance in kilometers defining the provider search box around the coordinates. Maximum 50 km, default 3 km.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Forecast Currency Volatility
>
> **Slug:** `API_NINJAS_FORECAST_CURRENCY_VOLATILITY`
>
> Forecast currency-pair volatility across requested trading-day horizons. Requires Premium only.
>
> #### Input Parameters
>
> **pair** `string` *required*
>
> Currency pair to query, in the form currency1\_currency2 (e.g. GBP\_JPY ).
>
> **lambda** `number`
>
> EWMA decay factor, used only when method=ewma . Defaults to 0.94 (RiskMetrics). Must be between 0.80 and 0.99.
>
> **method** `string ("garch_11" | "ewma")`
>
> Forecast method: garch\_11 (default) or ewma .
>
> **horizon** `string`
>
> Comma-separated list of forecast horizons in trading days (e.g. 1,5,21,63 ). Defaults to 1,5,21,63 .
>
> **day\_count** `integer ("252" | "365")`
>
> Annualization factor: 252 trading days (default) or 365 calendar days.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Generate Barcode Image
>
> **Slug:** `API_NINJAS_GENERATE_BARCODE`
>
> Generate a barcode image for specified text in PNG or SVG format. Returns the image data as a base64-encoded string.
>
> #### Input Parameters
>
> **text** `string` *required*
>
> Text to encode in the barcode
>
> **type** `string ("code39" | "code128" | "ean" | "ean13" | "ean8" | "gtin" | "isbn" | "isbn10" | "isbn13" | "issn" | "jan" | "pzn" | "upc" | "upca")`
>
> Type of barcode to generate. GS1 is not supported.
>
> **format** `string ("png" | "svg")`
>
> Image format to return
>
> **include\_text** `boolean`
>
> Whether to include the text below the barcode
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Generate Lorem Ipsum Text
>
> **Slug:** `API_NINJAS_GENERATE_LOREM_IPSUM`
>
> Tool to generate Lorem Ipsum placeholder text. Use when you need dummy text for design mockups, testing, or content placeholders.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** \$0.059 per 100 API requests
>
> **Discount:** 95
>
> #### Input Parameters
>
> **paragraphs** `integer`
>
> Number of paragraphs of Lorem Ipsum text to generate. Must be a positive integer. Defaults to 1 if not specified.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Generate Secure Password
>
> **Slug:** `API_NINJAS_GENERATE_PASSWORD`
>
> Tool to generate secure random passwords with configurable length and character types. Use when you need to create strong passwords with a chosen length and optional exclusion of numbers or special characters. Uppercase and lowercase exclusions are not supported by the provider.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** \$0.059 per 100 API requests
>
> **Discount:** 95
>
> #### Input Parameters
>
> **length** `integer`
>
> Password length in characters. Default is 16.
>
> **numbers** `boolean`
>
> Include numbers (0-9) in the password.
>
> **special** `boolean`
>
> Include special characters (!@#\$%^&\*() etc.) in the password.
>
> **lowercase** `boolean`
>
> Compatibility option fixed to true: API Ninjas cannot exclude lowercase letters. False is not supported.
>
> **uppercase** `boolean`
>
> Compatibility option fixed to true: API Ninjas cannot exclude uppercase letters. False is not supported.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Generate QR Code
>
> **Slug:** `API_NINJAS_GENERATE_QR_CODE`
>
> Tool to generate QR code images for encoding data. Use when you need to create scannable QR codes for URLs, text, or other data. Returns the QR code as a PNG or SVG image file.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** \$0.059 per 100 API requests
>
> **Discount:** 95
>
> #### Input Parameters
>
> **data** `string` *required*
>
> Data to encode in the QR code. Can be any text, URL, or other string content.
>
> **format** `string ("png" | "svg")`
>
> Output format for the QR code image. Choose 'png' for raster image or 'svg' for vector graphics.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Generate Random User Profiles
>
> **Slug:** `API_NINJAS_GENERATE_RANDOM_USER`
>
> Tool to generate fake random user profiles with realistic data. Returns user profiles with names, addresses, contact info, job details, and technical data. Use when you need realistic test data, demo users, or placeholder profiles for development and testing purposes.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** \$0.059 per 100 API requests
>
> **Discount:** 95
>
> #### Input Parameters
>
> **seed** `string`
>
> Seed value for reproducible random data generation. Using the same seed value will always produce the same set of random users, which is useful for testing or creating consistent demo data.
>
> **count** `integer`
>
> Number of random user profiles to generate. Must be between 1 and 30. Default: 10
>
> **fields** `array`
>
> Profile fields to include in the response. Only these fields are returned.
>
> **gender** `string ("male" | "female" | "nonbinary" | "any")`
>
> Gender filter for random user generation
>
> **locale** `string`
>
> Locale for generating localized data such as names, addresses, and phone numbers. Use standard locale codes like 'en\_US' (English - United States), 'de\_DE' (German - Germany), 'fr\_FR' (French - France), 'es\_ES' (Spanish - Spain), etc. Default: 'en\_US'
>
> **exclude** `array`
>
> Profile fields to exclude from the response. All other fields are returned.
>
> **max\_age** `integer`
>
> Maximum age for generated users. Must be between 0 and 1000. Default: 100
>
> **min\_age** `integer`
>
> Minimum age for generated users. Must be between 0 and 1000. Default: 0
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Generate Sudoku Puzzle
>
> **Slug:** `API_NINJAS_GENERATE_SUDOKU`
>
> Tool to generate a new Sudoku puzzle with a specified difficulty level. Use when you need to create Sudoku puzzles for games or educational purposes. Returns both the puzzle grid (with empty cells) and the complete solution.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** \$0.059 per 100 API requests
>
> **Discount:** 95
>
> #### Input Parameters
>
> **seed** `integer`
>
> Seed value for reproducible puzzle generation. Use the same seed to generate the same puzzle. Optional.
>
> **width** `integer`
>
> Width of each box in the Sudoku grid. Must be between 2 and 4. Default is 3 (standard 9x9 Sudoku).
>
> **height** `integer`
>
> Height of each box in the Sudoku grid. Must be between 2 and 4. Default is 3 (standard 9x9 Sudoku).
>
> **difficulty** `string ("easy" | "medium" | "hard")`
>
> Supported difficulty levels for Sudoku puzzle generation.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Generate Text Embeddings
>
> **Slug:** `API_NINJAS_GENERATE_TEXT_EMBEDDINGS`
>
> Tool to encode text into vector embeddings using NLP models. Use when you need to generate semantic vectors for text comparison, search, or recommendation systems.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** \$0.059 per 100 API requests
>
> **Discount:** 95
>
> #### Input Parameters
>
> **text** `string` *required*
>
> Text to generate embeddings for. Maximum 5,000 characters.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Generate Text Embeddings Batch
>
> **Slug:** `API_NINJAS_GENERATE_TEXT_EMBEDDINGS_BATCH`
>
> Generate embeddings for up to ten texts using a bounded sequence of calls to the provider's singular embeddings endpoint, returning per-item vectors or errors.
>
> #### Input Parameters
>
> **texts** `array` *required*
>
> One to ten texts to embed. Each text is sent to the provider's singular endpoint and may contain at most 5,000 characters.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Generate User Agent String
>
> **Slug:** `API_NINJAS_GENERATE_USER_AGENT`
>
> Tool to generate realistic random user agent strings with optional filters for brand, model, OS, and browser. Use when you need authentic-looking user agent strings for web scraping, testing, or browser simulation.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** \$0.059 per 100 API requests
>
> **Discount:** 95
>
> #### Input Parameters
>
> **os** `string`
>
> Operating system to filter by (e.g., 'Windows', 'iOS', 'Android', 'macOS', 'Linux'). If not specified, any OS may be used.
>
> **brand** `string`
>
> Device manufacturer/brand to filter by (e.g., 'Apple', 'Samsung', 'Google', 'LG'). If not specified, any brand may be used.
>
> **model** `string`
>
> Device model name to filter by (e.g., 'iPhone', 'Galaxy', 'Pixel'). If not specified, any model may be used.
>
> **browser** `string`
>
> Browser application to filter by (e.g., 'Chrome', 'Firefox', 'Safari', 'Edge'). If not specified, any browser may be used.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Account Analytics
>
> **Slug:** `API_NINJAS_GET_ACCOUNT_ANALYTICS`
>
> Return connected-account subscription and API usage analytics while redacting the API key. Requires Professional or Enterprise; account-private and zero-quota.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Random Life Advice
>
> **Slug:** `API_NINJAS_GET_ADVICE`
>
> Tool to get a random piece of life advice from the API Ninjas Advice endpoint. Use when you need motivational or thought-provoking advice.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** \$0.059 per 100 API requests
>
> **Discount:** 95
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Aircraft Information
>
> **Slug:** `API_NINJAS_GET_AIRCRAFT`
>
> Tool to retrieve aircraft information by manufacturer and model including specifications and performance data. Use when you need technical details about specific aircraft models or want to search aircraft by performance criteria.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** \$0.059 per 100 API requests
>
> **Discount:** 95
>
> #### Input Parameters
>
> **model** `string`
>
> Aircraft model name (e.g., 'G550', '747', 'Citation').
>
> **max\_range** `integer`
>
> Maximum range in nautical miles. Filter aircraft with range less than or equal to this value.
>
> **max\_speed** `integer`
>
> Maximum speed in knots. Filter aircraft with speed less than or equal to this value.
>
> **min\_range** `integer`
>
> Minimum range in nautical miles. Filter aircraft with range greater than or equal to this value.
>
> **min\_speed** `integer`
>
> Minimum speed in knots. Filter aircraft with speed greater than or equal to this value.
>
> **manufacturer** `string`
>
> Aircraft manufacturer name (e.g., 'Gulfstream', 'Boeing', 'Cessna').
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Airline Information
>
> **Slug:** `API_NINJAS_GET_AIRLINES`
>
> Tool to retrieve airline information by name, IATA code, or ICAO code. Use when you need details about airlines including fleet size, base location, and branding assets.
>
> #### Input Parameters
>
> **iata** `string`
>
> 2-letter IATA airline code (e.g., 'LH' for Lufthansa, 'SQ' for Singapore Airlines).
>
> **icao** `string`
>
> 3-letter ICAO airline code (e.g., 'DLH' for Lufthansa, 'SIA' for Singapore Airlines).
>
> **name** `string`
>
> Airline name to search for (e.g., 'Lufthansa', 'Singapore Airlines'). Partial matches are supported.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Airport Information
>
> **Slug:** `API_NINJAS_GET_AIRPORTS`
>
> Tool to search for airport information by IATA code, ICAO code, name, city, country, or region. Use when you need to find airport details, coordinates, or codes. Returns up to 10 matching airports.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** \$0.059 per 100 API requests
>
> **Discount:** 95
>
> #### Input Parameters
>
> **city** `string`
>
> City name to search for airports (e.g., 'New York', 'London', 'Paris'). Returns all airports in the specified city.
>
> **iata** `string`
>
> 3-letter IATA airport code (e.g., 'JFK', 'LHR', 'CDG'). Use this to search for a specific airport by its international code.
>
> **icao** `string`
>
> 4-letter ICAO airport code (e.g., 'KJFK', 'EGLL', 'LFPG'). Use this to search for a specific airport by its ICAO designation.
>
> **name** `string`
>
> Airport name to search for (e.g., 'John F Kennedy International Airport', 'Heathrow'). Partial matches are supported.
>
> **offset** `integer`
>
> Number of results to offset for pagination. Use this to paginate through results by setting offset to multiples of the result limit (e.g., 0, 30, 60).
>
> **region** `string`
>
> Region or state to search for airports (e.g., 'California', 'Texas', 'England'). Returns all airports in the specified region.
>
> **country** `string`
>
> Country code or name to search for airports (e.g., 'US', 'United States', 'GB', 'United Kingdom'). Returns all airports in the specified country.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Air Quality Data
>
> **Slug:** `API_NINJAS_GET_AIR_QUALITY`
>
> Tool to retrieve air quality index and pollutant data for a location. Use when you need current air quality information for environmental monitoring or health assessments. Query by city name or GPS coordinates.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** \$0.059 per 100 API requests
>
> **Discount:** 95
>
> #### Input Parameters
>
> **lat** `number`
>
> Latitude coordinate (-90 to 90). Must be used together with lon parameter.
>
> **lon** `number`
>
> Longitude coordinate (-180 to 180). Must be used together with lat parameter.
>
> **city** `string`
>
> City name. Must provide either city or coordinates (lat/lon).
>
> **state** `string`
>
> US state name or abbreviation (for US cities only). Use with city parameter to disambiguate locations.
>
> **country** `string`
>
> Country name or ISO 3166-1 alpha-2 code. Use with city parameter to disambiguate locations.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Animal Information
>
> **Slug:** `API_NINJAS_GET_ANIMALS`
>
> Tool to retrieve detailed scientific information about animal species. Use to look up taxonomy, habitat, diet, or physical characteristics for an animal species.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** \$0.059 per 100 API requests
>
> **Discount:** 95
>
> #### Input Parameters
>
> **name** `string` *required*
>
> Common name of the animal to search for. Returns up to 10 matching results.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Baby Names
>
> **Slug:** `API_NINJAS_GET_BABY_NAMES`
>
> Tool to get baby name suggestions by gender. Returns 10 baby name suggestions that can be filtered by gender (boy, girl, or neutral) and popularity. Use when you need baby name ideas or recommendations.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** \$0.059 per 100 API requests
>
> **Discount:** 95
>
> #### Input Parameters
>
> **gender** `string ("boy" | "girl" | "neutral")`
>
> Gender filter for baby names
>
> **popular\_only** `boolean`
>
> Whether to only return popular names (top 10% of names). Set to true to get only popular names, false to include less common names. Defaults to true.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Balance Sheet
>
> **Slug:** `API_NINJAS_GET_BALANCE_SHEET`
>
> Deprecated compatibility tool for balance sheets. Use API\_NINJAS\_GET\_FINANCIAL\_STATEMENT with statement\_type=balance\_sheet. \<\<DEPRECATED use API\_NINJAS\_GET\_FINANCIAL\_STATEMENT>>
>
> #### Input Parameters
>
> **cik** `string`
>
> Company Central Index Key (e.g., 796343). Supply exactly one of ticker or cik.
>
> **year** `integer`
>
> Fiscal year. E.g. 2025 . Must be a valid year after 2000. For historical data before 2025 , you must have a premium subscription. If set, period must also be set.
>
> **period** `string ("q1" | "q2" | "q3" | "q4" | "fy")`
>
> Fiscal period. Must be one of: q1 , q2 , q3 , q4 , or fy (full year). If set, year must also be set.
>
> **ticker** `string`
>
> Company ticker symbol (e.g., ADBE). Supply exactly one of ticker or cik.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Bitcoin Price and Market Data
>
> **Slug:** `API_NINJAS_GET_BITCOIN_MARKET_DATA`
>
> Tool to retrieve the latest Bitcoin price and 24-hour market data. Use when you need real-time Bitcoin metrics in USD.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Bitcoin Price History
>
> **Slug:** `API_NINJAS_GET_BITCOIN_PRICE_HISTORY`
>
> Deprecated Bitcoin-only history tool. Use API\_NINJAS\_GET\_CRYPTO\_PRICE\_HISTORY with symbol=BTCUSD. Requires Premium only. \<\<DEPRECATED use API\_NINJAS\_GET\_CRYPTO\_PRICE\_HISTORY>>
>
> #### Input Parameters
>
> **end** `integer`
>
> End timestamp in Unix format (in seconds). If not provided, defaults to current time.
>
> **limit** `integer`
>
> Maximum number of data points to return. Default is 100, maximum is 1000.
>
> **start** `integer`
>
> Start timestamp in Unix format (in seconds). If not provided, the most recent limit data points are returned.
>
> **interval** `string ("1m" | "5m" | "15m" | "30m" | "1h" | "4h" | "1d")`
>
> Time interval between data points. Valid values are: 1m , 5m , 15m , 30m , 1h , 4h , 1d . Default is 5m .
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Random Bucket List Idea
>
> **Slug:** `API_NINJAS_GET_BUCKETLIST`
>
> Tool to retrieve a random bucket list idea or activity. Use when you need inspiration for bucket list items or life goals.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** \$0.059 per 100 API requests
>
> **Discount:** 95
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Car Facets
>
> **Slug:** `API_NINJAS_GET_CAR_FACETS`
>
> Return grouped value counts for up to six caller-selected car dimensions; use LIST\_CAR\_MAKES, LIST\_CAR\_MODELS, or LIST\_CAR\_GENERATIONS for catalog listings.
>
> #### Input Parameters
>
> **body** `string`
>
> Narrow counts to one body style.
>
> **fuel** `string`
>
> Narrow counts to one fuel type.
>
> **make** `string`
>
> Narrow counts to one manufacturer.
>
> **year** `integer`
>
> Narrow counts to one production year.
>
> **drive** `string`
>
> Narrow counts to one drive type.
>
> **model** `string`
>
> Narrow counts to one model.
>
> **facets** `array` *required*
>
> Dimensions to group and count, from make, model, generation, chassis\_code, body, doors, fuel, transmission, drive, cylinders, year, or badge.
>
> **generation** `string`
>
> Narrow counts to one generation.
>
> **transmission** `string`
>
> Narrow counts to one transmission.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Car Specifications
>
> **Slug:** `API_NINJAS_GET_CARS`
>
> Query current car specifications by identity or documented filters. Requires Premium only.
>
> #### Input Parameters
>
> **id** `string`
>
> A stable car handle. Mutually exclusive with ids. At least one identity or filter field is required.
>
> **ids** `string`
>
> Comma-separated stable car handles, at most 50. Mutually exclusive with id. At least one identity or filter field is required.
>
> **body** `string ("Sedan" | "Coupe" | "Convertible" | "Wagon" | "Hatchback" | "Liftback" | "SUV" | "MPV" | "Van" | "Pickup")`
>
> Body style.
>
> **fuel** `string ("gasoline" | "diesel" | "electric" | "hybrid" | "plugin_hybrid" | "lpg" | "cng" | "hydrogen" | "ethanol")`
>
> Fuel type.
>
> **make** `string`
>
> Manufacturer name.
>
> **sort** `string ("power_hp" | "-power_hp" | "year" | "-year" | "name" | "make")`
>
> Result ordering.
>
> **year** `integer`
>
> Production year.
>
> **badge** `string`
>
> Model designation.
>
> **doors** `integer`
>
> Number of doors.
>
> **drive** `string ("fwd" | "rwd" | "awd" | "4wd")`
>
> Drive type.
>
> **limit** `integer`
>
> Results to return.
>
> **model** `string`
>
> Model name.
>
> **offset** `integer`
>
> Results to skip.
>
> **max\_year** `integer`
>
> Maximum production year.
>
> **min\_year** `integer`
>
> Minimum production year.
>
> **cylinders** `integer`
>
> Number of cylinders.
>
> **fuel\_type** `string ("gas" | "diesel" | "electricity")`
>
> Legacy fuel filter. Used as-is with MPG filters; otherwise gas maps to gasoline and electricity maps to electric.
>
> **generation** `string`
>
> Vehicle generation.
>
> **engine\_code** `string`
>
> Manufacturer engine code.
>
> **max\_hwy\_mpg** `integer`
>
> Legacy maximum highway-MPG filter. Supplying it uses the v1 Cars API.
>
> **min\_hwy\_mpg** `integer`
>
> Legacy minimum highway-MPG filter. Supplying it uses the v1 Cars API.
>
> **chassis\_code** `string`
>
> Chassis code.
>
> **max\_city\_mpg** `integer`
>
> Legacy maximum city-MPG filter. Supplying it uses the v1 Cars API.
>
> **max\_power\_hp** `number`
>
> Maximum horsepower.
>
> **min\_city\_mpg** `integer`
>
> Legacy minimum city-MPG filter. Supplying it uses the v1 Cars API.
>
> **min\_power\_hp** `number`
>
> Minimum horsepower.
>
> **transmission** `string ("manual" | "automatic" | "cvt" | "dual_clutch" | "automated_manual" | "single_speed" | "a" | "m")`
>
> Transmission type. Legacy aliases a and m map to automatic and manual.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Cash Flow
>
> **Slug:** `API_NINJAS_GET_CASH_FLOW`
>
> Deprecated compatibility tool for cash-flow statements. Use API\_NINJAS\_GET\_FINANCIAL\_STATEMENT with statement\_type=cash\_flow. \<\<DEPRECATED use API\_NINJAS\_GET\_FINANCIAL\_STATEMENT>>
>
> #### Input Parameters
>
> **cik** `string`
>
> Company Central Index Key (e.g., 796343). Supply exactly one of ticker or cik.
>
> **year** `integer`
>
> Fiscal year. E.g. 2025 . Must be a valid year after 2000. For historical data before 2025 , you must have a premium subscription. If set, period must also be set.
>
> **period** `string ("q1" | "q2" | "q3" | "q4" | "fy")`
>
> Fiscal period. Must be one of: q1 , q2 , q3 , q4 , or fy (full year). If set, year must also be set.
>
> **ticker** `string`
>
> Company ticker symbol (e.g., ADBE). Supply exactly one of ticker or cik.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Cat Breed Information
>
> **Slug:** `API_NINJAS_GET_CATS`
>
> Tool to retrieve information on cat breeds matching specified parameters. Use when you need to search for cat breeds by characteristics such as name, weight, life expectancy, shedding level, playfulness, grooming needs, or friendliness with family and other pets.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** \$0.059 per 100 API requests
>
> **Discount:** 95
>
> #### Input Parameters
>
> **name** `string`
>
> Cat breed name to search for (e.g., 'persian', 'siamese'). Partial matches are supported.
>
> **offset** `integer`
>
> Number of results to offset for pagination. Use this to paginate through results by setting offset to multiples of the result limit (e.g., 0, 20, 40).
>
> **grooming** `integer`
>
> Grooming needs on a scale of 1-5, where 1 requires maximum grooming effort and 5 requires minimum grooming effort.
>
> **shedding** `integer`
>
> Shedding level on a scale of 1-5, where 1 is minimal shedding and 5 is heavy shedding.
>
> **max\_weight** `integer`
>
> Maximum weight in pounds. Must be greater than min\_weight if both are specified.
>
> **min\_weight** `integer`
>
> Minimum weight in pounds. Must be less than max\_weight if both are specified.
>
> **playfulness** `integer`
>
> Playfulness level on a scale of 1-5, where 1 is less playful and 5 is very playful.
>
> **family\_friendly** `integer`
>
> Family friendliness level on a scale of 1-5, where 1 is less family-friendly and 5 is very family-friendly.
>
> **max\_life\_expectancy** `integer`
>
> Maximum life expectancy in years. Must be greater than min\_life\_expectancy if both are specified.
>
> **min\_life\_expectancy** `integer`
>
> Minimum life expectancy in years. Must be less than max\_life\_expectancy if both are specified.
>
> **other\_pets\_friendly** `integer`
>
> Pet friendliness level on a scale of 1-5, where 1 is less friendly with other pets and 5 is very friendly with other pets.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Celebrity Information
>
> **Slug:** `API_NINJAS_GET_CELEBRITY`
>
> Tool to search for celebrity information by name or other criteria. Returns details including net worth, height, birthday, nationality, and occupation. Use when you need to find information about famous people, filter celebrities by attributes like net worth or nationality, or gather biographical data.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** \$0.059 per 100 API requests
>
> **Discount:** 95
>
> #### Input Parameters
>
> **name** `string`
>
> Name of the celebrity you wish to search. This field is case-insensitive.
>
> **offset** `integer`
>
> Number of results to offset for pagination.
>
> **max\_height** `number`
>
> Maximum height of celebrities in meters.
>
> **min\_height** `number`
>
> Minimum height of celebrities in meters.
>
> **nationality** `string`
>
> Nationality of celebrities. Must be an ISO 3166 Alpha-2 country code (e.g., US, GB, FR).
>
> **max\_net\_worth** `integer`
>
> Maximum net worth of celebrities in US dollars.
>
> **min\_net\_worth** `integer`
>
> Minimum net worth of celebrities in US dollars.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Chuck Norris Joke
>
> **Slug:** `API_NINJAS_GET_CHUCK_NORRIS_JOKE`
>
> Tool to retrieve a random Chuck Norris joke from the API Ninjas database. Use when you need humorous Chuck Norris content.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** \$0.059 per 100 API requests
>
> **Discount:** 95
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get City Information
>
> **Slug:** `API_NINJAS_GET_CITY`
>
> Tool to retrieve city information by name, country, coordinates, or population filters. Use when you need geographic data about cities including coordinates, population, and capital status. At least one search parameter is required.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** \$0.059 per 100 API requests
>
> **Discount:** 95
>
> #### Input Parameters
>
> **name** `string`
>
> City name to search for (e.g., 'London', 'New York').
>
> **limit** `integer`
>
> Number of results to return per request (range: 1-30). Premium feature only.
>
> **offset** `integer`
>
> Pagination offset to skip the first N results.
>
> **country** `string`
>
> ISO-3166 alpha-2 country code to filter cities (e.g., 'US', 'GB', 'JP').
>
> **max\_lat** `number`
>
> Maximum latitude coordinate for geographic filtering (range: -90 to 90).
>
> **max\_lon** `number`
>
> Maximum longitude coordinate for geographic filtering (range: -180 to 180).
>
> **min\_lat** `number`
>
> Minimum latitude coordinate for geographic filtering (range: -90 to 90).
>
> **min\_lon** `number`
>
> Minimum longitude coordinate for geographic filtering (range: -180 to 180).
>
> **max\_population** `integer`
>
> Maximum population count for filtering cities.
>
> **min\_population** `integer`
>
> Minimum population count for filtering cities.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Cocktail Recipes
>
> **Slug:** `API_NINJAS_GET_COCKTAIL`
>
> Tool to search for cocktail recipes by name or ingredients. Returns up to 10 cocktail recipes with ingredients and preparation instructions. Use when you need cocktail recipes, drink mixing instructions, or want to find drinks by specific ingredients.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** \$0.059 per 100 API requests
>
> **Discount:** 95
>
> #### Input Parameters
>
> **name** `string`
>
> Cocktail name to search for. At least one of name or ingredients is required. Supports partial matches (e.g., 'marg' matches 'Margarita'). Case-insensitive.
>
> **ingredients** `string`
>
> Comma-separated ingredients to search for. At least one of name or ingredients is required. Uses AND logic and is case-insensitive.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Commodity Contract
>
> **Slug:** `API_NINJAS_GET_COMMODITY_CONTRACT`
>
> Return one contract by exact symbol, or all matching contracts by root symbol. Requires Business tier and above, or any annual plan.
>
> #### Input Parameters
>
> **symbol** `string`
>
> Specific contract symbol to look up (e.g., GCK26). Supply exactly one of symbol or symbol\_root.
>
> **symbol\_root** `string`
>
> Commodity root to filter contracts (e.g., GC returns GCK26 and GCM26). Supply exactly one of symbol or symbol\_root.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Commodity Forward Curve
>
> **Slug:** `API_NINJAS_GET_COMMODITY_FORWARD_CURVE`
>
> Return every active futures contract, sorted by month, for one commodity forward curve. Requires Business tier and above, or any annual plan.
>
> #### Input Parameters
>
> **name** `string ("gold" | "silver" | "platinum" | "palladium" | "micro_gold" | "micro_silver" | "copper" | "aluminum" | "crude_oil" | "brent_crude_oil" | "natural_gas" | "heating_oil" | "gasoline_rbob" | "corn" | "wheat" | "soybean" | "soybean_oil" | "soybean_meal" | "oat" | "rough_rice" | "coffee" | "sugar" | "cocoa" | "cotton" | "orange_juice" | "lumber" | "lean_hogs" | "live_cattle" | "feeder_cattle" | "class_3_milk")` *required*
>
> Commodity value, using the same set as the /v1/commodityprice name parameter (e.g., crude\_oil , gold , corn ).
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Commodity Market Snapshot
>
> **Slug:** `API_NINJAS_GET_COMMODITY_MARKET_SNAPSHOT`
>
> Return a current commodity market snapshot across supported contracts.
>
> #### Input Parameters
>
> **category** `string ("precious_metals" | "base_metals" | "energy" | "grains" | "softs" | "livestock")`
>
> Filter to a single product category. One of precious\_metals , base\_metals , energy , grains , softs , livestock .
>
> **exchange** `string ("CME" | "NYMEX" | "COMEX" | "ICE")`
>
> Filter to commodities listed on a single exchange. One of CME , NYMEX , COMEX , ICE .
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Commodity Price
>
> **Slug:** `API_NINJAS_GET_COMMODITY_PRICE`
>
> Get real-time commodity prices from major exchanges (CME, NYMEX, COMEX). Prices are based on rolling futures contracts in USD. Free tier has limited commodities that rotate weekly. Use snake\_case for commodity names (e.g., 'micro\_gold', 'natural\_gas'). Example: "What is the current price of natural gas?"
>
> #### Input Parameters
>
> **name** `string` *required*
>
> Name of the commodity to fetch price for. Use snake\_case format. Free tier commodities rotate weekly. Common free tier options include: micro\_gold, micro\_silver, natural\_gas, heating\_oil, lumber, lean\_hogs, live\_cattle. Premium commodities (require paid plan): gold, silver, crude\_oil, corn, wheat, platinum, copper, coffee, sugar, cotton, soybeans, etc.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Commodity Price History
>
> **Slug:** `API_NINJAS_GET_COMMODITY_PRICE_HISTORY`
>
> Return historical commodity futures OHLCV prices without silently accepting a provider-truncated series. Requires Premium only.
>
> #### Input Parameters
>
> **end** `integer`
>
> End time as a Unix timestamp in seconds. Defaults to the current time. With only one bound, a 1,000-point response is rejected because completeness cannot be determined.
>
> **name** `string ("gold" | "silver" | "platinum" | "palladium" | "micro_gold" | "micro_silver" | "copper" | "aluminum" | "crude_oil" | "brent_crude_oil" | "natural_gas" | "heating_oil" | "gasoline_rbob" | "corn" | "wheat" | "soybean" | "soybean_oil" | "soybean_meal" | "oat" | "rough_rice" | "coffee" | "sugar" | "cocoa" | "cotton" | "orange_juice" | "lumber" | "lean_hogs" | "live_cattle" | "feeder_cattle" | "class_3_milk")` *required*
>
> Commodity name; uses the values supported by /v1/commodityprice.
>
> **start** `integer`
>
> Inclusive start time as a Unix timestamp in seconds. Defaults to 24 hours ago. With only one bound, a 1,000-point response is rejected because completeness cannot be determined.
>
> **period** `string ("1m" | "5m" | "15m" | "30m" | "1h" | "4h" | "1d")`
>
> Interval between points. The provider returns at most 1,000 points; use a larger interval or narrower range when necessary.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Commodity Spot Price
>
> **Slug:** `API_NINJAS_GET_COMMODITY_SPOT_PRICE`
>
> Return one immediate-delivery spot price with name, or a batch array with comma-separated names (batch requires Business tier and above). Use futures-price tools for commodities without a public spot market. Requires Premium only.
>
> #### Input Parameters
>
> **name** `string ("gold" | "silver" | "platinum" | "palladium" | "crude_oil" | "wti" | "brent_crude_oil" | "brent" | "natural_gas" | "gasoline_rbob" | "gasoline" | "heating_oil" | "diesel")`
>
> One commodity name. Supply exactly one of name or names. Values: gold, silver, platinum, palladium, crude\_oil (or wti), brent\_crude\_oil (or brent), natural\_gas, gasoline\_rbob (or gasoline), or heating\_oil (or diesel).
>
> **unit** `string ("troy_ounce" | "lb" | "kg" | "g" | "oz" | "metric_ton" | "short_ton" | "hundredweight" | "barrel" | "gallon" | "liter" | "cubic_meter" | "MMBtu" | "MWh" | "GJ" | "therm")`
>
> Compatible target unit. Mass: troy\_ounce, lb, kg, g, oz, metric\_ton, short\_ton, hundredweight. Volume: barrel, gallon, liter, cubic\_meter. Energy: MMBtu, MWh, GJ, therm.
>
> **names** `string`
>
> Comma-separated commodities for a batch request. Supply exactly one of name or names. Values: gold, silver, platinum, palladium, crude\_oil or wti, brent\_crude\_oil or brent, natural\_gas, gasoline\_rbob or gasoline, and heating\_oil or diesel. Requires Business tier and above.
>
> **currency** `string`
>
> ISO 4217 currency code to convert prices into (e.g. EUR , GBP ). Defaults to USD.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Company Logo
>
> **Slug:** `API_NINJAS_GET_COMPANY_LOGO`
>
> Retrieve a company logo URL by company name or ticker symbol. When multiple results are returned, only the first is returned.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** \$0.059 per 100 API requests
>
> **Discount:** 95
>
> #### Input Parameters
>
> **name** `string`
>
> Company name that supports partial matching (case-insensitive). Either name or ticker is required.
>
> **ticker** `string`
>
> Company ticker symbol for publicly traded companies. Either name or ticker is required.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Company Profile
>
> **Slug:** `API_NINJAS_GET_COMPANY_PROFILE`
>
> Retrieve company profile information for a publicly traded company by stock ticker symbol. Returns executive details, financial metrics, identifiers (CIK, CUSIP, ISIN), exchange, contact information, stock price, market cap, and latest earnings data. Use when you need detailed company information for a specific ticker.
>
> #### Input Parameters
>
> **ticker** `string` *required*
>
> Stock ticker symbol (e.g., 'AAPL', 'MSFT', 'GOOGL')
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get and Increment Counter
>
> **Slug:** `API_NINJAS_GET_COUNTER`
>
> Deprecated compatibility tool that reads, increments, or sets persistent API-key-scoped counter state. Use GET\_COUNTER\_VALUE for reads or UPDATE\_COUNTER for mutations. \<\<DEPRECATED use API\_NINJAS\_GET\_COUNTER\_VALUE or API\_NINJAS\_UPDATE\_COUNTER>>
>
> #### Input Parameters
>
> **id** `string` *required*
>
> ID to specify the counter. Use a new id to create a new counter.
>
> **hit** `boolean`
>
> Increments counter by 1 when set to true. If false or not provided, counter is not incremented.
>
> **value** `integer`
>
> Sets counter to specific value. Use 0 to reset the counter. If provided, this overrides the 'hit' parameter.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Counter Value
>
> **Slug:** `API_NINJAS_GET_COUNTER_VALUE`
>
> Read the current value of a persistent counter scoped to the connected API key without incrementing or setting it.
>
> #### Input Parameters
>
> **id** `string` *required*
>
> Identifier of an existing counter in persistent state scoped to the connected API key.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Country Flag SVG
>
> **Slug:** `API_NINJAS_GET_COUNTRY_FLAG`
>
> Tool to retrieve country flag images in SVG format. Use when you need flag URLs for display or download.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** \$0.059 per 100 API requests
>
> **Discount:** 95
>
> #### Input Parameters
>
> **country** `string` *required*
>
> ISO 3166-1 alpha-2 country code (e.g., US, CA, GB). UK regional codes GB-ENG, GB-SCT, GB-WLS and GB-NIR are also supported. Country names are not supported.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Country Information
>
> **Slug:** `API_NINJAS_GET_COUNTRY_INFO`
>
> Tool to retrieve country information by name, ISO code, or economic and demographic filters. Use to retrieve country population, GDP, surface area, unemployment, fertility, and related statistics.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** \$0.059 per 100 API requests
>
> **Discount:** 95
>
> #### Input Parameters
>
> **name** `string`
>
> Plain English name, 2-letter ISO-3166 alpha-2 (e.g., 'US'), or 3-letter ISO-3166 alpha-3 (e.g., 'USA') code of country.
>
> **limit** `integer`
>
> How many results to return. Must be between 1 and 30. Default is 5.
>
> **max\_gdp** `number`
>
> Maximum gross domestic product (GDP) of country, in US Dollars.
>
> **min\_gdp** `number`
>
> Minimum gross domestic product (GDP) of country, in US Dollars.
>
> **max\_fertility** `number`
>
> Maximum fertility rate, in average children per woman.
>
> **min\_fertility** `number`
>
> Minimum fertility rate, in average children per woman.
>
> **max\_gdp\_growth** `number`
>
> Maximum GDP growth rate in %.
>
> **max\_population** `integer`
>
> Maximum population of country, in thousands.
>
> **min\_gdp\_growth** `number`
>
> Minimum GDP growth rate in %.
>
> **min\_population** `integer`
>
> Minimum population of country, in thousands.
>
> **max\_surface\_area** `number`
>
> Maximum surface area of country in km2.
>
> **max\_unemployment** `number`
>
> Maximum unemployment rate in %.
>
> **min\_surface\_area** `number`
>
> Minimum surface area of country in km2.
>
> **min\_unemployment** `number`
>
> Minimum unemployment rate in %.
>
> **max\_infant\_mortality** `number`
>
> Maximum infant mortality rate per 1,000 live births.
>
> **min\_infant\_mortality** `number`
>
> Minimum infant mortality rate per 1,000 live births.
>
> **max\_urban\_population\_rate** `number`
>
> Maximum urban population rate in %.
>
> **min\_urban\_population\_rate** `number`
>
> Minimum urban population rate in %.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get County Information
>
> **Slug:** `API_NINJAS_GET_COUNTY`
>
> Tool to retrieve US county information by name, ZIP code, or state. Use when you need geographic, demographic, or administrative data about US counties. Returns county name, FIPS code, location coordinates, timezone, population, and median age.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** \$0.059 per 100 API requests
>
> **Discount:** 95
>
> #### Input Parameters
>
> **limit** `integer`
>
> Number of results to return. Must be between 1 and 30. Default is 1. Premium only.
>
> **state** `string`
>
> 2-letter state code (e.g., 'CA', 'OR', 'NY'). At least one of county, zipcode, or state must be provided.
>
> **county** `string`
>
> Full county name (e.g., 'Los Angeles County', 'Multnomah County'). At least one of county, zipcode, or state must be provided.
>
> **offset** `integer`
>
> Number of results to offset for pagination. Default is 0. Premium only.
>
> **zipcode** `string`
>
> 5-digit ZIP code to search for county information. At least one of county, zipcode, or state must be provided.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get COVID 19 Data
>
> **Slug:** `API_NINJAS_GET_COVID19_DATA`
>
> Return COVID-19 case or death statistics for a country or date.
>
> #### Input Parameters
>
> **date** `string`
>
> Date for a single-day snapshot in YYYY-MM-DD format. At least one of date or country is required.
>
> **type** `string ("cases" | "deaths")`
>
> Metric to retrieve. Defaults to cases.
>
> **county** `string`
>
> US county name. Requires country=United States and a region.
>
> **region** `string`
>
> Administrative region. Requires country; omitting it returns every region available for that country.
>
> **country** `string`
>
> Country name (case-insensitive). At least one of date or country is required.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Crypto Price
>
> **Slug:** `API_NINJAS_GET_CRYPTO_PRICE`
>
> Get the current real-time price for a cryptocurrency trading pair. Returns the latest price and timestamp for symbols like BTCUSDT (Bitcoin to USD), ETHUSDT (Ethereum to USD), or crypto-to-crypto pairs like LTCBTC (Litecoin to Bitcoin). Use this to check current cryptocurrency market prices.
>
> #### Input Parameters
>
> **symbol** `string` *required*
>
> Cryptocurrency trading pair symbol. Common formats include crypto-to-USD pairs like 'BTCUSDT', 'ETHUSDT', 'XRPUSDT', 'DOGEUSDT', or crypto-to-crypto pairs like 'LTCBTC', 'ETHBTC'. Case-insensitive.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Crypto Price History
>
> **Slug:** `API_NINJAS_GET_CRYPTO_PRICE_HISTORY`
>
> Return historical cryptocurrency OHLCV prices for a symbol and interval. Requires Premium only.
>
> #### Input Parameters
>
> **end** `integer`
>
> End timestamp in Unix format (in seconds). If not provided, defaults to current time.
>
> **limit** `integer`
>
> Maximum number of data points to return. Default is 100, maximum is 1000.
>
> **start** `integer`
>
> Start timestamp in Unix format (in seconds). If not provided, defaults to 24 hours ago.
>
> **symbol** `string` *required*
>
> Cryptocurrency symbol (e.g. ETHUSDT , BTCUSD ). Crypto-quoted and USD-quoted symbols only; other fiat quotes are not available on this endpoint.
>
> **interval** `string ("1m" | "5m" | "15m" | "30m" | "1h" | "4h" | "1d")`
>
> Time interval between data points. Valid values are: 1m , 5m , 15m , 30m , 1h , 4h , 1d . Default is 1h .
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Currency Volatility History
>
> **Slug:** `API_NINJAS_GET_CURRENCY_VOLATILITY_HISTORY`
>
> Return historical realized-volatility observations for a currency pair. Requires Premium only.
>
> #### Input Parameters
>
> **days** `integer`
>
> Length of the trailing date range in calendar days, ending today. Defaults to 90 . Maximum 1825. Mutually exclusive with start\_date / end\_date .
>
> **pair** `string` *required*
>
> Currency pair to query, in the form currency1\_currency2 (e.g. EUR\_USD ).
>
> **method** `string ("close_to_close" | "ewma")`
>
> Volatility method: close\_to\_close (default) or ewma .
>
> **window** `integer`
>
> Rolling window for volatility, in trading days. Defaults to 30 .
>
> **end\_date** `string`
>
> End of the date range, in YYYY-MM-DD form. Provide together with start\_date .
>
> **day\_count** `integer ("252" | "365")`
>
> Annualization factor: 252 trading days (default) or 365 calendar days.
>
> **annualized** `boolean`
>
> Whether to treat the annualized figure as the headline value. Defaults to true .
>
> **start\_date** `string`
>
> Start of an explicit date range, in YYYY-MM-DD form. Provide together with end\_date instead of days . The range cannot exceed 1825 days.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Random Dad Jokes
>
> **Slug:** `API_NINJAS_GET_DAD_JOKE`
>
> Tool to retrieve random dad jokes from API Ninjas. Returns one or more dad jokes suitable for light humor. Use when you need clean, family-friendly jokes.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** \$0.059 per 100 API requests
>
> **Discount:** 95
>
> #### Input Parameters
>
> **limit** `integer`
>
> How many jokes to return. Must be between 1 and 100. Default is 1. Note: Values greater than 1 require a premium API Ninjas subscription.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Day in History Events
>
> **Slug:** `API_NINJAS_GET_DAY_IN_HISTORY`
>
> Tool to get historical events for a specific date. Use when you need to retrieve events that occurred on a particular day in history. Returns events for today's date if no parameters are provided.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** \$0.059 per 100 API requests
>
> **Discount:** 95
>
> #### Input Parameters
>
> **day** `integer`
>
> The day of the month for the historical events to retrieve. Must be between 1 and 31. If specified, month must also be provided. Premium subscription required to specify custom dates.
>
> **limit** `integer`
>
> The maximum number of results to return. Must be between 1 and 30. Default is 1.
>
> **month** `integer`
>
> The month of the historical events to retrieve. Must be between 1 and 12. If specified, day must also be provided. Premium subscription required to specify custom dates.
>
> **offset** `integer`
>
> The number of results to skip. Must be zero or a positive integer. Used for pagination. Default is 0.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Dictionary Definition
>
> **Slug:** `API_NINJAS_GET_DICTIONARY_DEFINITION`
>
> Tool to retrieve dictionary definition for an English word. Use when you need the meaning or definition of a word.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** \$0.059 per 100 API requests
>
> **Discount:** 95
>
> #### Input Parameters
>
> **word** `string` *required*
>
> Word to look up in the dictionary. Must be a valid English word.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Dog Breed Information
>
> **Slug:** `API_NINJAS_GET_DOGS`
>
> Tool to get information on dog breeds matching specified parameters. Use when you need breed characteristics like temperament, size, life expectancy, or other traits.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** \$0.059 per 100 API requests
>
> **Discount:** 95
>
> #### Input Parameters
>
> **name** `string`
>
> Dog breed name to search for (e.g., 'husky', 'labrador').
>
> **energy** `integer`
>
> Energy level (1-5, where 1 is lowest and 5 is highest).
>
> **offset** `integer`
>
> Number of results to offset for pagination. Use this to paginate through results by setting offset to multiples of the result limit (e.g., 0, 20, 40).
>
> **barking** `integer`
>
> Barking level (1-5, where 1 is lowest and 5 is highest).
>
> **shedding** `integer`
>
> Shedding level (1-5, where 1 is lowest and 5 is highest).
>
> **max\_height** `integer`
>
> Maximum height in inches.
>
> **max\_weight** `integer`
>
> Maximum weight in pounds.
>
> **min\_height** `integer`
>
> Minimum height in inches.
>
> **min\_weight** `integer`
>
> Minimum weight in pounds.
>
> **trainability** `integer`
>
> Trainability level (1-5, where 1 is lowest and 5 is highest).
>
> **protectiveness** `integer`
>
> Protectiveness level (1-5, where 1 is lowest and 5 is highest).
>
> **max\_life\_expectancy** `integer`
>
> Maximum life expectancy in years.
>
> **min\_life\_expectancy** `integer`
>
> Minimum life expectancy in years.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Earnings
>
> **Slug:** `API_NINJAS_GET_EARNINGS`
>
> Retrieve earnings filings by company or filing date, optionally filtering a company by fiscal period and year.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** \$0.059 per 100 API requests
>
> **Discount:** 95
>
> #### Input Parameters
>
> **cik** `string`
>
> Company Central Index Key. Mutually exclusive with ticker. Supply a company identifier, date, or complete date range.
>
> **date** `string`
>
> Exact filing date in YYYY-MM-DD format. Mutually exclusive with date\_start/date\_end; supply a company identifier, date, or complete date range.
>
> **year** `integer`
>
> Fiscal year. Required with period or quarter, which also require a company identifier. Free users are limited to 2026; Premium covers the last 5 fiscal years; Business tier and above provides full history.
>
> **offset** `integer`
>
> Results to skip; pages contain 50.
>
> **period** `string ("q1" | "q2" | "q3" | "q4" | "fy")`
>
> Fiscal period. Mutually exclusive with quarter and requires a company identifier and year.
>
> **ticker** `string`
>
> Company ticker symbol. Mutually exclusive with cik. Supply a company identifier, date, or complete date range.
>
> **quarter** `string ("1" | "2" | "3" | "4")`
>
> Fiscal quarter. Mutually exclusive with period and requires a company identifier and year.
>
> **date\_end** `string`
>
> Range end in YYYY-MM-DD format. Requires date\_start and is mutually exclusive with date; supply a company identifier, date, or complete date range.
>
> **date\_start** `string`
>
> Range start in YYYY-MM-DD format. Requires date\_end and is mutually exclusive with date; supply a company identifier, date, or complete date range.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Earnings Calendar
>
> **Slug:** `API_NINJAS_GET_EARNINGS_CALENDAR`
>
> Returns historical actual and estimated EPS and revenue by stock ticker, with an option for premium subscribers to include upcoming scheduled earnings dates.
>
> #### Input Parameters
>
> **limit** `integer`
>
> Maximum number of earnings records to return (1-100). Premium subscribers only.
>
> **ticker** `string` *required*
>
> Stock ticker symbol to get earnings data for (e.g., 'AAPL', 'MSFT', 'GOOGL').
>
> **show\_upcoming** `boolean`
>
> Whether to include upcoming/scheduled earnings dates in addition to past earnings. Defaults to false. Premium subscribers only.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Earnings Call Transcript
>
> **Slug:** `API_NINJAS_GET_EARNINGS_CALL_TRANSCRIPT`
>
> Retrieve the full earnings call transcript for a publicly traded company. Use this tool when you need to analyze what was discussed during a company's quarterly earnings call, including management commentary, Q\&A with analysts, financial guidance, and strategic updates. Note: This endpoint requires a premium API Ninjas subscription. Example use cases: - Analyze management sentiment during earnings calls - Extract forward guidance and projections - Review analyst questions and company responses - Compare earnings call content across quarters
>
> #### Input Parameters
>
> **cik** `string`
>
> Company Central Index Key (CIK), a unique identifier assigned by the SEC (e.g., '320193' for Apple Inc.). Either ticker or cik must be provided.
>
> **year** `integer`
>
> Fiscal year of the earnings call (e.g., 2024). If omitted along with quarter, returns the most recent transcript. Must be between 2000 and the current year.
>
> **ticker** `string`
>
> Company stock ticker symbol (e.g., 'AAPL' for Apple Inc.). Either ticker or cik must be provided.
>
> **quarter** `integer ("1" | "2" | "3" | "4")`
>
> Fiscal quarter of the earnings call (1=Q1, 2=Q2, 3=Q3, 4=Q4). If omitted along with year, returns the most recent transcript.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Electric Vehicle Info
>
> **Slug:** `API_NINJAS_GET_ELECTRIC_VEHICLE_INFO`
>
> Get electric vehicle information by make, model, year range, or electric range. Returns details including battery capacity, charging power, dimensions, and performance specs. At least one filter parameter (make, model, min\_year, max\_year, min\_range, or max\_range) is required - limit and offset alone are not sufficient.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** \$0.059 per 100 API requests
>
> **Discount:** 95
>
> #### Input Parameters
>
> **make** `string`
>
> Vehicle manufacturer (e.g., 'tesla', 'nissan', 'chevrolet'). Case-insensitive.
>
> **limit** `integer`
>
> How many results to return. Must be between 1 and 10. Default is 1.
>
> **model** `string`
>
> Vehicle model (e.g., 'model3', 'leaf', 'bolt'). Case-insensitive.
>
> **offset** `integer`
>
> Number of results to skip for pagination. Default is 0.
>
> **max\_year** `integer`
>
> Maximum vehicle model year (e.g., 2023). Filter results to vehicles up to this year.
>
> **min\_year** `integer`
>
> Minimum vehicle model year (e.g., 2020). Filter results to vehicles from this year onwards.
>
> **max\_range** `integer`
>
> Maximum electric range in kilometers (e.g., 600). Filter results to vehicles with at most this range.
>
> **min\_range** `integer`
>
> Minimum electric range in kilometers (e.g., 250). Filter results to vehicles with at least this range.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Emoji Information
>
> **Slug:** `API_NINJAS_GET_EMOJI`
>
> Tool to retrieve emoji information and images from the API Ninjas Emoji database. Use when you need emoji metadata, Unicode codes, or emoji images based on name, code, category, or subcategory. At least one search parameter (name, code, group, or subgroup) must be provided. Returns up to 30 results per request; use offset for pagination.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** \$0.059 per 100 API requests
>
> **Discount:** 95
>
> #### Input Parameters
>
> **code** `string`
>
> Unicode character code for the emoji (e.g., 'U+1F642'). Must be uppercase with U+ prefix.
>
> **name** `string`
>
> Descriptive name of emoji to search for (e.g., 'smile', 'heart').
>
> **group** `string ("smileys_emotion" | "people_body" | "component" | "animals_nature" | "food_drink" | "travel_places" | "activities" | "objects" | "symbols" | "flags")`
>
> Main category to filter emojis. Valid categories: smileys\_emotion, people\_body, component, animals\_nature, food\_drink, travel\_places, activities, objects, symbols, flags.
>
> **offset** `integer`
>
> Number of results to offset for pagination. Use this to retrieve results beyond the first 30. Default is 0.
>
> **subgroup** `string`
>
> Sub-category to filter emojis within a group. The subgroup must be valid for the selected group.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get ETF Info
>
> **Slug:** `API_NINJAS_GET_ETF_INFO`
>
> Retrieve ETF information by ticker, including its name, ISIN, CUSIP, and country. Expense ratio, AUM, holdings, and number of holdings require a premium subscription and may be null for free-tier users; holdings are limited to the first 10.
>
> #### Input Parameters
>
> **ticker** `string` *required*
>
> ETF ticker symbol. Case-insensitive. Examples: 'SPY' (S\&P 500), 'QQQ' (NASDAQ-100), 'VTI' (Total Stock Market), 'BND' (Bond Market).
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get EU VAT Rates
>
> **Slug:** `API_NINJAS_GET_EU_VAT_RATES`
>
> Retrieve current or historical EU VAT rates by country, with optional VAT type and effective-date filters.
>
> #### Input Parameters
>
> **type** `string ("standard" | "reduced" | "super_reduced" | "exempted" | "parking")`
>
> Enumeration of VAT rate classifications.
>
> **limit** `integer`
>
> Number of results to return. Must be between 1 and 30. Default is 5. Premium accounts only.
>
> **offset** `integer`
>
> Number of results to skip for pagination. Default is 0. Use with limit to paginate through results. Premium accounts only.
>
> **country** `string` *required*
>
> Two-letter ISO 3166-1 alpha-2 country code for EU nations (e.g., 'FR' for France, 'DE' for Germany, 'NL' for Netherlands).
>
> **max\_date** `string`
>
> Filter results to only include VAT rates effective before this date. Must be in YYYY-MM-DD format (e.g., '2024-12-31').
>
> **min\_date** `string`
>
> Filter results to only include VAT rates effective after this date. Must be in YYYY-MM-DD format (e.g., '2020-01-01').
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Exchange Rate
>
> **Slug:** `API_NINJAS_GET_EXCHANGE_RATE`
>
> Get the current exchange rate for a currency pair. Returns the conversion rate from the first currency to the second currency. Use this to check current foreign exchange rates between any two currencies.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** \$0.059 per 100 API requests
>
> **Discount:** 95
>
> #### Input Parameters
>
> **pair** `string` *required*
>
> Currency pair in format CURRENCY1\_CURRENCY2 (e.g., 'GBP\_AUD', 'USD\_EUR', 'JPY\_USD'). Use underscore to separate the two currency codes.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Exchange Rate History
>
> **Slug:** `API_NINJAS_GET_EXCHANGE_RATE_HISTORY`
>
> Return historical exchange rates for a currency pair and date range. Requires Premium only.
>
> #### Input Parameters
>
> **date** `string`
>
> Single date to query, in YYYY-MM-DD format. Either date OR both start\_date and end\_date must be provided.
>
> **pair** `string` *required*
>
> Currency pair to query. Must be in the form of currency1\_currency2 (e.g. USD\_EUR ).
>
> **end\_date** `string`
>
> End date of a range query, in YYYY-MM-DD format. Date range cannot exceed 180 days.
>
> **start\_date** `string`
>
> Start date of a range query, in YYYY-MM-DD format. Must be used together with end\_date .
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Executive Compensation
>
> **Slug:** `API_NINJAS_GET_EXECUTIVE_COMPENSATION`
>
> Return disclosed executive compensation records for a public company.
>
> #### Input Parameters
>
> **cik** `string`
>
> The company's SEC Central Index Key, with or without leading zeros (for example 320193 or 0000320193). Exactly one of ticker, name, or cik is required.
>
> **name** `string`
>
> Company name to search for (for example Apple). Exactly one of ticker, name, or cik is required.
>
> **year** `integer`
>
> The 4-digit fiscal year to return (for example 2024 ). Defaults to the latest available year. Historical (non-latest) years are Premium only ; a year the company has no data for returns a no-data message.
>
> **ticker** `string`
>
> The company's stock ticker (for example AAPL). Exactly one of ticker, name, or cik is required.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Exercises
>
> **Slug:** `API_NINJAS_GET_EXERCISES`
>
> Tool to get exercise information by muscle group, type, or difficulty level. Returns up to 10 exercises that match the specified criteria. Use when you need to find exercises for specific muscle groups, workout types, or difficulty levels.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** \$0.059 per 100 API requests
>
> **Discount:** 95
>
> #### Input Parameters
>
> **name** `string`
>
> Name of the exercise to search for. Searches for exercises matching this name.
>
> **type** `string ("cardio" | "olympic_weightlifting" | "plyometrics" | "powerlifting" | "strength" | "stretching" | "strongman")`
>
> Exercise type categories
>
> **muscle** `string`
>
> Target muscle group to filter by. Common values include: abdominals, abductors, adductors, biceps, calves, chest, forearms, glutes, hamstrings, lats, lower\_back, middle\_back, neck, quadriceps, traps, triceps.
>
> **offset** `integer`
>
> Number of results to offset for pagination. Use this to paginate through results by setting offset to multiples of the result limit (e.g., 0, 10, 20).
>
> **difficulty** `string ("beginner" | "intermediate" | "expert")`
>
> Exercise difficulty levels
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Fact of the Day
>
> **Slug:** `API_NINJAS_GET_FACT_OF_THE_DAY`
>
> Tool to retrieve the fact of the day from API Ninjas. Returns the same fact for all users on a given day, with facts changing daily. Use when you need a daily interesting fact to display or share.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** \$0.059 per 100 API requests
>
> **Discount:** 95
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Random Facts
>
> **Slug:** `API_NINJAS_GET_FACTS`
>
> Tool to retrieve random interesting facts from API Ninjas. Returns facts about science, literature, philosophy, and other topics. Use when you need interesting factual information to display or share.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** \$0.059 per 100 API requests
>
> **Discount:** 95
>
> #### Input Parameters
>
> **limit** `integer`
>
> Number of facts to return. Must be between 1 and 100. Default is 1. Note: Requesting more than 1 fact requires a premium API Ninjas subscription.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Financial Statement
>
> **Slug:** `API_NINJAS_GET_FINANCIAL_STATEMENT`
>
> Retrieve one balance sheet, cash-flow statement, or income statement and its SEC filing metadata for a company and fiscal period.
>
> #### Input Parameters
>
> **cik** `string`
>
> Company SEC Central Index Key, such as 796343. Exactly one of ticker or cik is required.
>
> **year** `integer`
>
> Fiscal year after 2000. Provide period and year together.
>
> **period** `string ("q1" | "q2" | "q3" | "q4" | "fy")`
>
> Fiscal period. Provide period and year together; omit both for the latest statement.
>
> **ticker** `string`
>
> Company ticker symbol, such as ADBE. Exactly one of ticker or cik is required.
>
> **statement\_type** `string ("balance_sheet" | "cash_flow" | "income_statement")` *required*
>
> Financial statement to retrieve: balance\_sheet, cash\_flow, or income\_statement.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get GDP Data
>
> **Slug:** `API_NINJAS_GET_GDP`
>
> Tool to get GDP data for a country. Use when you need GDP statistics including growth rate, nominal GDP, GDP per capita, and purchasing power parity data.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** \$0.059 per 100 API requests
>
> **Discount:** 95
>
> #### Input Parameters
>
> **year** `integer`
>
> Year for which to retrieve GDP data. At least one of country or year must be set.
>
> **country** `string`
>
> Country name (case-insensitive) or 2-letter ISO-3166 alpha-2 code (e.g., 'Canada' or 'CA'). At least one of country or year must be set.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Convert City to Coordinates
>
> **Slug:** `API_NINJAS_GET_GEOCODING`
>
> Tool to convert city names to geographic coordinates (forward geocoding). Returns latitude, longitude, and country code for specified city. Use when you need to find the coordinates of a location by its name.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** \$0.059 per 100 API requests
>
> **Discount:** 95
>
> #### Input Parameters
>
> **city** `string` *required*
>
> City name to geocode. Required parameter for converting a city location to latitude and longitude coordinates.
>
> **state** `string`
>
> Optional US state name or abbreviation to narrow down the search. Only applicable for cities in the United States (e.g., 'California' or 'CA').
>
> **country** `string`
>
> Optional 2-letter ISO 3166 alpha-2 country code to narrow down the search (e.g., 'GB' for United Kingdom, 'US' for United States). Useful when multiple cities share the same name.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Gold Price
>
> **Slug:** `API_NINJAS_GET_GOLD_PRICE`
>
> Return the current COMEX gold futures price and contract month; use Get Gold Spot Price for immediate-delivery spot pricing.
>
> #### Input Parameters
>
> **unit** `string ("troy_ounce" | "g" | "kg" | "oz" | "lb" | "metric_ton" | "short_ton" | "hundredweight")`
>
> Target unit to convert the price into. One of troy\_ounce (default), g , kg , oz , lb , metric\_ton , short\_ton , or hundredweight .
>
> **currency** `string`
>
> ISO 4217 currency code to convert the price into (e.g. EUR , GBP ). Defaults to USD.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Gold Price History
>
> **Slug:** `API_NINJAS_GET_GOLD_PRICE_HISTORY`
>
> Return historical COMEX gold futures OHLCV observations. Requires Premium only.
>
> #### Input Parameters
>
> **end** `integer`
>
> End timestamp in Unix format. If not provided, defaults to current time.
>
> **start** `integer`
>
> Start timestamp in Unix format. If not provided, defaults to 24 hours ago.
>
> **period** `string ("1m" | "5m" | "15m" | "30m" | "1h" | "4h" | "1d")`
>
> Time interval between data points. Valid values are: 1m , 5m , 15m , 30m , 1h , 4h , 1d . Default is 1h .
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Gold Spot Price
>
> **Slug:** `API_NINJAS_GET_GOLD_SPOT_PRICE`
>
> Return current immediate-delivery gold spot pricing, bid, and ask; use Get Gold Price for COMEX futures. Requires Premium only.
>
> #### Input Parameters
>
> **unit** `string ("troy_ounce" | "g" | "kg" | "oz" | "lb" | "metric_ton" | "short_ton" | "hundredweight")`
>
> Target unit: troy\_ounce (default), g , kg , oz , lb , metric\_ton , short\_ton , or hundredweight .
>
> **currency** `string`
>
> ISO 4217 currency code to convert prices into (e.g. EUR , GBP , INR ). Defaults to USD.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Helicopter Information
>
> **Slug:** `API_NINJAS_GET_HELICOPTER`
>
> Tool to get helicopter information by manufacturer, model, and specifications. Use when you need detailed technical specifications for helicopters including speed, range, dimensions, and load capacity. At least one search parameter (manufacturer, model, or specification filter) must be provided.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** \$0.059 per 100 API requests
>
> **Discount:** 95
>
> #### Input Parameters
>
> **limit** `integer`
>
> Number of results to return. Must be between 1 and 30. Defaults to 1 if not specified.
>
> **model** `string`
>
> Helicopter model name (e.g., '206L-3', 'UH-60').
>
> **max\_range** `number`
>
> Maximum range in nautical miles.
>
> **max\_speed** `number`
>
> Maximum air speed ceiling in knots.
>
> **min\_range** `number`
>
> Minimum range in nautical miles.
>
> **min\_speed** `number`
>
> Minimum maximum air speed in knots.
>
> **max\_height** `number`
>
> Maximum height in feet.
>
> **max\_length** `number`
>
> Maximum length in feet.
>
> **min\_height** `number`
>
> Minimum height in feet.
>
> **min\_length** `number`
>
> Minimum length in feet.
>
> **manufacturer** `string`
>
> Company that designed and built the helicopter (e.g., 'Bell', 'Airbus', 'Sikorsky').
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Historical Events
>
> **Slug:** `API_NINJAS_GET_HISTORICAL_EVENTS`
>
> Tool to retrieve historical events by date or keywords. Use when you need information about events that happened on a specific date or related to specific topics.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** \$0.059 per 100 API requests
>
> **Discount:** 95
>
> #### Input Parameters
>
> **day** `integer`
>
> Calendar day of the month to filter events (1-31).
>
> **text** `string`
>
> Keywords or short phrases to search events. Useful for finding events related to specific topics or people.
>
> **year** `integer`
>
> 4-digit year to filter events. Use negative values for BC/BCE dates (e.g., -351 for 351 BC).
>
> **month** `integer`
>
> Month number to filter events (1-12, e.g., 3 for March).
>
> **offset** `integer`
>
> Number of results to offset for pagination. Premium feature only.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Historical Figures
>
> **Slug:** `API_NINJAS_GET_HISTORICAL_FIGURES`
>
> Tool to search for historical figures by name. Returns biographical information including birth/death dates, titles, awards, offices held, and family details. Use when you need information about famous people from history.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** \$0.059 per 100 API requests
>
> **Discount:** 95
>
> #### Input Parameters
>
> **name** `string` *required*
>
> Name of the person to search. Supports partial matching (e.g., 'julius' will match Julius Caesar). Case-insensitive.
>
> **offset** `integer`
>
> Number of results to offset for pagination.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Random Hobby Suggestions
>
> **Slug:** `API_NINJAS_GET_HOBBIES`
>
> Tool to get random hobby suggestions from API Ninjas. Use when you need inspiration for new hobbies or activities, optionally filtered by category.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** \$0.059 per 100 API requests
>
> **Discount:** 95
>
> #### Input Parameters
>
> **category** `string ("general" | "sports_and_outdoors" | "education" | "collection" | "competition" | "observation")`
>
> Hobby category options
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Holidays
>
> **Slug:** `API_NINJAS_GET_HOLIDAYS`
>
> Retrieve the full 26-type holiday taxonomy for 2005-2039. Use Get Public Holidays for official public holidays only, or List Bank Holidays for bank closures and observed dates.
>
> #### Input Parameters
>
> **type** `string ("PUBLIC_HOLIDAY" | "STATE_HOLIDAY" | "LOCAL_HOLIDAY" | "PROVINCE_TERRITORY_HOLIDAY" | "DE_FACTO_HOLIDAY" | "SUBSTITUTE_HOLIDAY" | "BANK_HOLIDAY" | "GOVERNMENT_HOLIDAY" | "PRIVATE_SECTOR_HOLIDAY" | "OPTIONAL_HOLIDAY" | "RESTRICTED_TRADING_DAY" | "CHRISTIAN_HOLIDAY" | "ORTHODOX_HOLIDAY" | "MUSLIM_HOLIDAY" | "JEWISH_HOLIDAY" | "HINDU_HOLIDAY" | "OBSERVANCE" | "UNITED_NATIONS_OBSERVANCE" | "FLAG_DAY" | "SILENT_DAY" | "HALF_DAY" | "WORKING_DAY" | "SEASON" | "CLOCK_CHANGE" | "COVID_19_MEASURE" | "SPORTING_EVENT" | "major_holiday")`
>
> Case-insensitive holiday type; major\_holiday is an alias for PUBLIC\_HOLIDAY.
>
> **year** `integer`
>
> Calendar year from 2005 through 2039. Free plans can omit it or use the current year; other years require Premium.
>
> **country** `string` *required*
>
> ISO alpha-2/alpha-3 code or exact English country name.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Daily Horoscope
>
> **Slug:** `API_NINJAS_GET_HOROSCOPE`
>
> Tool to get daily horoscope for a zodiac sign. Returns the horoscope text for the specified zodiac sign and date. Use when you need astrological predictions or daily horoscope information for any of the 12 zodiac signs.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** \$0.059 per 100 API requests
>
> **Discount:** 95
>
> #### Input Parameters
>
> **date** `string`
>
> Historical horoscope retrieval in YYYY-MM-DD format (premium feature). Must be current date or earlier. Defaults to today's date if omitted.
>
> **zodiac** `string ("aries" | "taurus" | "gemini" | "cancer" | "leo" | "virgo" | "libra" | "scorpio" | "sagittarius" | "capricorn" | "aquarius" | "pisces")` *required*
>
> The astrological sign to retrieve horoscope data for. Must be one of the 12 zodiac signs.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Hospital Information
>
> **Slug:** `API_NINJAS_GET_HOSPITALS`
>
> Find hospitals by name, city, state, ZIP code or county. Provide at least one of these filters; coordinate-only searches are not supported. Optional geographic bounds filter the requested provider page. Longitude bounds are applied locally; limit and offset select provider rows before local filtering, so results may be fewer than limit. Advance offset to inspect further pages, even after an empty filtered page.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** \$0.059 per 100 API requests
>
> **Discount:** 95
>
> #### Input Parameters
>
> **city** `string`
>
> City where the hospital is located (e.g., 'New York', 'Los Angeles').
>
> **name** `string`
>
> Hospital name to search for (e.g., 'General Hospital', 'Memorial'). Partial matches are supported.
>
> **limit** `integer`
>
> Number of results to return per request (maximum 100, free users limited to 5).
>
> **state** `string`
>
> State where the hospital is located (e.g., 'NY', 'CA', 'Texas').
>
> **county** `string`
>
> County where the hospital is located (e.g., 'New York County', 'Los Angeles County').
>
> **offset** `integer`
>
> Provider-row offset to skip the first N results. Geographic bounds are enforced within each provider page; advance offset to inspect further pages.
>
> **zipcode** `string`
>
> Hospital ZIP code (e.g., '10001', '90001').
>
> **max\_latitude** `number`
>
> Maximum latitude coordinate for geographic filtering (range: -90 to 90).
>
> **min\_latitude** `number`
>
> Minimum latitude coordinate for geographic filtering (range: -90 to 90).
>
> **max\_longitude** `number`
>
> Maximum longitude coordinate, applied locally within the requested provider page (range: -180 to 180). Requires a name or location filter; coordinate-only search is not supported.
>
> **min\_longitude** `number`
>
> Minimum longitude coordinate, applied locally within the requested provider page (range: -180 to 180). Requires a name or location filter; coordinate-only search is not supported.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Income Statement
>
> **Slug:** `API_NINJAS_GET_INCOME_STATEMENT`
>
> Deprecated compatibility tool for income statements. Use API\_NINJAS\_GET\_FINANCIAL\_STATEMENT with statement\_type=income\_statement. \<\<DEPRECATED use API\_NINJAS\_GET\_FINANCIAL\_STATEMENT>>
>
> #### Input Parameters
>
> **cik** `string`
>
> Company Central Index Key (for example 796343). Exactly one of ticker or cik is required.
>
> **year** `integer`
>
> Fiscal year. E.g. 2025 . Must be a valid year after 2000. For historical data before 2025 , you must have a premium subscription. If set, period must also be set.
>
> **period** `string ("q1" | "q2" | "q3" | "q4" | "fy")`
>
> Fiscal period. Must be one of: q1 , q2 , q3 , q4 , or fy (full year). If set, year must also be set.
>
> **ticker** `string`
>
> Company ticker symbol (for example ADBE). Exactly one of ticker or cik is required.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Income Tax
>
> **Slug:** `API_NINJAS_GET_INCOME_TAX`
>
> Get federal and regional income-tax rates for a country and year.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** \$0.059 per 100 API requests
>
> **Discount:** 95
>
> #### Input Parameters
>
> **year** `integer` *required*
>
> Tax year to retrieve.
>
> **country** `string` *required*
>
> Two-letter country code, such as US or CA.
>
> **regions** `string`
>
> Comma-separated region codes or 'federal'; omit for all regions.
>
> **federal\_only** `boolean`
>
> Legacy filter. True maps to regions='federal'; false or null leaves regions unfiltered.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Inflation Data
>
> **Slug:** `API_NINJAS_GET_INFLATION_DATA`
>
> Tool to get current inflation data for a country. Use when you need latest CPI or HICP monthly and annual inflation rates.
>
> #### Input Parameters
>
> **type** `string ("CPI" | "HICP")`
>
> Inflation indicator type. 'CPI' = Consumer Price Index (standard national measure). 'HICP' = Harmonized Index of Consumer Prices (EU standardized measure for cross-country comparison). Defaults to 'CPI' if not specified.
>
> **country** `string`
>
> Name of country (case-insensitive). If omitted, returns data for all available countries. Free tier includes: Austria, Belgium, Bulgaria, Canada, Chile, Estonia, Germany, Hungary, Iceland, Ireland, Luxembourg, Norway, Portugal, Slovakia, Sweden, Switzerland, The Netherlands. Some countries (e.g., United States) require premium subscription.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Inflation History
>
> **Slug:** `API_NINJAS_GET_INFLATION_HISTORY`
>
> Return historical CPI or HICP inflation observations for a country. Requires Premium only.
>
> #### Input Parameters
>
> **type** `string ("CPI" | "HICP")`
>
> Inflation indicator type. Can be either CPI (Consumer Price Index) or HICP (Harmonized Index of Consumer Prices). If not provided, the CPI will be used by default.
>
> **country** `string` *required*
>
> Either the 2-letter country code (ISO-3166-1 alpha-2) or the country name (case-insensitive). See the list of supported countries in the /v1/inflation endpoint above.
>
> **end\_time** `integer`
>
> End time for the data range, specified as a UNIX timestamp in seconds.
>
> **start\_time** `integer`
>
> Start time for the data range, specified as a UNIX timestamp in seconds.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Insider Details
>
> **Slug:** `API_NINJAS_GET_INSIDER_DETAILS`
>
> Return holdings and recent transactions for an exact insider name. Requires Premium only.
>
> #### Input Parameters
>
> **name** `string` *required*
>
> Name of the insider (exact match). Use the /v1/insiderslist endpoint to look up insider names.
>
> **company\_cik** `string`
>
> Central Index Key (CIK) of the company to filter transactions (e.g., 789019 ).
>
> **company\_ticker** `string`
>
> Company ticker symbol to filter transactions (e.g., AAPL , MSFT ).
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Insider Transactions
>
> **Slug:** `API_NINJAS_GET_INSIDER_TRANSACTIONS`
>
> Tool to get insider trading transactions for publicly traded companies. Returns SEC-filed insider trading data including purchases, sales, and awards by company executives, directors, and major shareholders. Use when you need to track insider activity, analyze insider sentiment, or research specific transactions by ticker, insider name, or transaction details.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** \$0.059 per 100 API requests
>
> **Discount:** 95
>
> #### Input Parameters
>
> **cik** `string`
>
> Central Index Key (CIK) of the company. Alternative to ticker for identifying companies (e.g., '789019').
>
> **limit** `integer`
>
> Maximum number of results to return. Use to limit response size.
>
> **ticker** `string`
>
> Company ticker symbol (e.g., 'AAPL', 'MSFT'). Use to filter transactions by company stock symbol.
>
> **form\_type** `string ("3" | "4" | "5")`
>
> SEC form types for insider trading
>
> **insider\_name** `string`
>
> Exact name of the insider; partial matching is not supported. Use to find transactions by a specific insider.
>
> **insider\_type** `string ("director" | "10_percent_owner" | "officer")`
>
> Type of insider
>
> **transaction\_code** `string ("P" | "S" | "A" | "D" | "F")`
>
> Transaction codes for insider trading
>
> **transaction\_date** `string`
>
> Exact transaction date in YYYY-MM-DD format. Use to find transactions on a specific date.
>
> **transaction\_type** `string`
>
> Type of transaction (e.g., 'Purchase', 'Sale', 'Award'). Use to filter by transaction category.
>
> **max\_transaction\_date** `string`
>
> Maximum transaction date in YYYY-MM-DD format. Use with min\_transaction\_date to define a date range.
>
> **min\_transaction\_date** `string`
>
> Minimum transaction date in YYYY-MM-DD format. Use with max\_transaction\_date to define a date range.
>
> **max\_transaction\_value** `number`
>
> Maximum transaction value in USD. Use with min\_transaction\_value to define a value range.
>
> **min\_transaction\_value** `number`
>
> Minimum transaction value in USD. Use to filter significant transactions (e.g., 1000000 for transactions over \$1M).
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Institutional Ownership
>
> **Slug:** `API_NINJAS_GET_INSTITUTIONAL_OWNERSHIP`
>
> Return institutional holders or the ownership summary for one security.
>
> #### Input Parameters
>
> **sort** `string ("value" | "shares" | "manager_name")`
>
> Result ordering.
>
> **cusip** `string`
>
> Nine-character CUSIP. Exactly one of ticker or cusip is required.
>
> **limit** `integer`
>
> Results in this page, from 1 to 1000.
>
> **offset** `integer`
>
> Results to skip.
>
> **period** `string`
>
> Quarter-end date in YYYY-MM-DD format.
>
> **ticker** `string`
>
> Ticker symbol, for example AAPL. Exactly one of ticker or cusip is required.
>
> **summary** `boolean`
>
> Set to true to return the concentration aggregate; requires Business, Professional, or an annual plan. Omit to return holder records.
>
> **put\_call** `string ("put" | "call")`
>
> Return put or call positions; omit for long positions.
>
> **min\_value** `number`
>
> Minimum market value in USD.
>
> **min\_shares** `number`
>
> Minimum shares held.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Interest Rate
>
> **Slug:** `API_NINJAS_GET_INTEREST_RATE`
>
> Look up one current rate with rate (v2), or use legacy v1 aggregate mode with country or an empty request. This does not return a historical series; use Get Interest Rate History for historical observations.
>
> #### Input Parameters
>
> **rate** `string ("central_bank_au" | "central_bank_br" | "central_bank_ca" | "central_bank_cn" | "central_bank_cz" | "central_bank_dk" | "central_bank_eu" | "central_bank_hu" | "central_bank_in" | "central_bank_il" | "central_bank_mx" | "central_bank_nz" | "central_bank_no" | "central_bank_pl" | "central_bank_ru" | "central_bank_sa" | "central_bank_sk" | "central_bank_se" | "central_bank_ch" | "central_bank_tr" | "central_bank_gb" | "central_bank_us" | "prime_us" | "prime_ca" | "prime_jp" | "prime_za" | "lpr_cn_1y" | "lpr_cn_5y" | "br_my" | "blr_my" | "tpb_br" | "euribor_1_week" | "euribor_1_month" | "euribor_3_months" | "euribor_6_months" | "euribor_12_months" | "ester" | "sonia" | "saron" | "tonar" | "sofr" | "sofr_30d_avg" | "sofr_90d_avg" | "sofr_180d_avg" | "effr" | "corra" | "livret_a")`
>
> Current v2 mode: documented interest-rate identifier. Mutually exclusive with legacy country; omit both fields for the legacy v1 aggregate response.
>
> **country** `string`
>
> Legacy v1 mode only: country name filter using underscores for spaces, such as United\_States. Omit both country and rate to return all legacy aggregate rates.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Interest Rate History
>
> **Slug:** `API_NINJAS_GET_INTEREST_RATE_HISTORY`
>
> Return paginated historical observations for a named benchmark interest rate. Requires Premium only.
>
> #### Input Parameters
>
> **page** `string`
>
> Opaque cursor from the previous response's next field.
>
> **rate** `string ("central_bank_au" | "central_bank_br" | "central_bank_ca" | "central_bank_cn" | "central_bank_cz" | "central_bank_dk" | "central_bank_eu" | "central_bank_hu" | "central_bank_in" | "central_bank_il" | "central_bank_mx" | "central_bank_nz" | "central_bank_no" | "central_bank_pl" | "central_bank_ru" | "central_bank_sa" | "central_bank_sk" | "central_bank_se" | "central_bank_ch" | "central_bank_tr" | "central_bank_gb" | "central_bank_us" | "prime_us" | "prime_ca" | "prime_jp" | "prime_za" | "lpr_cn_1y" | "lpr_cn_5y" | "br_my" | "blr_my" | "tpb_br" | "euribor_1_week" | "euribor_1_month" | "euribor_3_months" | "euribor_6_months" | "euribor_12_months" | "ester" | "sonia" | "saron" | "tonar" | "sofr" | "sofr_30d_avg" | "sofr_90d_avg" | "sofr_180d_avg" | "effr" | "corra" | "livret_a" | "usd_libor_overnight" | "usd_libor_1_month" | "usd_libor_3_months" | "usd_libor_6_months" | "usd_libor_12_months")` *required*
>
> Specific central-bank or benchmark rate identifier.
>
> **end\_date** `string`
>
> Inclusive UTC end date in YYYY-MM-DD format; mutually exclusive with end\_time.
>
> **end\_time** `integer`
>
> End UNIX timestamp in seconds.
>
> **start\_date** `string`
>
> Inclusive UTC start date in YYYY-MM-DD format; mutually exclusive with start\_time.
>
> **start\_time** `integer`
>
> Start UNIX timestamp in seconds.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Joke of the Day
>
> **Slug:** `API_NINJAS_GET_JOKE_OF_THE_DAY`
>
> Tool to retrieve the joke of the day from API Ninjas. Returns the same joke for all users on a given day, with jokes changing daily. Use when you need a daily joke to display or share.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** \$0.059 per 100 API requests
>
> **Discount:** 95
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Random Jokes
>
> **Slug:** `API_NINJAS_GET_JOKES`
>
> Tool to retrieve random jokes from API Ninjas. Returns one or more jokes suitable for entertainment. Use when you need general humor content.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** \$0.059 per 100 API requests
>
> **Discount:** 95
>
> #### Input Parameters
>
> **limit** `integer`
>
> How many jokes to return. Must be between 1 and 30. Default is 1.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Libor History
>
> **Slug:** `API_NINJAS_GET_LIBOR_HISTORY`
>
> Return historical values for a documented LIBOR tenor. Requires Business tier and above.
>
> #### Input Parameters
>
> **type** `string ("overnight" | "1_month" | "3_months" | "6_months" | "12_months")` *required*
>
> LIBOR tenor.
>
> **end\_time** `integer`
>
> Range end Unix timestamp in seconds.
>
> **start\_time** `integer`
>
> Range start Unix timestamp in seconds.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Lottery Draw
>
> **Slug:** `API_NINJAS_GET_LOTTERY_DRAW`
>
> Get one game's draw, or the latest draws for games in a state or country.
>
> #### Input Parameters
>
> **date** `string`
>
> Draw date in YYYY-MM-DD format. Developer covers the last two years; Business tier and above covers any archived date.
>
> **game** `string`
>
> Lottery game slug. At least one of game, state, or country is required.
>
> **state** `string`
>
> US state or territory code. At least one of game, state, or country is required.
>
> **country** `string`
>
> Alpha-2 country code. At least one of game, state, or country is required.
>
> **session** `string`
>
> Named intraday draw session.
>
> **draw\_number** `integer`
>
> Operator draw number.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Lottery Draw History
>
> **Slug:** `API_NINJAS_GET_LOTTERY_DRAW_HISTORY`
>
> Return one bounded page of historical lottery draws. Free includes the latest 10 draws; Developer includes two years; Business tier and above includes the full archive.
>
> #### Input Parameters
>
> **end** `string`
>
> Inclusive latest draw date in YYYY-MM-DD format.
>
> **game** `string` *required*
>
> Lottery game slug.
>
> **limit** `integer`
>
> Draws to return, from 1 to 1000.
>
> **start** `string`
>
> Inclusive earliest draw date in YYYY-MM-DD format.
>
> **offset** `integer`
>
> Draws to skip.
>
> **session** `string`
>
> Named draw session.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Market Cap
>
> **Slug:** `API_NINJAS_GET_MARKET_CAP`
>
> Tool to get real-time market cap data for a company. Use when you need up-to-date market capitalization by specifying the stock ticker. Example: "What is the market cap of NVDA?"
>
> #### Input Parameters
>
> **ticker** `string` *required*
>
> Stock ticker symbol, e.g., 'NVDA'
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Metals Prices
>
> **Slug:** `API_NINJAS_GET_METALS_PRICES`
>
> Return spot and matching futures data for precious metals plus copper and aluminum; unlike commodity spot tools, copper and aluminum use futures-based spot values identified by spot\_type, and dedicated gold spot should be used for gold-only immediate-delivery requests.
>
> #### Input Parameters
>
> **unit** `string ("troy_ounce" | "g" | "kg" | "oz" | "lb" | "metric_ton" | "short_ton" | "hundredweight")`
>
> Target weight unit; omit for the metal's native unit.
>
> **metal** `string ("gold" | "silver" | "platinum" | "palladium" | "copper" | "aluminum" | "xau" | "xag" | "xpt" | "xpd")`
>
> Metal name or code: gold, silver, platinum, palladium, copper, aluminum, xau, xag, xpt, or xpd. Mutually exclusive with metals; provide at most one of the two.
>
> **metals** `string`
>
> Comma-separated accepted metals for a batch request. Mutually exclusive with metal; provide at most one of the two. Requires Business tier and above, or any annual plan.
>
> **currency** `string`
>
> ISO 4217 target currency.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Mortgage Rate
>
> **Slug:** `API_NINJAS_GET_MORTGAGE_RATE`
>
> Get current or historical 15-year and 30-year mortgage rates.
>
> #### Input Parameters
>
> **date** `string`
>
> Premium: one date to query in YYYY-MM-DD format; do not combine with a range.
>
> **max\_date** `string`
>
> Premium: last date in a YYYY-MM-DD range; requires min\_date.
>
> **min\_date** `string`
>
> Premium: first date in a YYYY-MM-DD range; requires max\_date.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Motor Carrier
>
> **Slug:** `API_NINJAS_GET_MOTOR_CARRIER`
>
> Return a motor carrier record by USDOT or docket number.
>
> #### Input Parameters
>
> **dot** `string`
>
> USDOT number. Exactly one of dot or motor\_carrier\_number is required.
>
> **checks** `boolean`
>
> Set true to evaluate active authority, acceptable safety rating, BI\&PD and cargo coverage, out-of-service orders, pending insurance cancellation, and MCS-150 currency. Returns each check, not an overall verdict. Requires Business tier and above.
>
> **min\_bipd** `number`
>
> BI\&PD coverage threshold in USD used by checks; defaults to 1,000,000. Requires Business tier and above.
>
> **min\_cargo** `number`
>
> Cargo coverage threshold in USD used by checks; defaults to 100,000. Requires Business tier and above.
>
> **motor\_carrier\_number** `string`
>
> Docket number with or without MC, MX, or FF prefix. Exactly one of dot or motor\_carrier\_number is required.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Motor Carrier Insurance
>
> **Slug:** `API_NINJAS_GET_MOTOR_CARRIER_INSURANCE`
>
> Return active insurance filings for a motor carrier.
>
> #### Input Parameters
>
> **dot** `string`
>
> USDOT number. Exactly one of dot or motor\_carrier\_number is required.
>
> **motor\_carrier\_number** `string`
>
> Docket number with or without its prefix. Exactly one of dot or motor\_carrier\_number is required.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Motor Carrier Links
>
> **Slug:** `API_NINJAS_GET_MOTOR_CARRIER_LINKS`
>
> Return carriers linked through shared identifying attributes.
>
> #### Input Parameters
>
> **dot** `string`
>
> USDOT number. Exactly one of dot or motor\_carrier\_number is required.
>
> **motor\_carrier\_number** `string`
>
> Docket number with or without its prefix. Exactly one of dot or motor\_carrier\_number is required.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Motor Carrier Safety
>
> **Slug:** `API_NINJAS_GET_MOTOR_CARRIER_SAFETY`
>
> Return crash, inspection, and BASIC safety data for a carrier.
>
> #### Input Parameters
>
> **dot** `string`
>
> USDOT number. Exactly one of dot or motor\_carrier\_number is required.
>
> **motor\_carrier\_number** `string`
>
> Docket number with or without its prefix. Exactly one of dot or motor\_carrier\_number is required.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Motorcycle Specifications
>
> **Slug:** `API_NINJAS_GET_MOTORCYCLES`
>
> Tool to get detailed motorcycle specifications by make, model, and year. Use when you need technical data about specific motorcycle models including engine specs, dimensions, transmission, suspension, and performance data.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** \$0.059 per 100 API requests
>
> **Discount:** 95
>
> #### Input Parameters
>
> **make** `string`
>
> Name of manufacturer/brand. Supports partial matching (e.g., 'Harley' matches 'Harley-Davidson'). Either make or model must be provided.
>
> **year** `string`
>
> Release year in YYYY format (e.g., '2022').
>
> **model** `string`
>
> Name of motorcycle model. Supports partial matching (e.g., 'Ninja' matches 'Ninja 650'). Either make or model must be provided.
>
> **offset** `integer`
>
> Number of results to offset for pagination. Default is 0. Premium feature only.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Mutual Fund Info
>
> **Slug:** `API_NINJAS_GET_MUTUAL_FUND`
>
> Get mutual fund information by ticker or ISIN, including name, ISIN, CUSIP, and country. Price, expense ratio, assets under management, number of holdings, and holdings require a premium subscription and return null for free-tier users.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** \$0.059 per 100 API requests
>
> **Discount:** 95
>
> #### Input Parameters
>
> **isin** `string`
>
> International Securities Identification Number of the fund share class. Supply exactly one of ticker or isin.
>
> **ticker** `string`
>
> Mutual Fund ticker symbol. Case-insensitive. Supply exactly one of ticker or isin.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get MX Records
>
> **Slug:** `API_NINJAS_GET_MX_RECORDS`
>
> Tool to retrieve MX (Mail Exchange) records for a specified domain. Use when you need to identify mail servers responsible for accepting email for a domain.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** \$0.059 per 100 API requests
>
> **Discount:** 95
>
> #### Input Parameters
>
> **domain** `string` *required*
>
> A valid domain name to query MX records for (e.g., example.com).
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get NAICS Code
>
> **Slug:** `API_NINJAS_GET_NAICS_CODE`
>
> Look up NAICS records by code, batch, or official title.
>
> #### Input Parameters
>
> **code** `string`
>
> A two- to six-digit NAICS code. Exactly one of code, codes, or title is required.
>
> **year** `integer`
>
> NAICS revision. The only accepted value is 2022.
>
> **codes** `string`
>
> Comma-separated batch of at most 500 NAICS codes. Exactly one of code, codes, or title is required.
>
> **title** `string`
>
> Partial official title lookup. Exactly one of code, codes, or title is required.
>
> **country** `string`
>
> Country. The only accepted value is US.
>
> **crosswalk\_to** `string`
>
> Earlier revision to crosswalk to. The only accepted value is 2017.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get NAICS Size Standard
>
> **Slug:** `API_NINJAS_GET_NAICS_SIZE_STANDARD`
>
> Return SBA size standards and optional eligibility calculations. Requires Premium only.
>
> #### Input Parameters
>
> **code** `string`
>
> One six-digit NAICS code.
>
> **codes** `string`
>
> Comma-separated codes for batch lookup: up to 50 on Developer and 500 on Business tier and above.
>
> **revenue** `number`
>
> Annual receipts in USD.
>
> **employees** `integer`
>
> Employee count.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Nutrition Item
>
> **Slug:** `API_NINJAS_GET_NUTRITION_ITEM`
>
> Return nutrition for one food item and quantity.
>
> #### Input Parameters
>
> **query** `string` *required*
>
> One food item to query.
>
> **quantity** `string` *required*
>
> Quantity with a supported unit, such as 1 cup or 100g.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Oil Price
>
> **Slug:** `API_NINJAS_GET_OIL_PRICE`
>
> Return current futures-contract prices and contract metadata for oil and energy benchmarks; use Get Oil Spot Price for physical immediate-delivery prices.
>
> #### Input Parameters
>
> **type** `string ("wti" | "brent" | "natural_gas" | "gasoline" | "diesel")`
>
> Single oil or energy benchmark.
>
> **unit** `string ("barrel" | "gallon" | "liter" | "cubic_meter" | "MMBtu" | "MWh" | "GJ" | "therm")`
>
> Volume unit (barrel, gallon, liter, cubic\_meter) for oil/gasoline/diesel, or energy unit (MMBtu, MWh, GJ, therm) for natural\_gas. Requires Premium only.
>
> **types** `string`
>
> Comma-separated benchmarks for batch lookup.
>
> **currency** `string`
>
> ISO 4217 target currency.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Oil Price History
>
> **Slug:** `API_NINJAS_GET_OIL_PRICE_HISTORY`
>
> Return historical OHLCV data for an oil or energy benchmark. Requires Premium only.
>
> #### Input Parameters
>
> **end** `integer`
>
> Range end Unix timestamp.
>
> **type** `string ("wti" | "brent" | "natural_gas" | "gasoline" | "diesel")`
>
> Oil or energy benchmark; omit for WTI.
>
> **start** `integer`
>
> Range start Unix timestamp.
>
> **period** `string ("1m" | "5m" | "15m" | "30m" | "1h" | "4h" | "1d")`
>
> Interval between data points.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Oil Spot Price
>
> **Slug:** `API_NINJAS_GET_OIL_SPOT_PRICE`
>
> Return assessed physical spot pricing for oil and energy benchmarks. Requires Premium only.
>
> #### Input Parameters
>
> **type** `string ("wti" | "brent" | "natural_gas" | "gasoline" | "diesel")`
>
> Single benchmark.
>
> **unit** `string ("barrel" | "gallon" | "liter" | "cubic_meter" | "MMBtu" | "MWh" | "GJ" | "therm")`
>
> Volume unit (barrel, gallon, liter, cubic\_meter) for oil/gasoline/diesel, or energy unit (MMBtu, MWh, GJ, therm) for natural\_gas.
>
> **types** `string`
>
> Comma-separated benchmarks for batch lookup.
>
> **currency** `string`
>
> ISO 4217 target currency.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Planet Information
>
> **Slug:** `API_NINJAS_GET_PLANETS`
>
> Tool to retrieve detailed information about planets and exoplanets including mass, radius, orbital period, temperature, and host star data. Use when you need astronomical data about planets in the known universe. At least one parameter (other than offset) must be set.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** \$0.059 per 100 API requests
>
> **Discount:** 95
>
> #### Input Parameters
>
> **name** `string`
>
> The name of the planet to search for.
>
> **offset** `integer`
>
> Offset results for pagination. Returns at most 30 results per request.
>
> **max\_mass** `number`
>
> Maximum mass of the planet in Jupiters (1 Jupiter = 1.898 × 10²⁷ kg).
>
> **min\_mass** `number`
>
> Minimum mass of the planet in Jupiters (1 Jupiter = 1.898 × 10²⁷ kg).
>
> **max\_period** `number`
>
> Maximum orbital period of the planet in Earth days.
>
> **max\_radius** `number`
>
> Maximum average radius of the planet in Jupiters (1 Jupiter = 69911 km).
>
> **min\_period** `number`
>
> Minimum orbital period of the planet in Earth days.
>
> **min\_radius** `number`
>
> Minimum average radius of the planet in Jupiters (1 Jupiter = 69911 km).
>
> **max\_temperature** `number`
>
> Maximum average surface temperature in Kelvin.
>
> **min\_temperature** `number`
>
> Minimum average surface temperature in Kelvin.
>
> **max\_distance\_light\_year** `number`
>
> Maximum distance from Earth in light years.
>
> **min\_distance\_light\_year** `number`
>
> Minimum distance from Earth in light years.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Population Data
>
> **Slug:** `API_NINJAS_GET_POPULATION`
>
> Get historical and forecast population statistics for a country, including demographic and urban population metrics, or search countries by population range.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** \$0.059 per 100 API requests
>
> **Discount:** 95
>
> #### Input Parameters
>
> **offset** `integer`
>
> Offset results for pagination.
>
> **country** `string`
>
> Country name (case-insensitive) or 2-letter ISO-3166 alpha-2 code (e.g., 'Japan' or 'JP'). At least one of country, min\_population, or max\_population must be set.
>
> **max\_population** `integer`
>
> Maximum population of country. At least one of country, min\_population, or max\_population must be set.
>
> **min\_population** `integer`
>
> Minimum population of country. At least one of country, min\_population, or max\_population must be set.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Postal Code Location Info
>
> **Slug:** `API_NINJAS_GET_POSTAL_CODE`
>
> Tool to retrieve location information for Canadian postal codes. Returns city, province, coordinates, area code, and timezone data. Use when you need to find location details for a postal code or search by city/province.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** \$0.059 per 100 API requests
>
> **Discount:** 95
>
> #### Input Parameters
>
> **city** `string`
>
> Full city name (case-sensitive) to search for location information. Premium tier required. At least one of postal\_code, city, or province must be provided.
>
> **province** `string`
>
> 2-letter Canadian province abbreviation (e.g., 'ON' for Ontario, 'BC' for British Columbia). Premium tier required. At least one of postal\_code, city, or province must be provided.
>
> **postal\_code** `string`
>
> Canadian postal code (6 or 7 characters with optional space, e.g., 'K1A0B1' or 'K1A 0B1'). At least one of postal\_code, city, or province must be provided.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Property Tax Rates
>
> **Slug:** `API_NINJAS_GET_PROPERTY_TAX`
>
> Tool to get property tax rates by city, county, or ZIP code. Use when you need effective property tax rate statistics for a specific location.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** \$0.059 per 100 API requests
>
> **Discount:** 95
>
> #### Input Parameters
>
> **zip** `string`
>
> The ZIP Code to look up. At least one of city, county, or zip must be specified.
>
> **city** `string`
>
> Full name of the city (case-sensitive). At least one of city, county, or zip must be specified.
>
> **state** `string`
>
> 2-letter state abbreviation (case-insensitive).
>
> **county** `string`
>
> Name of the county requesting property tax data. At least one of city, county, or zip must be specified.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Public Holidays
>
> **Slug:** `API_NINJAS_GET_PUBLIC_HOLIDAYS`
>
> Tool to retrieve official public holidays for a specific country and year. Use when you need information about federal and regional public holidays for planning, scheduling, or calendar-related tasks. Supports calendar years from 1980 to 2050.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** \$0.059 per 100 API requests
>
> **Discount:** 95
>
> #### Input Parameters
>
> **year** `integer`
>
> Calendar year to retrieve public holidays for. Must be between 1980 and 2050 (inclusive). Defaults to current year if not specified.
>
> **country** `string` *required*
>
> 2-letter ISO country code or full country name (e.g., 'US', 'United States', 'GB', 'United Kingdom'). Determines which country's public holidays to retrieve.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Quote of the Day
>
> **Slug:** `API_NINJAS_GET_QUOTE_OF_THE_DAY`
>
> Tool to retrieve the quote of the day from API Ninjas. Returns the same quote for all users on a given day, with quotes changing daily. Use when you need an inspirational or thought-provoking daily quote to display or share.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** \$0.059 per 100 API requests
>
> **Discount:** 95
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Random Quotes
>
> **Slug:** `API_NINJAS_GET_QUOTES`
>
> Deprecated limited random-quote tool. Use API\_NINJAS\_GET\_RANDOM\_QUOTES for larger limits and category exclusions or work-title filtering. \<\<DEPRECATED use API\_NINJAS\_GET\_RANDOM\_QUOTES>>
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** \$0.059 per 100 API requests
>
> **Discount:** 95
>
> #### Input Parameters
>
> **limit** `integer`
>
> Number of quotes to return. Must be between 1 and 10. Default is 1 if not specified.
>
> **author** `string`
>
> Author name to filter quotes. Supports partial matching and is case-insensitive (e.g., 'einstein' matches 'Albert Einstein').
>
> **categories** `string`
>
> Comma-separated list of quote categories to filter by (e.g., 'success,wisdom'). Available categories include: wisdom, philosophy, life, truth, inspirational, relationships, love, faith, humor, success, courage, happiness, art, writing, fear, nature, time, freedom, death, leadership.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Random Image
>
> **Slug:** `API_NINJAS_GET_RANDOM_IMAGE`
>
> Tool to get a random image by category from API Ninjas. Use when you need random image content for display or download.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** \$0.059 per 100 API requests
>
> **Discount:** 95
>
> #### Input Parameters
>
> **category** `string`
>
> Image category filter (e.g., wildlife, nature, city). Premium subscription required for category filtering.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Random Quotes
>
> **Slug:** `API_NINJAS_GET_RANDOM_QUOTES`
>
> Tool to retrieve random quotes from API Ninjas. Filter by categories, author, or work title. Use when you need inspirational quotes, wisdom, or literary references for content or motivation.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** \$0.059 per 100 API requests
>
> **Discount:** 95
>
> #### Input Parameters
>
> **work** `string`
>
> Filter by work/book title using partial string matching. Matches quotes from works whose titles contain this string.
>
> **limit** `integer`
>
> Number of random results returned (1-100 range). Default is 1. Note: This is a premium-only feature and will return an error for non-premium accounts.
>
> **author** `string`
>
> Filter by author name using partial string matching. Matches quotes from authors whose names contain this string.
>
> **categories** `string`
>
> Comma-separated list of category names to include. Results match all specified categories. Available categories: wisdom, philosophy, life, truth, inspirational, relationships, love, faith, humor, success, courage, happiness, art, writing, fear, nature, time, freedom, death, leadership.
>
> **exclude\_categories** `string`
>
> Comma-separated list of categories to exclude. Results won't match any listed categories.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Random Word
>
> **Slug:** `API_NINJAS_GET_RANDOM_WORD`
>
> Tool to get a random English word from the API Ninjas Random Word endpoint. Use when you need random words for games, education, or creative projects. Optionally filter by word type (noun, verb, adjective, adverb).
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** \$0.059 per 100 API requests
>
> **Discount:** 95
>
> #### Input Parameters
>
> **type** `string ("noun" | "verb" | "adjective" | "adverb")`
>
> Filter by word type. Options: noun, verb, adjective, adverb. Leave empty for any type.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Recipe
>
> **Slug:** `API_NINJAS_GET_RECIPE`
>
> Search recipes by title, up to five ingredients, or nutrition filters.
>
> #### Input Parameters
>
> **limit** `integer`
>
> Results to return: up to 5 on free accounts or 10 on premium accounts.
>
> **title** `string`
>
> Recipe title to search for.
>
> **number** `integer`
>
> Legacy name for limit. Must be between 1 and 10 inclusive.
>
> **offset** `integer`
>
> Premium: number of matching recipes to skip for pagination.
>
> **max\_fat** `number`
>
> Premium: maximum total fat in grams for the whole recipe.
>
> **min\_fat** `number`
>
> Premium: minimum total fat in grams for the whole recipe.
>
> **servings** `integer`
>
> Premium: rescale ingredient quantities and nutrition to 1-1000 servings.
>
> **max\_carbs** `number`
>
> Premium: maximum total carbohydrates in grams for the whole recipe.
>
> **min\_carbs** `number`
>
> Premium: minimum total carbohydrates in grams for the whole recipe.
>
> **max\_sodium** `number`
>
> Premium: maximum sodium in milligrams for the whole recipe.
>
> **max\_sugars** `number`
>
> Premium: maximum sugars in grams for the whole recipe.
>
> **ingredients** `string`
>
> Comma-separated ingredients, up to five.
>
> **max\_protein** `number`
>
> Premium: maximum protein in grams for the whole recipe.
>
> **min\_protein** `number`
>
> Premium: minimum protein in grams for the whole recipe.
>
> **max\_calories** `number`
>
> Premium: maximum calories for the whole recipe.
>
> **min\_calories** `number`
>
> Premium: minimum calories for the whole recipe.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Convert Coordinates to Location
>
> **Slug:** `API_NINJAS_GET_REVERSE_GEOCODING`
>
> Tool to convert geographic coordinates to location information (reverse geocoding). Returns location name, country code, and state/region for specified coordinates. Use when you need to find address or place information from latitude and longitude.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** \$0.059 per 100 API requests
>
> **Discount:** 95
>
> #### Input Parameters
>
> **lat** `number` *required*
>
> Latitude coordinate in decimal degrees (range: -90 to 90). Required for reverse geocoding.
>
> **lon** `number` *required*
>
> Longitude coordinate in decimal degrees (range: -180 to 180). Required for reverse geocoding.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Rhyming Words
>
> **Slug:** `API_NINJAS_GET_RHYMES`
>
> Tool to get words that rhyme with a given word. Use when you need to find rhyming words for creative writing, poetry, or songwriting.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** \$0.059 per 100 API requests
>
> **Discount:** 95
>
> #### Input Parameters
>
> **word** `string` *required*
>
> The word to find rhymes for. Must be a valid English word.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Random Riddles
>
> **Slug:** `API_NINJAS_GET_RIDDLES`
>
> Tool to retrieve random riddles with answers from API Ninjas. Returns one or more riddles suitable for entertainment and brain teasers. Use when you need riddles for games, quizzes, or entertainment purposes.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** \$0.059 per 100 API requests
>
> **Discount:** 95
>
> #### Input Parameters
>
> **limit** `integer`
>
> Number of riddles to return. Must be between 1 and 20. Default is 1. Note: Requesting more than 1 riddle is a Premium only feature.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Sales Tax Rates
>
> **Slug:** `API_NINJAS_GET_SALES_TAX`
>
> Tool to get sales tax rates by ZIP code or city and state. Use when you need current sales tax rate information for a specific US location. Either provide zip\_code alone OR city+state together.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** \$0.059 per 100 API requests
>
> **Discount:** 95
>
> #### Input Parameters
>
> **city** `string`
>
> City name. Must be used together with state parameter as alternative to zip\_code. Use either zip\_code alone OR city+state together.
>
> **state** `string`
>
> State name. Must be used together with city parameter as alternative to zip\_code. Use either zip\_code alone OR city+state together.
>
> **zip\_code** `string`
>
> Valid US ZIP code. Required if city and state are not provided. Use either zip\_code alone OR city+state together.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Sales Tax Filing Requirements
>
> **Slug:** `API_NINJAS_GET_SALES_TAX_FILING_REQUIREMENTS`
>
> Return state sales-tax filing frequencies, thresholds, and due dates for a year. Requires Business tier and above.
>
> #### Input Parameters
>
> **year** `integer`
>
> Four-digit calendar year.
>
> **state** `string`
>
> Two-letter state code or full state name.
>
> **frequency** `string`
>
> State-specific filing frequency tier, such as monthly, quarterly, semiannual, annual, or monthly\_accelerated.
>
> **annual\_liability** `number`
>
> Annual sales-tax liability in US dollars.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get SEC Filing
>
> **Slug:** `API_NINJAS_GET_SEC_FILING`
>
> Tool to retrieve SEC filing information for publicly traded companies. Returns a list of SEC filings including the filing date, form type, and direct URL to the filing document. Use when you need to access company regulatory filings like 10-K annual reports, 10-Q quarterly reports, 8-K current reports, or other SEC documents.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** \$0.059 per 100 API requests
>
> **Discount:** 95
>
> #### Input Parameters
>
> **limit** `integer`
>
> Number of results to return, from 1 to 100. By default, up to 2 results are returned. Use to control response size.
>
> **filing** `string` *required*
>
> SEC filing form type to filter by (e.g., '10-K' for annual reports, '10-Q' for quarterly reports, '8-K' for current reports, 'S-1' for IPO registration, 'DEF14A' for proxy statements).
>
> **ticker** `string` *required*
>
> Ticker symbol of the company to search (e.g., 'AAPL' for Apple, 'MSFT' for Microsoft). Use to filter filings by company stock symbol.
>
> **end\_date** `string`
>
> End date to search filings until. Must be in YYYY-MM-DD format (e.g., '2023-12-31'). Use with start\_date to define a date range.
>
> **start\_date** `string`
>
> Start date to search filings from. Must be in YYYY-MM-DD format (e.g., '2023-04-01'). Use with end\_date to define a date range.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Short Interest
>
> **Slug:** `API_NINJAS_GET_SHORT_INTEREST`
>
> Return reported short-interest observations for a stock ticker.
>
> #### Input Parameters
>
> **limit** `integer`
>
> Historical records to return, from 1 to 200.
>
> **ticker** `string` *required*
>
> Stock ticker symbol.
>
> **settlement\_date** `string`
>
> Settlement date in YYYY-MM-DD format; use a provider reporting date.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Short Volume
>
> **Slug:** `API_NINJAS_GET_SHORT_VOLUME`
>
> Return daily short-sale volume observations for a stock ticker.
>
> #### Input Parameters
>
> **limit** `integer`
>
> Historical records to return.
>
> **ticker** `string` *required*
>
> Stock ticker symbol.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get S\&P 500 Constituents
>
> **Slug:** `API_NINJAS_GET_SP500_CONSTITUENTS`
>
> Tool to retrieve current S\&P 500 index constituents with filtering by ticker, name, sector, or date added. Use when you need information about companies in the S\&P 500 index. Returns company details including ticker symbols, names, sectors, CIK numbers, sub-industries, headquarters locations, and dates added to the index.
>
> #### Input Parameters
>
> **name** `string`
>
> Company name to search for (full or partial match). Returns companies whose names contain the search term.
>
> **limit** `integer`
>
> Maximum number of results to return. Use this to control the size of the response.
>
> **offset** `integer`
>
> Number of results to skip (for pagination). Use with limit to paginate through results.
>
> **sector** `string`
>
> GICS Sector to filter by (e.g., 'Information Technology', 'Financials', 'Health Care'). Returns companies in the specified sector.
>
> **ticker** `string`
>
> Stock ticker symbol to filter by (e.g., 'AAPL', 'MSFT', 'GOOGL'). Returns companies matching the specified ticker.
>
> **dateadded\_max** `string`
>
> Latest date company was added to the S\&P 500 (format: YYYY-MM-DD). Returns companies added on or before this date.
>
> **dateadded\_min** `string`
>
> Earliest date company was added to the S\&P 500 (format: YYYY-MM-DD). Returns companies added on or after this date.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Star Information
>
> **Slug:** `API_NINJAS_GET_STARS`
>
> Retrieve star information including constellation, coordinates, magnitude, distance, and spectral classification. Search by name, constellation, or numeric criteria; an optional spectral-class prefix filters only the returned provider page.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** \$0.059 per 100 API requests
>
> **Discount:** 95
>
> #### Input Parameters
>
> **name** `string`
>
> The name of the star to search for. Note that many star names contain Greek characters.
>
> **offset** `integer`
>
> Offset results for pagination. Returns at most 30 results per request.
>
> **constellation** `string`
>
> The constellation that the star belongs to.
>
> **spectral\_class** `string`
>
> Case-insensitive spectral-class prefix filter applied to the returned provider page. Use name, constellation or numeric criteria to select the provider page; offset counts provider rows.
>
> **max\_absolute\_magnitude** `number`
>
> Maximum absolute magnitude (intrinsic brightness of the star).
>
> **max\_apparent\_magnitude** `number`
>
> Maximum apparent magnitude (brightness as seen from Earth). Lower values indicate brighter stars.
>
> **min\_absolute\_magnitude** `number`
>
> Minimum absolute magnitude (intrinsic brightness of the star).
>
> **min\_apparent\_magnitude** `number`
>
> Minimum apparent magnitude (brightness as seen from Earth). Lower values indicate brighter stars.
>
> **max\_distance\_light\_year** `number`
>
> Maximum distance from Earth in light years.
>
> **min\_distance\_light\_year** `number`
>
> Minimum distance from Earth in light years.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Stock Exchange Information
>
> **Slug:** `API_NINJAS_GET_STOCK_EXCHANGE`
>
> Tool to retrieve stock exchange information by Market Identifier Code (MIC), name, city, or country. Use when you need details about stock exchanges including market data, location, and operational hours.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** \$0.059 per 100 API requests
>
> **Discount:** 95
>
> #### Input Parameters
>
> **mic** `string`
>
> Market Identifier Code (MIC) to search for a specific stock exchange (e.g., 'XNYS' for New York Stock Exchange, 'XLON' for London Stock Exchange).
>
> **city** `string`
>
> City where the stock exchange is located (e.g., 'New York', 'London', 'Tokyo').
>
> **name** `string`
>
> Stock exchange name to search for (e.g., 'New York Stock Exchange', 'NASDAQ'). Partial matches are supported.
>
> **country** `string`
>
> 2-letter ISO country code (ISO-3166-1 alpha-2) to filter exchanges by country (e.g., 'US', 'GB', 'JP').
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Stock Exchange Hours
>
> **Slug:** `API_NINJAS_GET_STOCK_EXCHANGE_HOURS`
>
> Return stock exchange session hours and open status for a date or timestamp. Requires Business tier and above.
>
> #### Input Parameters
>
> **mic** `string`
>
> Market Identifier Code.
>
> **date** `string`
>
> Date in YYYY-MM-DD format.
>
> **timestamp** `integer`
>
> Unix timestamp in seconds.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Stock Price
>
> **Slug:** `API_NINJAS_GET_STOCK_PRICE`
>
> Tool to get current stock price data for any publicly traded company or index. Use when you need real-time (premium) or most recent completed trading-session closing (free) stock prices, trading volume, and market data by ticker symbol.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** \$0.059 per 100 API requests
>
> **Discount:** 95
>
> #### Input Parameters
>
> **ticker** `string` *required*
>
> Stock or index ticker symbol (e.g., 'AAPL' for Apple, 'GOOGL' for Google, '^DJI' for Dow Jones Industrial Average). Use standard ticker symbols as recognized by major exchanges.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Stock Price History
>
> **Slug:** `API_NINJAS_GET_STOCK_PRICE_HISTORY`
>
> Return historical OHLCV stock-price points for a ticker and interval. Requires Premium only.
>
> #### Input Parameters
>
> **end** `integer`
>
> End UNIX timestamp; provider defaults to current time.
>
> **start** `integer`
>
> Start UNIX timestamp; provider defaults to recent history. Requests more than five years back require Business, Professional, Enterprise, or any annual plan.
>
> **period** `string ("1m" | "5m" | "15m" | "30m" | "1h" | "4h" | "1d")`
>
> Interval between data points.
>
> **ticker** `string` *required*
>
> Stock ticker symbol.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get SWIFT Code
>
> **Slug:** `API_NINJAS_GET_SWIFT_CODE`
>
> Tool to get bank information from SWIFT code or search by bank name, city, or country. Use when you need to look up bank details using a SWIFT/BIC code or search for banks by various criteria. At least one parameter must be provided.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** \$0.059 per 100 API requests
>
> **Discount:** 95
>
> #### Input Parameters
>
> **bank** `string`
>
> The name of the bank to look up. This parameter supports partial matching (premium only)
>
> **city** `string`
>
> Name of the municipality where the bank operates
>
> **swift** `string`
>
> The SWIFT Code identifier for a specific bank to retrieve
>
> **offset** `integer`
>
> The number of results to offset for pagination. Requires an annual premium subscription; omit for a lookup without pagination
>
> **country** `string`
>
> ISO 3166 2-letter country code designation
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Thesaurus
>
> **Slug:** `API_NINJAS_GET_THESAURUS`
>
> Tool to get synonyms and antonyms for an English word. Use when you need to find alternative words with similar or opposite meanings.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** \$0.059 per 100 API requests
>
> **Discount:** 95
>
> #### Input Parameters
>
> **word** `string` *required*
>
> Word to find synonyms and antonyms for. Must be a valid English word.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Timezone Information
>
> **Slug:** `API_NINJAS_GET_TIMEZONE`
>
> Tool to get timezone information for a location including UTC offset, local time, and timezone name. Use when you need timezone details for geographic locations or IANA timezone names. FREE tier supports timezone parameter; city, state, country, lat, and lon parameters require premium subscription.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** \$0.059 per 100 API requests
>
> **Discount:** 95
>
> #### Input Parameters
>
> **lat** `number`
>
> Latitude coordinate in decimal degrees (range: -90 to 90). PREMIUM ONLY - requires premium API subscription. Must be used with 'lon' parameter.
>
> **lon** `number`
>
> Longitude coordinate in decimal degrees (range: -180 to 180). PREMIUM ONLY - requires premium API subscription. Must be used with 'lat' parameter.
>
> **city** `string`
>
> City name to get timezone information. PREMIUM ONLY - requires premium API subscription.
>
> **state** `string`
>
> US state name or abbreviation (only for US cities). PREMIUM ONLY - requires premium API subscription.
>
> **country** `string`
>
> Country code (ISO 3166 alpha-2) or country name. PREMIUM ONLY - requires premium API subscription.
>
> **timezone** `string`
>
> IANA timezone name (e.g., 'America/New\_York', 'Europe/London', 'Asia/Tokyo'). Available in FREE tier. Use this to get timezone details by direct timezone name lookup.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Treasury Yield
>
> **Slug:** `API_NINJAS_GET_TREASURY_YIELD`
>
> Return the latest or dated Treasury par, real, bill, or combined yield curve.
>
> #### Input Parameters
>
> **date** `string`
>
> Business day in YYYY-MM-DD format; provider defaults to latest.
>
> **type** `string ("par" | "real" | "bill" | "all")`
>
> Treasury curve type.
>
> **format** `string ("json" | "csv")`
>
> Response format.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Treasury Yield History
>
> **Slug:** `API_NINJAS_GET_TREASURY_YIELD_HISTORY`
>
> Return a paginated Treasury yield time series for one maturity or full curves by date. Requires Premium only.
>
> #### Input Parameters
>
> **page** `string`
>
> Pagination cursor returned in the previous response's next field.
>
> **type** `string ("par" | "real" | "bill")`
>
> Treasury curve type; provider defaults to par.
>
> **format** `string ("json" | "csv")`
>
> Response format.
>
> **end\_date** `string`
>
> Inclusive range end in YYYY-MM-DD format.
>
> **maturity** `string ("month_1" | "month_1_5" | "month_2" | "month_3" | "month_4" | "month_6" | "year_1" | "year_2" | "year_3" | "year_5" | "year_7" | "year_10" | "year_20" | "year_30" | "week_4" | "week_6" | "week_8" | "week_13" | "week_17" | "week_26" | "week_52")`
>
> Single maturity code.
>
> **start\_date** `string`
>
> Inclusive range start in YYYY-MM-DD format.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Trivia Questions
>
> **Slug:** `API_NINJAS_GET_TRIVIA`
>
> Tool to retrieve trivia questions by category from API Ninjas. Returns trivia questions with answers from various categories like music, sports, science, and more. Use when you need trivia questions for games, quizzes, or entertainment purposes.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** \$0.059 per 100 API requests
>
> **Discount:** 95
>
> #### Input Parameters
>
> **limit** `integer`
>
> Number of trivia questions to return. Must be between 1 and 30. Default is 1. Note: Requesting more than 1 question is a premium feature.
>
> **category** `string ("artliterature" | "language" | "sciencenature" | "general" | "fooddrink" | "peopleplaces" | "geography" | "historyholidays" | "entertainment" | "toysgames" | "music" | "mathematics" | "religionmythology" | "sportsleisure")`
>
> Valid trivia categories for API Ninjas trivia endpoint.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Trivia of the Day
>
> **Slug:** `API_NINJAS_GET_TRIVIA_OF_THE_DAY`
>
> Tool to retrieve the trivia question of the day from API Ninjas. Returns the same trivia question for all users on a given day, with questions changing daily. Use when you need a daily trivia question to display or share.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** \$0.059 per 100 API requests
>
> **Discount:** 95
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Unemployment Rate
>
> **Slug:** `API_NINJAS_GET_UNEMPLOYMENT`
>
> Tool to get unemployment rate data for countries. Use when you need historical or current unemployment statistics by country or year.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** \$0.059 per 100 API requests
>
> **Discount:** 95
>
> #### Input Parameters
>
> **year** `integer`
>
> Year for which to retrieve unemployment data. At least one of country or year must be provided.
>
> **country** `string`
>
> Country name (case-insensitive) or 2-letter ISO-3166 alpha-2 code. Examples: 'Canada' or 'CA', 'United States' or 'US'. At least one of country or year must be provided.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get University Information
>
> **Slug:** `API_NINJAS_GET_UNIVERSITY`
>
> Tool to retrieve university information by name or country. Use when you need details about universities worldwide including location, contact info, enrollment, tuition, and degree programs offered. At least one search parameter (name or country) is required.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** \$0.059 per 100 API requests
>
> **Discount:** 95
>
> #### Input Parameters
>
> **name** `string`
>
> Name of the university to search for. Can be a partial match (e.g., 'Harvard', 'MIT', 'Stanford').
>
> **limit** `integer`
>
> Number of results to return (range: 1-30 for premium, max 5 for free tier).
>
> **offset** `integer`
>
> Pagination offset to skip the first N results. Premium feature.
>
> **country** `string`
>
> Country where university is located. Accepts an English country name or a 2- or 3-letter ISO country code.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Current Weather
>
> **Slug:** `API_NINJAS_GET_WEATHER`
>
> Tool to retrieve current weather data for a location. Use when you need real-time weather information including temperature, humidity, wind conditions, and sunrise/sunset times. Query by city name or GPS coordinates.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** \$0.059 per 100 API requests
>
> **Discount:** 95
>
> #### Input Parameters
>
> **lat** `number`
>
> Latitude coordinate (-90 to 90). Must be used together with lon parameter.
>
> **lon** `number`
>
> Longitude coordinate (-180 to 180). Must be used together with lat parameter.
>
> **city** `string`
>
> City name to get weather for. Must provide either city or coordinates (lat/lon).
>
> **state** `string`
>
> US state name or abbreviation (for US cities only). Use with city parameter to disambiguate locations.
>
> **country** `string`
>
> Country name or ISO 3166-1 alpha-2 code. Use with city parameter to disambiguate locations.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Weather Forecast
>
> **Slug:** `API_NINJAS_GET_WEATHER_FORECAST`
>
> Tool to retrieve 5-day weather forecast in 3-hour intervals for a location. Use when you need future weather predictions including temperature, humidity, wind, and sunrise/sunset times. Query by GPS coordinates or city name.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** \$0.059 per 100 API requests
>
> **Discount:** 95
>
> #### Input Parameters
>
> **lat** `number`
>
> Latitude coordinate (-90 to 90). Must be used together with lon parameter.
>
> **lon** `number`
>
> Longitude coordinate (-180 to 180). Must be used together with lat parameter.
>
> **zip** `string`
>
> 5-digit ZIP code for United States locations only (premium feature). Alternative to lat/lon.
>
> **city** `string`
>
> City name (premium feature). Alternative to lat/lon.
>
> **state** `string`
>
> US state name or abbreviation (for United States cities only, premium feature). Use with city parameter.
>
> **country** `string`
>
> Country name or ISO code (premium feature). Use with city parameter.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get WHOIS Information
>
> **Slug:** `API_NINJAS_GET_WHOIS`
>
> Tool to get WHOIS domain registration information including registrar, creation date, and expiration date. Use when you need details about domain registration.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** \$0.059 per 100 API requests
>
> **Discount:** 95
>
> #### Input Parameters
>
> **domain** `string` *required*
>
> Domain name to look up WHOIS information for (e.g., example.com). Top-level domains other than .com require a premium subscription.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Working Days
>
> **Slug:** `API_NINJAS_GET_WORKING_DAYS`
>
> Get working-day counts and dates for a country by year or month, accounting for weekends and public holidays. Weekend days and whether public holidays count as non-working days can be configured.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** \$0.059 per 100 API requests
>
> **Discount:** 95
>
> #### Input Parameters
>
> **year** `integer`
>
> Calendar year between 1980 and 2050 (inclusive). Defaults to current year if not specified.
>
> **month** `integer`
>
> Month number (1-12). If specified, returns working days for that specific month only.
>
> **country** `string` *required*
>
> Country code (2-letter ISO 3166-1 alpha-2 code, e.g., 'US' for United States, 'GB' for United Kingdom).
>
> **weekend** `array`
>
> Weekend days. Each item must be mon, tue, wed, thu, fri, sat, or sun. Overrides the country's default weekend.
>
> **public\_holidays** `boolean`
>
> Whether to include public holidays as non-working days. Defaults to true if not specified.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get World Time
>
> **Slug:** `API_NINJAS_GET_WORLDTIME`
>
> Tool to get current date and time for a location with detailed date/time components. Returns timezone, datetime, date, year, month, day, hour, minute, second, and day of the week. Use when you need detailed time information for a specific location or timezone.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** \$0.059 per 100 API requests
>
> **Discount:** 95
>
> #### Input Parameters
>
> **lat** `number`
>
> Latitude coordinate in decimal degrees (range: -90 to 90). PREMIUM ONLY - requires premium API subscription. Must be used with 'lon' parameter.
>
> **lon** `number`
>
> Longitude coordinate in decimal degrees (range: -180 to 180). PREMIUM ONLY - requires premium API subscription. Must be used with 'lat' parameter.
>
> **city** `string`
>
> City name to get current time. PREMIUM ONLY - requires premium API subscription.
>
> **timezone** `string`
>
> IANA timezone identifier (e.g., 'America/New\_York', 'Europe/London', 'Asia/Tokyo'). Available in FREE tier. Use this to get current time by timezone name.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get US Zipcode Location Info
>
> **Slug:** `API_NINJAS_GET_ZIPCODE`
>
> Tool to retrieve location information for US zip codes. Returns city, state, county, coordinates, timezone, and area codes. Use when you need to find location details for a zip code or search by city/state.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** \$0.059 per 100 API requests
>
> **Discount:** 95
>
> #### Input Parameters
>
> **zip** `string`
>
> The ZIP Code to look up (at least one of zip, city, or state must be provided).
>
> **city** `string`
>
> Full name of the city to search (case-sensitive). Premium tier required. At least one of zip, city, or state must be provided.
>
> **state** `string`
>
> 2-letter abbreviation of the state (case-insensitive). Premium tier required. At least one of zip, city, or state must be provided.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Airports
>
> **Slug:** `API_NINJAS_LIST_AIRPORTS`
>
> List airport ICAO codes and names with offset pagination. Requires Annual plans only.
>
> #### Input Parameters
>
> **offset** `integer`
>
> Number of results to offset for pagination. Default is 0.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Balance Sheet Periods
>
> **Slug:** `API_NINJAS_LIST_BALANCE_SHEET_PERIODS`
>
> Deprecated compatibility tool that lists only balance-sheet filing availability. Use API\_NINJAS\_LIST\_FINANCIAL\_STATEMENT\_PERIODS with statement\_type=balance\_sheet. Requires Premium only. \<\<DEPRECATED use API\_NINJAS\_LIST\_FINANCIAL\_STATEMENT\_PERIODS>>
>
> #### Input Parameters
>
> **cik** `string`
>
> Company Central Index Key, such as 796343. Exactly one of ticker or cik is required.
>
> **ticker** `string`
>
> Company ticker symbol, such as ADBE. Exactly one of ticker or cik is required.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Bank Holidays
>
> **Slug:** `API_NINJAS_LIST_BANK_HOLIDAYS`
>
> List bank holidays for a country and year, including regional and observed dates.
>
> #### Input Parameters
>
> **year** `integer`
>
> Calendar year between 1980 and 2050 (inclusive); a few countries cover fewer years. Defaults to the current year. Free plans can omit it or pass the current year; other years require a premium plan.
>
> **country** `string` *required*
>
> 2-letter ISO 3166-1 alpha-2 country code (preferred, e.g. US ), 3-letter alpha-3 code (e.g. USA ), or English country name (e.g. United States ). Not case-sensitive. Names must match exactly; common short names such as UK , USA , UAE and South Korea also work. An unrecognized country, or one without bank holiday data, returns a 400 error.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Breeds
>
> **Slug:** `API_NINJAS_LIST_BREEDS`
>
> List all cat or dog breed names accepted by the corresponding API Ninjas animal endpoint. Requires Premium.
>
> #### Input Parameters
>
> **species** `string ("cat" | "dog")` *required*
>
> Animal species whose accepted breed names to list.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Calorie Burning Activities
>
> **Slug:** `API_NINJAS_LIST_CALORIE_BURNING_ACTIVITIES`
>
> List activity names accepted by the Calories Burned calculator. Requires Premium only.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Car Generations
>
> **Slug:** `API_NINJAS_LIST_CAR_GENERATIONS`
>
> List vehicle generations for a make and model, optionally limited to generations with cars. Requires Business tier and above, or any annual plan.
>
> #### Input Parameters
>
> **make** `string` *required*
>
> Manufacturer.
>
> **year** `integer`
>
> Only generations in production in this year.
>
> **limit** `integer`
>
> Results to return, from 1 to 100.
>
> **model** `string` *required*
>
> Model.
>
> **offset** `integer`
>
> Results to skip.
>
> **has\_cars** `boolean`
>
> Omit generations with no cars.
>
> **chassis\_code** `string`
>
> Filter to one chassis code.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Car Makes
>
> **Slug:** `API_NINJAS_LIST_CAR_MAKES`
>
> List vehicle makes, optionally filtered by search text or model year. Requires Premium only.
>
> #### Input Parameters
>
> **year** `integer`
>
> Only makes with a car in production in this year.
>
> **limit** `integer`
>
> Results to return, from 1 to 100.
>
> **offset** `integer`
>
> Results to skip.
>
> **search** `string`
>
> Case-insensitive manufacturer substring.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Car Models
>
> **Slug:** `API_NINJAS_LIST_CAR_MODELS`
>
> List vehicle models for a make, optionally filtered by search text or model year. Requires Premium only.
>
> #### Input Parameters
>
> **make** `string` *required*
>
> Manufacturer.
>
> **year** `integer`
>
> Only models in production in this year.
>
> **limit** `integer`
>
> Results to return, from 1 to 100.
>
> **offset** `integer`
>
> Results to skip.
>
> **search** `string`
>
> Case-insensitive model substring.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Cash Flow Periods
>
> **Slug:** `API_NINJAS_LIST_CASH_FLOW_PERIODS`
>
> Deprecated compatibility tool that lists only cash-flow filing availability. Use API\_NINJAS\_LIST\_FINANCIAL\_STATEMENT\_PERIODS with statement\_type=cash\_flow. Requires Premium only. \<\<DEPRECATED use API\_NINJAS\_LIST\_FINANCIAL\_STATEMENT\_PERIODS>>
>
> #### Input Parameters
>
> **cik** `string`
>
> Company Central Index Key, such as 796343. Exactly one of ticker or cik is required.
>
> **ticker** `string`
>
> Company ticker symbol, such as ADBE. Exactly one of ticker or cik is required.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Cat Breeds
>
> **Slug:** `API_NINJAS_LIST_CAT_BREEDS`
>
> Deprecated compatibility tool for listing cat breeds; use List Dog Breeds only for the old dog-specific interface. Use API\_NINJAS\_LIST\_BREEDS with species=cat. Requires Premium only. \<\<DEPRECATED use API\_NINJAS\_LIST\_BREEDS>>
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Commodity Contracts
>
> **Slug:** `API_NINJAS_LIST_COMMODITY_CONTRACTS`
>
> List all available commodity futures contracts and their symbols; this endpoint accepts no root filter. Requires Business tier and above, or any annual plan.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Company Insiders
>
> **Slug:** `API_NINJAS_LIST_COMPANY_INSIDERS`
>
> List corporate insiders and current holdings for a public company. Requires Premium only.
>
> #### Input Parameters
>
> **cik** `string`
>
> Company Central Index Key, such as 789019. Exactly one of ticker or cik is required.
>
> **ticker** `string`
>
> Company ticker symbol, such as AAPL or MSFT. Exactly one of ticker or cik is required.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Countries
>
> **Slug:** `API_NINJAS_LIST_COUNTRIES`
>
> List 2-letter country codes accepted by the Country API. Requires Premium only.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Country Flags
>
> **Slug:** `API_NINJAS_LIST_COUNTRY_FLAGS`
>
> List country codes with square and rectangular SVG flag image URLs. Requires Premium only.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Crypto Symbols
>
> **Slug:** `API_NINJAS_LIST_CRYPTO_SYMBOLS`
>
> List cryptocurrency symbol pairs accepted by the Crypto Price API. Requires Premium only.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Dog Breeds
>
> **Slug:** `API_NINJAS_LIST_DOG_BREEDS`
>
> Deprecated compatibility tool for listing dog breeds; use List Cat Breeds only for the old cat-specific interface. Use API\_NINJAS\_LIST\_BREEDS with species=dog. Requires Premium only. \<\<DEPRECATED use API\_NINJAS\_LIST\_BREEDS>>
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Earnings Calendar Companies
>
> **Slug:** `API_NINJAS_LIST_EARNINGS_CALENDAR_COMPANIES`
>
> List companies covered by the earnings calendar. Requires Premium only.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Earnings Call Participants
>
> **Slug:** `API_NINJAS_LIST_EARNINGS_CALL_PARTICIPANTS`
>
> List executives or analysts who appeared on a company's earnings calls. Requires Business tier and above.
>
> #### Input Parameters
>
> **cik** `string`
>
> Company Central Index Key, such as 320193. Provide ticker or cik; at least one is required.
>
> **limit** `integer`
>
> Results per page. Default 50 (max 200 ).
>
> **offset** `integer`
>
> Number of results to skip. Default 0 .
>
> **ticker** `string`
>
> Company ticker symbol, such as AAPL. Provide ticker or cik; at least one is required.
>
> **sort\_by** `string ("appearance_count" | "last_appearance_date" | "name")`
>
> Sort field: appearance\_count (default), last\_appearance\_date , or name .
>
> **sort\_dir** `string ("asc" | "desc")`
>
> Sort direction: asc or desc .
>
> **speaker\_type** `string ("executive" | "analyst")`
>
> Restrict to executive (management roster) or analyst (covering analysts).
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Earnings Transcripts
>
> **Slug:** `API_NINJAS_LIST_EARNINGS_TRANSCRIPTS`
>
> List companies with available earnings-call transcripts. Requires Premium only.
>
> #### Input Parameters
>
> **limit** `integer`
>
> Number of results to return. Default is unlimited - all results will be returned.
>
> **offset** `integer`
>
> Number of results to skip for pagination. Default: 0 .
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Electric Vehicle Makes
>
> **Slug:** `API_NINJAS_LIST_ELECTRIC_VEHICLE_MAKES`
>
> List electric-vehicle makes available to the Electric Vehicle API. Requires Business tier and above, or any annual plan.
>
> #### Input Parameters
>
> **year** `integer`
>
> Filter manufacturers by year (e.g. 2023 ).
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Electric Vehicle Models
>
> **Slug:** `API_NINJAS_LIST_ELECTRIC_VEHICLE_MODELS`
>
> List electric-vehicle models for a selected make. Requires Business tier and above, or any annual plan.
>
> #### Input Parameters
>
> **make** `string` *required*
>
> Vehicle manufacturer (e.g. tesla ).
>
> **year** `integer`
>
> Vehicle model year (e.g. 2023 ).
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List ETFs
>
> **Slug:** `API_NINJAS_LIST_ETFS`
>
> List ETF ticker symbols available to the ETF API. Requires Business tier and above, or any annual plan.
>
> #### Input Parameters
>
> **offset** `integer`
>
> Number of results to skip for pagination. Default 0 . Page size is 1000 .
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Exercises
>
> **Slug:** `API_NINJAS_LIST_EXERCISES`
>
> List exercise names for a target muscle group with offset pagination. Requires Business tier and above, or any annual plan.
>
> #### Input Parameters
>
> **limit** `integer`
>
> Maximum number of results to return. Default is 10 , maximum is 100 .
>
> **muscle** `string ("abdominals" | "abductors" | "adductors" | "biceps" | "calves" | "chest" | "forearms" | "glutes" | "hamstrings" | "lats" | "lower_back" | "middle_back" | "neck" | "quadriceps" | "traps" | "triceps")` *required*
>
> Muscle group targeted by the exercise: abdominals, abductors, adductors, biceps, calves, chest, forearms, glutes, hamstrings, lats, lower\_back, middle\_back, neck, quadriceps, traps, or triceps.
>
> **offset** `integer`
>
> Number of results to offset for pagination. Default is 0 .
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Failures To Deliver
>
> **Slug:** `API_NINJAS_LIST_FAILURES_TO_DELIVER`
>
> List the latest and historical SEC failures-to-deliver records for a security.
>
> #### Input Parameters
>
> **limit** `integer`
>
> Number of records to return, 1 to 250. Defaults to 30. Free plans are limited to the latest record.
>
> **ticker** `string` *required*
>
> The stock or ETF ticker symbol (for example GME ).
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Financial Statement Periods
>
> **Slug:** `API_NINJAS_LIST_FINANCIAL_STATEMENT_PERIODS`
>
> List fiscal years and periods with an available balance sheet, cash-flow statement, or income statement for a company. Requires Premium.
>
> #### Input Parameters
>
> **cik** `string`
>
> Company SEC Central Index Key, such as 796343. Exactly one of ticker or cik is required.
>
> **ticker** `string`
>
> Company ticker symbol, such as ADBE. Exactly one of ticker or cik is required.
>
> **statement\_type** `string ("balance_sheet" | "cash_flow" | "income_statement")` *required*
>
> Financial statement availability to list: balance\_sheet, cash\_flow, or income\_statement.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Income Statement Periods
>
> **Slug:** `API_NINJAS_LIST_INCOME_STATEMENT_PERIODS`
>
> Deprecated compatibility tool for income-statement availability. Use API\_NINJAS\_LIST\_FINANCIAL\_STATEMENT\_PERIODS with statement\_type=income\_statement. Requires Premium only. \<\<DEPRECATED use API\_NINJAS\_LIST\_FINANCIAL\_STATEMENT\_PERIODS>>
>
> #### Input Parameters
>
> **cik** `string`
>
> Company Central Index Key, such as 796343. Exactly one of ticker or cik is required.
>
> **ticker** `string`
>
> Company ticker symbol, such as ADBE. Exactly one of ticker or cik is required.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Institutional Movers
>
> **Slug:** `API_NINJAS_LIST_INSTITUTIONAL_MOVERS`
>
> List securities with the largest recent institutional ownership changes. Requires Premium only.
>
> #### Input Parameters
>
> **cik** `string`
>
> Rank the moves within a single institution instead of market-wide.
>
> **limit** `integer`
>
> Number of ranked rows to return. Default 50, max 1000.
>
> **period** `string`
>
> Quarter-end date (YYYY-MM-DD); defaults to the latest quarter.
>
> **mover\_type** `string ("new_buys" | "exits" | "adds" | "trims")`
>
> new\_buys (default), exits , adds , or trims .
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List IPO Calendar
>
> **Slug:** `API_NINJAS_LIST_IPO_CALENDAR`
>
> List documented US IPO calendar records and filing details.
>
> #### Input Parameters
>
> **cik** `string`
>
> Numeric SEC CIK.
>
> **date** `string`
>
> Single date in YYYY-MM-DD format.
>
> **limit** `integer`
>
> Maximum records to return, from 1 to 1000.
>
> **offset** `integer`
>
> Records to skip.
>
> **status** `array`
>
> IPO lifecycle statuses to include: filed, amended, priced, listed, or withdrawn.
>
> **ticker** `string`
>
> Company ticker symbol.
>
> **date\_end** `string`
>
> Range end in YYYY-MM-DD format.
>
> **exchange** `string ("NASDAQ" | "NYSE" | "AMEX")`
>
> US exchange code.
>
> **sic\_code** `string`
>
> SEC SIC code, up to four digits.
>
> **deal\_type** `array`
>
> Deal types to include: ipo, spac\_ipo, or direct\_listing.
>
> **date\_field** `string ("listing_date" | "filing_date")`
>
> Date field to filter.
>
> **date\_start** `string`
>
> Range start in YYYY-MM-DD format.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Lottery Games
>
> **Slug:** `API_NINJAS_LIST_LOTTERY_GAMES`
>
> List documented lottery games and their rules.
>
> #### Input Parameters
>
> **game** `string`
>
> Return one game by slug.
>
> **state** `string`
>
> Return games in one US state or territory.
>
> **country** `string`
>
> Return games in one country.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Lottery Jackpots
>
> **Slug:** `API_NINJAS_LIST_LOTTERY_JACKPOTS`
>
> List current lottery jackpots using optional geography and currency filters. Requires Premium only.
>
> #### Input Parameters
>
> **min** `number`
>
> Minimum jackpot amount.
>
> **state** `string`
>
> US state or territory code.
>
> **country** `string`
>
> Alpha-2 country code.
>
> **currency** `string`
>
> ISO 4217 currency code.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Motorcycle Makes
>
> **Slug:** `API_NINJAS_LIST_MOTORCYCLE_MAKES`
>
> List motorcycle manufacturers accepted by the motorcycle API. Requires Business tier and above, or any annual plan.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Motorcycle Models
>
> **Slug:** `API_NINJAS_LIST_MOTORCYCLE_MODELS`
>
> List motorcycle models for a manufacturer. Requires Business tier and above, or any annual plan.
>
> #### Input Parameters
>
> **make** `string` *required*
>
> Motorcycle manufacturer.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Quote Authors
>
> **Slug:** `API_NINJAS_LIST_QUOTE_AUTHORS`
>
> List quote authors available to the Quotes API with offset pagination. Requires Premium only.
>
> #### Input Parameters
>
> **limit** `integer`
>
> Authors to return, from 1 to 500.
>
> **offset** `integer`
>
> Authors to skip.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Sales Tax Holidays
>
> **Slug:** `API_NINJAS_LIST_SALES_TAX_HOLIDAYS`
>
> Return US sales tax holiday periods, eligible categories, price caps, and coverage metadata.
>
> #### Input Parameters
>
> **date** `string`
>
> Date to test in YYYY-MM-DD format.
>
> **year** `integer`
>
> Calendar year; provider defaults to current year.
>
> **state** `string`
>
> Two-letter state code or full state name.
>
> **amount** `number`
>
> Item price in US dollars to test against a cap.
>
> **category** `string`
>
> Item category to test.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Short Interest Calendar
>
> **Slug:** `API_NINJAS_LIST_SHORT_INTEREST_CALENDAR`
>
> List short-interest settlement and publication dates for a calendar year.
>
> #### Input Parameters
>
> **year** `integer`
>
> Calendar year.
>
> **limit** `integer`
>
> Calendar entries to return.
>
> **upcoming** `boolean`
>
> Return upcoming reporting dates.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Stock Exchange Holidays
>
> **Slug:** `API_NINJAS_LIST_STOCK_EXCHANGE_HOLIDAYS`
>
> List market holidays and closure details for a stock exchange. Requires Business tier and above.
>
> #### Input Parameters
>
> **mic** `string`
>
> Market Identifier Code.
>
> **name** `string`
>
> Exchange name.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Stock Exchanges
>
> **Slug:** `API_NINJAS_LIST_STOCK_EXCHANGES`
>
> List all stock exchanges and their identity, location, market size, currency, timezone, and session details. Requires Business tier and above.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Stock News
>
> **Slug:** `API_NINJAS_LIST_STOCK_NEWS`
>
> List dated news articles for one or more stock tickers with offset pagination. Requires Premium only.
>
> #### Input Parameters
>
> **date** `string`
>
> Single UTC publication date in YYYY-MM-DD format; mutually exclusive with start\_date and end\_date.
>
> **offset** `integer`
>
> Results to skip, at most 10000.
>
> **ticker** `string`
>
> One ticker symbol or multiple symbols encoded as a comma-separated string.
>
> **end\_date** `string`
>
> Inclusive UTC publication range end in YYYY-MM-DD format; do not combine with date.
>
> **start\_date** `string`
>
> Inclusive UTC publication range start in YYYY-MM-DD format; do not combine with date.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Stock Splits
>
> **Slug:** `API_NINJAS_LIST_STOCK_SPLITS`
>
> List forward or reverse stock splits for a ticker or date range.
>
> #### Input Parameters
>
> **date** `string`
>
> Single effective date in YYYY-MM-DD format; mutually exclusive with date\_start and date\_end.
>
> **limit** `integer`
>
> Results to return, at most 1000.
>
> **offset** `integer`
>
> Results to skip.
>
> **ticker** `string`
>
> Company ticker symbol.
>
> **date\_end** `string`
>
> Effective-date range end in YYYY-MM-DD format; do not combine with date.
>
> **exchange** `string`
>
> Exchange code.
>
> **date\_start** `string`
>
> Effective-date range start in YYYY-MM-DD format; do not combine with date.
>
> **split\_type** `string ("forward" | "reverse")`
>
> Split direction.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Stock Tickers
>
> **Slug:** `API_NINJAS_LIST_STOCK_TICKERS`
>
> Tool to retrieve a paginated list of all available stock ticker symbols and company names. Use when you need to browse available stocks or find ticker symbols for specific companies. Returns company tickers and names with pagination support.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** \$0.059 per 100 API requests
>
> **Discount:** 95
>
> #### Input Parameters
>
> **limit** `integer` *required*
>
> Number of results to return. Must be between 1 and 1000.
>
> **offset** `integer` *required*
>
> Number of results to offset for pagination. Must be provided (use 0 for first page).
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Upcoming Earnings
>
> **Slug:** `API_NINJAS_LIST_UPCOMING_EARNINGS`
>
> List scheduled company earnings announcements by date or ticker. Requires Premium only.
>
> #### Input Parameters
>
> **date** `string`
>
> Single earnings date in YYYY-MM-DD format; mutually exclusive with start\_date and end\_date.
>
> **limit** `integer`
>
> Results to return, from 1 to 100.
>
> **offset** `integer`
>
> Results to skip.
>
> **ticker** `string`
>
> Company ticker.
>
> **end\_date** `string`
>
> Range end in YYYY-MM-DD format; provider defaults to ten years from today and this field must not be combined with date.
>
> **exchange** `string`
>
> Exchange code.
>
> **start\_date** `string`
>
> Range start in YYYY-MM-DD format; provider defaults to today and this field must not be combined with date.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Weather Icons
>
> **Slug:** `API_NINJAS_LIST_WEATHER_ICONS`
>
> List weather condition codes and their icon metadata. Requires Premium only.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Lookup BIN
>
> **Slug:** `API_NINJAS_LOOKUP_BIN`
>
> Look up issuer, country, and payment-network details for a BIN.
>
> #### Input Parameters
>
> **bin** `string` *required*
>
> The first 6 or 8 digits of a credit or debit card number.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Lookup BSB
>
> **Slug:** `API_NINJAS_LOOKUP_BSB`
>
> Look up an Australian BSB and return its bank, branch, address, and payment-network details.
>
> #### Input Parameters
>
> **bsb** `string` *required*
>
> The 6-digit Australian BSB number, with or without a hyphen (e.g. 062-000 or 062000 ).
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Lookup Canada Routing Number
>
> **Slug:** `API_NINJAS_LOOKUP_CANADA_ROUTING_NUMBER`
>
> Look up a Canadian routing number or transit and institution pair to return branch details.
>
> #### Input Parameters
>
> **routing\_number** `string`
>
> The 9-digit Canadian routing number in EFT format ( 0AAATTTTT ).
>
> **transit\_number** `string`
>
> The 5-digit branch transit number. Must be used together with institution\_number .
>
> **institution\_number** `string`
>
> The 3-digit financial institution number. Must be used together with transit\_number .
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Lookup DNS Records
>
> **Slug:** `API_NINJAS_LOOKUP_DNS_RECORDS`
>
> Tool to retrieve DNS records for a specified domain. Use when you need DNS record details for troubleshooting or validation.
>
> #### Input Parameters
>
> **domain** `string` *required*
>
> The domain to look up DNS records for (e.g., example.com). Top-level domains other than .com require a premium subscription.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Lookup IBAN
>
> **Slug:** `API_NINJAS_LOOKUP_IBAN`
>
> Tool to look up and validate an International Bank Account Number (IBAN). Use when you have an IBAN and need to retrieve its components (country, bank code, account number, etc.) and its validity.
>
> #### Input Parameters
>
> **iban** `string` *required*
>
> International Bank Account Number to look up
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Lookup India Pin Code
>
> **Slug:** `API_NINJAS_LOOKUP_INDIA_PIN_CODE`
>
> Look up Indian postal locations by PIN code, city, district, or state.
>
> #### Input Parameters
>
> **city** `string`
>
> Post office or locality name.
>
> **state** `string`
>
> State or union territory.
>
> **pincode** `string`
>
> Six-digit Indian PIN code; spaces and hyphens are accepted.
>
> **district** `string`
>
> District name.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Lookup IP Address
>
> **Slug:** `API_NINJAS_LOOKUP_IP_ADDRESS`
>
> Look up geolocation and ISP information for an IPv4 or IPv6 address. City, coordinates and ISP information may require Premium access.
>
> #### Input Parameters
>
> **address** `string` *required*
>
> IPv4 or IPv6 address to look up. Must be in IPv4 format A.B.C.D (e.g., 8.8.8.8) or IPv6 format X:X:X:X:X:X:X:X (e.g., 2001:0db8:85a3:0000:0000:8a2e:0370:7334).
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Lookup Phone Number
>
> **Slug:** `API_NINJAS_LOOKUP_PHONE_NUMBER`
>
> Deprecated compatibility tool using the phone-number lookup input and response. Use API\_NINJAS\_VALIDATE\_PHONE\_NUMBER. \<\<DEPRECATED use API\_NINJAS\_VALIDATE\_PHONE\_NUMBER>>
>
> #### Input Parameters
>
> **number** `string` *required*
>
> Phone number, including country code when country is omitted.
>
> **country** `string`
>
> Two-letter ISO 3166 country code.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Lookup Sort Code
>
> **Slug:** `API_NINJAS_LOOKUP_SORT_CODE`
>
> Look up a UK sort code and return its bank, branch, address, and payment capabilities.
>
> #### Input Parameters
>
> **sort\_code** `string` *required*
>
> UK bank sort code.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Lookup URL
>
> **Slug:** `API_NINJAS_LOOKUP_URL`
>
> Tool to get location information for a URL domain. Returns geolocation data including country, region, city, coordinates, ISP, and timezone. Use when you need to identify the geographic location or hosting provider of a URL.
>
> #### Input Parameters
>
> **url** `string` *required*
>
> Valid URL to check. It supports schemes (e.g., [http://example.com](http://example.com)) as well as schemeless formats (e.g., example.com).
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] VIN Lookup
>
> **Slug:** `API_NINJAS_LOOKUP_VIN`
>
> Tool to decode Vehicle Identification Number (VIN) and retrieve vehicle information. Returns make, model, year, manufacturing country, and VIN components. Use when you need to identify vehicle specifications from a 17-character VIN.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** \$0.059 per 100 API requests
>
> **Discount:** 95
>
> #### Input Parameters
>
> **vin** `string` *required*
>
> 17-character Vehicle Identification Number to decode
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Parse User Agent
>
> **Slug:** `API_NINJAS_PARSE_USER_AGENT`
>
> Parse a user-agent string into browser, operating-system, and device details.
>
> #### Input Parameters
>
> **user\_agent** `string` *required*
>
> User-agent string to parse.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Scrape Website Content
>
> **Slug:** `API_NINJAS_SCRAPE_WEBSITE`
>
> Tool to scrape HTML content from a URL using the API Ninjas Webscraper endpoint. Use when you need to retrieve website content programmatically without dealing with browser automation.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** \$0.059 per 100 API requests
>
> **Discount:** 95
>
> #### Input Parameters
>
> **url** `string` *required*
>
> The website address to retrieve content from (must be a valid URL).
>
> **text\_only** `boolean`
>
> When enabled, extracts visible text while filtering out HTML markup and metadata. Defaults to false (returns full HTML content).
>
> **user\_agent** `string`
>
> Custom User-Agent header string for the request. Use when you need to specify a particular browser or device identity.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Screen Sanctions
>
> **Slug:** `API_NINJAS_SCREEN_SANCTIONS`
>
> Screen a person or organization against supported sanctions lists and return candidate matches.
>
> #### Input Parameters
>
> **dob** `string`
>
> Date of birth in YYYY-MM-DD format.
>
> **name** `string` *required*
>
> Full name to screen.
>
> **country** `string`
>
> ISO 3166-1 alpha-2 country code.
>
> **sources** `array`
>
> Sanctions lists to search: OFAC, EU, UK, UN, or AU.
>
> **min\_score** `integer`
>
> Minimum confidence score from 0 to 100.
>
> **entity\_type** `string ("individual" | "entity" | "vessel" | "aircraft")`
>
> Entity type. Vessel and aircraft screening require Business tier and above.
>
> **nationality** `string`
>
> Nationality filter.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Screen Short Interest
>
> **Slug:** `API_NINJAS_SCREEN_SHORT_INTEREST`
>
> Screen securities by exchange and short-interest metrics. Requires Business tier and above.
>
> #### Input Parameters
>
> **limit** `integer`
>
> Results to return.
>
> **order** `string ("desc" | "asc")`
>
> Sort order.
>
> **sector** `string`
>
> Sector filter.
>
> **sort\_by** `string ("short_percent_float" | "short_percent_outstanding" | "days_to_cover" | "change_percent" | "dollar_volume_short" | "percentile_2y" | "shares_short")`
>
> Field used to sort results.
>
> **exchange** `string ("NYSE" | "NNM" | "SC" | "ARCA" | "BZX" | "AMEX" | "IEX" | "OTC")`
>
> Exchange filter.
>
> **min\_price** `number`
>
> Minimum share price.
>
> **settlement\_date** `string`
>
> Settlement date in YYYY-MM-DD format; provider defaults to latest.
>
> **min\_days\_to\_cover** `number`
>
> Minimum days to cover.
>
> **exclude\_capped\_float** `boolean`
>
> Exclude capped float estimates.
>
> **min\_shares\_outstanding** `integer`
>
> Minimum whole-share count outstanding.
>
> **min\_short\_percent\_float** `number`
>
> Minimum short percentage of float.
>
> **max\_float\_price\_gap\_days** `integer`
>
> Maximum integer float-price gap in days.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Search Bitcoin Treasuries
>
> **Slug:** `API_NINJAS_SEARCH_BITCOIN_TREASURIES`
>
> Deprecated Bitcoin-only treasury search. Use API\_NINJAS\_SEARCH\_CRYPTO\_TREASURIES with asset=BITCOIN. \<\<DEPRECATED use API\_NINJAS\_SEARCH\_CRYPTO\_TREASURIES>>
>
> #### Input Parameters
>
> **cik** `string`
>
> SEC Central Index Key of the filer, with or without leading zeros.
>
> **name** `string`
>
> Case-insensitive substring match on the filer name. Requires a Business or Professional subscription.
>
> **limit** `integer`
>
> Maximum results to return. Capped at 5 on Free, 50 on Developer, and 250 on Business and Professional.
>
> **offset** `integer`
>
> Number of results to skip, for pagination. Default is 0 , maximum is 10000 .
>
> **period** `string`
>
> Reporting period end as YYYY-MM-DD , or latest . Defaults to the most recent period. How far back you may query depends on your subscription tier.
>
> **ticker** `string`
>
> Stock ticker of the filer (e.g. MSTR ). Private filers have no ticker — use cik .
>
> **entity\_type** `string ("OPERATING" | "ETP" | "PRIVATE")`
>
> OPERATING for a company holding crypto on its balance sheet, ETP for an exchange-traded product whose holdings are the fund itself, or PRIVATE for a filer with no listed ticker.
>
> **include\_unverified** `boolean`
>
> Include filings whose unit count does not reconcile with their own reported fair value. Excluded by default; when included they are reproduced exactly as filed and carry a warning.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Search Branded Foods
>
> **Slug:** `API_NINJAS_SEARCH_BRANDED_FOODS`
>
> Find branded food nutrition by barcode, product name, or brand. Requires Premium only.
>
> #### Input Parameters
>
> **upc** `string`
>
> UPC or EAN for exact lookup.
>
> **name** `string`
>
> Product name to search for.
>
> **brand** `string`
>
> Brand-name filter.
>
> **limit** `integer`
>
> Maximum search results, from 1 to 50.
>
> **offset** `integer`
>
> Search results to skip, within the first 1000 matches.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Search Bsbs
>
> **Slug:** `API_NINJAS_SEARCH_BSBS`
>
> Search Australian BSB branches by bank, suburb, state, or postcode. Requires Premium only.
>
> #### Input Parameters
>
> **state** `string`
>
> Australian state or territory code (e.g. NSW, VIC, QLD).
>
> **offset** `integer`
>
> Number of results to offset for pagination.
>
> **suburb** `string`
>
> Suburb to search for branches.
>
> **postcode** `string`
>
> 4-digit Australian postcode to search for branches.
>
> **bank\_name** `string`
>
> Bank name to search for.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Search Canada Routing Numbers
>
> **Slug:** `API_NINJAS_SEARCH_CANADA_ROUTING_NUMBERS`
>
> Search Canadian bank branches by institution, city, province, or postal code. Requires Premium only.
>
> #### Input Parameters
>
> **city** `string`
>
> City name to search for branches.
>
> **offset** `integer`
>
> Number of results to offset for pagination.
>
> **province** `string`
>
> Two-letter province or territory code (e.g. ON, QC, BC).
>
> **bank\_name** `string`
>
> Bank name to search for.
>
> **postal\_code** `string`
>
> Postal code to search for branches.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Search Crypto Treasuries
>
> **Slug:** `API_NINJAS_SEARCH_CRYPTO_TREASURIES`
>
> Search SEC-reported cryptocurrency holdings across supported digital assets.
>
> #### Input Parameters
>
> **cik** `string`
>
> SEC Central Index Key of the filer, with or without leading zeros.
>
> **name** `string`
>
> Case-insensitive substring match on the filer name. Requires a Business or Professional subscription.
>
> **asset** `string ("BITCOIN" | "ETHEREUM" | "SOLANA" | "XRP" | "LITECOIN" | "DOGECOIN" | "CARDANO" | "INJECTIVE" | "CANTON" | "STABLECOIN" | "UNKNOWN")`
>
> Restrict to one asset: BITCOIN , ETHEREUM , SOLANA , XRP , LITECOIN , DOGECOIN , CARDANO , INJECTIVE , CANTON , STABLECOIN or UNKNOWN .
>
> **limit** `integer`
>
> Maximum results to return. Capped at 5 on Free, 50 on Developer, and 250 on Business and Professional.
>
> **offset** `integer`
>
> Number of results to skip, for pagination. Default is 0 , maximum is 10000 .
>
> **period** `string`
>
> Reporting period end as YYYY-MM-DD , or latest . Defaults to the most recent period. How far back you may query depends on your subscription tier.
>
> **ticker** `string`
>
> Stock ticker of the filer (e.g. MSTR ). Private filers have no ticker - use cik .
>
> **entity\_type** `string ("OPERATING" | "ETP" | "PRIVATE")`
>
> OPERATING for a company holding crypto on its balance sheet, ETP for an exchange-traded product whose holdings are the fund itself, or PRIVATE for a filer with no listed ticker.
>
> **include\_unverified** `boolean`
>
> Include filings whose unit count does not reconcile with their own reported fair value. Excluded by default; when included they are reproduced exactly as filed and carry a warning.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Search Earnings Call Speakers
>
> **Slug:** `API_NINJAS_SEARCH_EARNINGS_CALL_SPEAKERS`
>
> Search earnings-call speakers or retrieve one speaker's profile and appearance history. Requires Business tier and above.
>
> #### Input Parameters
>
> **name** `string`
>
> Case-insensitive speaker-name substring (search mode only).
>
> **role** `string`
>
> Role or title substring, such as CEO (search mode only).
>
> **year** `integer`
>
> Fiscal-year appearance filter.
>
> **limit** `integer`
>
> Page size: up to 100 speakers in search mode (default 25), or 200 appearances in detail mode (default 50).
>
> **offset** `integer`
>
> Number of speakers or appearances to skip.
>
> **ticker** `string`
>
> In search mode, require an appearance on this company's calls. In detail mode, filter appearance history to this company.
>
> **company** `string`
>
> Executive primary-company substring (search mode only).
>
> **quarter** `string ("1" | "2" | "3" | "4")`
>
> Fiscal-quarter appearance filter. In search mode, requires year.
>
> **sort\_by** `string ("appearance_count" | "last_appearance_date" | "name")`
>
> Speaker sort field (search mode only).
>
> **sort\_dir** `string ("asc" | "desc")`
>
> Speaker sort direction (search mode only).
>
> **speaker\_id** `string`
>
> Speaker identifier returned by search mode. Supplying it selects that speaker's profile and appearance history; search-only filters have no effect in this mode.
>
> **analyst\_firm** `string`
>
> Analyst-firm substring (search mode only).
>
> **speaker\_type** `string ("executive" | "analyst")`
>
> Speaker type (search mode only).
>
> **include\_appearances** `boolean`
>
> Include each speaker's appearance list in search results when true (search mode only).
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Search Earnings Transcripts
>
> **Slug:** `API_NINJAS_SEARCH_EARNINGS_TRANSCRIPTS`
>
> Find available earnings-call transcript records by company or call date; this does not search transcript text. Requires Premium only.
>
> #### Input Parameters
>
> **cik** `string`
>
> Company Central Index Key (e.g., 789019 ). For US companies registered with the SEC only.
>
> **date** `string`
>
> Filter results by earnings call date in YYYY-MM-DD format (e.g., 2024-05-02 ). Mutually exclusive with start\_date / end\_date .
>
> **limit** `integer`
>
> Maximum number of results to return. Default 20 ; values above 200 are clamped to 200 .
>
> **offset** `integer`
>
> Number of results to skip, for pagination. Default 0 .
>
> **ticker** `string`
>
> Company ticker symbol (e.g., AAPL ).
>
> **end\_date** `string`
>
> End of the earnings call date range (inclusive), in YYYY-MM-DD format. Must be paired with start\_date .
>
> **start\_date** `string`
>
> Start of the earnings call date range (inclusive), in YYYY-MM-DD format. Must be paired with end\_date . When both ticker and cik are omitted, the range cannot exceed 30 days.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Search ETFs
>
> **Slug:** `API_NINJAS_SEARCH_ETFS`
>
> Search ETFs by fund name, AUM, expense ratio, holdings, or listing country; use Get ETF for an exact ticker. Requires Business tier and above, or any annual plan.
>
> #### Input Parameters
>
> **name** `string`
>
> Fund name to search for (e.g. vanguard 500 matches Vanguard S\&P 500 ETF ). Case-insensitive. Each word must match the start of a word in the fund name, in any order, so ark matches ARK Innovation ETF but not Emerging Markets . Up to 12 words.
>
> **offset** `integer`
>
> Number of results to skip for pagination. Default 0 . Page size is 50 .
>
> **country** `string`
>
> Filter by ISO listing-country code - the exchange the ETF trades on (e.g. US , GB , JP ), not the fund's domicile.
>
> **max\_aum** `number`
>
> Maximum assets under management in USD.
>
> **min\_aum** `number`
>
> Minimum assets under management in USD (e.g. 10000000000 for \$10B).
>
> **holdings** `string`
>
> Comma-separated list of ticker symbols. Only ETFs that hold every listed ticker will be returned (AND match). Example: AAPL,MSFT .
>
> **max\_expense\_ratio** `number`
>
> Maximum annual expense ratio as a percentage.
>
> **min\_expense\_ratio** `number`
>
> Minimum annual expense ratio as a percentage (e.g. 0.1 for 0.1%).
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Search Institutional Holdings
>
> **Slug:** `API_NINJAS_SEARCH_INSTITUTIONAL_HOLDINGS`
>
> Search an institutional manager's holdings by manager CIK or exact manager name, with optional security and reporting-period filters.
>
> #### Input Parameters
>
> **cik** `string`
>
> Manager SEC Central Index Key (e.g. 1067983 ).
>
> **sort** `string ("value" | "shares" | "percent_of_portfolio" | "issuer_name")`
>
> value (default), shares , percent\_of\_portfolio , or issuer\_name .
>
> **cusip** `string`
>
> Filter the portfolio to a single holding by CUSIP.
>
> **limit** `integer`
>
> Number of results per page. Default 50, max 1000.
>
> **offset** `integer`
>
> Number of results to skip, for pagination.
>
> **period** `string`
>
> Quarter-end date (YYYY-MM-DD). Defaults to the latest quarter; free tier is limited to the most recent quarter.
>
> **ticker** `string`
>
> Filter the portfolio to a single holding by ticker.
>
> **group\_by** `string`
>
> Use sector for a sector-allocation rollup. Requires Business tier and above, or any annual plan.
>
> **put\_call** `string ("put" | "call")`
>
> put or call to filter option positions.
>
> **max\_value** `number`
>
> Maximum reported market value (USD).
>
> **min\_value** `number`
>
> Minimum reported market value (USD).
>
> **change\_type** `array`
>
> Quarter-over-quarter change filters. Requires Business tier and above, or any annual plan.
>
> **manager\_name** `string`
>
> Exact manager name (alternative to cik).
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Search Institutional Investors
>
> **Slug:** `API_NINJAS_SEARCH_INSTITUTIONAL_INVESTORS`
>
> Search the institutional-manager directory, filing history, or available quarters. Requires Premium only.
>
> #### Input Parameters
>
> **cik** `string`
>
> Institution CIK; selects filing-history mode.
>
> **name** `string`
>
> Institution-name substring; selects directory mode.
>
> **limit** `integer`
>
> Results per page. Default 50, maximum 1000.
>
> **offset** `integer`
>
> Number of results to skip.
>
> **period** `string`
>
> Quarter-end date in YYYY-MM-DD format; selects all filings for that quarter.
>
> **period\_list** `boolean`
>
> Set true to enumerate available quarters and filing counts.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Search Motor Carriers
>
> **Slug:** `API_NINJAS_SEARCH_MOTOR_CARRIERS`
>
> Search motor carriers using documented identity and location filters.
>
> #### Input Parameters
>
> **zip** `string`
>
> Physical-address ZIP code.
>
> **city** `string`
>
> Physical-address city.
>
> **name** `string`
>
> Normalized company-name prefix, at least three characters.
>
> **email** `string`
>
> Email address or domain reverse lookup.
>
> **limit** `integer`
>
> Results in this page, from 1 to 100.
>
> **phone** `string`
>
> Phone reverse lookup.
>
> **state** `string`
>
> Physical-address state.
>
> **offset** `integer`
>
> Results to skip, at most 10000.
>
> **status** `string ("active" | "inactive" | "pending")`
>
> Registration status.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Search NAICS Codes
>
> **Slug:** `API_NINJAS_SEARCH_NAICS_CODES`
>
> Search official NAICS text for relevant codes.
>
> #### Input Parameters
>
> **level** `string ("2" | "3" | "4" | "5" | "6")`
>
> Restrict to this code digit length, 2 through 6.
>
> **limit** `integer`
>
> Maximum matches, from 1 to 25.
>
> **query** `string` *required*
>
> Industry keyword or phrase, up to 300 characters.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Search Routing Numbers
>
> **Slug:** `API_NINJAS_SEARCH_ROUTING_NUMBERS`
>
> Search US routing numbers by bank name, location, ZIP code, or SWIFT code. Requires Premium only.
>
> #### Input Parameters
>
> **city** `string`
>
> City name.
>
> **state** `string`
>
> Two-letter state code.
>
> **offset** `integer`
>
> Results to skip.
>
> **zip\_code** `string`
>
> Five-digit ZIP code.
>
> **bank\_name** `string`
>
> Bank name.
>
> **swift\_code** `string`
>
> Eight- or eleven-character SWIFT/BIC code.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Search Sort Codes
>
> **Slug:** `API_NINJAS_SEARCH_SORT_CODES`
>
> Search UK bank branches by bank name, city, or postcode. Requires Premium only.
>
> #### Input Parameters
>
> **city** `string`
>
> City.
>
> **offset** `integer`
>
> Results to skip.
>
> **postcode** `string`
>
> Postcode.
>
> **bank\_name** `string`
>
> Bank name.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Search Tickers
>
> **Slug:** `API_NINJAS_SEARCH_TICKERS`
>
> Search public-company ticker symbols by company name and keyword exclusions. Requires Premium only.
>
> #### Input Parameters
>
> **name** `string` *required*
>
> Company name to search.
>
> **negative\_keywords** `string`
>
> Comma-separated company-name keywords to exclude.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Solve Sudoku Puzzle
>
> **Slug:** `API_NINJAS_SOLVE_SUDOKU`
>
> Tool to solve a Sudoku puzzle using the API Ninjas Sudoku Solver. Takes a partially filled puzzle grid and returns the complete solution if one exists. Use when you need to solve standard or custom-sized Sudoku puzzles (2x2, 3x3, or 4x4 box dimensions).
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** \$0.059 per 100 API requests
>
> **Discount:** 95
>
> #### Input Parameters
>
> **width** `integer` *required*
>
> Width of each box in the Sudoku grid. Must be between 2 and 4. For standard 9x9 Sudoku, use width=3.
>
> **height** `integer` *required*
>
> Height of each box in the Sudoku grid. Must be between 2 and 4. For standard 9x9 Sudoku, use height=3.
>
> **puzzle** `array` *required*
>
> Sudoku puzzle grid. Use 0 for empty cells.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Suggest Airports
>
> **Slug:** `API_NINJAS_SUGGEST_AIRPORTS`
>
> Suggest compact airport matches for a name or code query, optionally filtered by country and size. Requires Premium only.
>
> #### Input Parameters
>
> **size** `string ("large" | "medium" | "small")`
>
> Restrict results to a size. Must be one of: large , medium , small .
>
> **limit** `integer`
>
> Maximum number of results to return. Must be between 1 and 3. Default is 3.
>
> **query** `string` *required*
>
> Query string (minimum 2 characters).
>
> **country** `string`
>
> Restrict results to a country. Must be a 2-character ISO country code (e.g. US ).
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Update Counter
>
> **Slug:** `API_NINJAS_UPDATE_COUNTER`
>
> Increment or set persistent counter state scoped to the connected API key; use value=0 to reset a counter.
>
> #### Input Parameters
>
> **id** `string` *required*
>
> Counter identifier. Counter state persists across calls and is scoped to the connected API key.
>
> **value** `integer`
>
> Set the counter to this exact value; use 0 to reset it.
>
> **increment** `boolean`
>
> Set to true to increment the counter by one.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Validate Email
>
> **Slug:** `API_NINJAS_VALIDATE_EMAIL`
>
> Validate an email address and check its deliverability. Returns validity and domain information, whether the domain has MX records, disposability status, and email role categorization.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** \$0.059 per 100 API requests
>
> **Discount:** 95
>
> #### Input Parameters
>
> **email** `string` *required*
>
> Email address to validate and check deliverability.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Validate Phone Number Format
>
> **Slug:** `API_NINJAS_VALIDATE_PHONE`
>
> Validate phone-number formatting and return normalized national, international, and E.164 forms plus country, location, and time-zone information. This endpoint does not return carrier or line-type metadata; use Validate Phone Number for that lookup.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** \$0.059 per 100 API requests
>
> **Discount:** 95
>
> #### Input Parameters
>
> **number** `string` *required*
>
> Phone number to validate, including country code. Should be in international format with country code prefix (e.g., +12065550100). The API accepts various formats and will normalize to E.164 standard.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Validate Phone Number
>
> **Slug:** `API_NINJAS_VALIDATE_PHONE_NUMBER`
>
> Validate and normalize a phone number and return country, carrier, line-type, VoIP, mobile-network, and disposable-number metadata.
>
> #### Input Parameters
>
> **country** `string`
>
> Optional two-letter ISO 3166 country code for a national-format number.
>
> **phone\_number** `string` *required*
>
> Phone number to validate. Include a country calling code when country is omitted.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Validate Routing Number
>
> **Slug:** `API_NINJAS_VALIDATE_ROUTING_NUMBER`
>
> Tool to validate and retrieve bank information from a routing number. Use when you need to verify a 9-digit routing number and get associated bank details including name, location, and contact information.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** \$0.059 per 100 API requests
>
> **Discount:** 95
>
> #### Input Parameters
>
> **routing\_number** `string` *required*
>
> A 9-digit bank routing number to validate and look up
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Validate VAT Number
>
> **Slug:** `API_NINJAS_VALIDATE_VAT_NUMBER`
>
> Validate a VAT number and return its registration and business details.
>
> #### Input Parameters
>
> **vat** `string` *required*
>
> VAT number, optionally including its country prefix.
>
> **country** `string`
>
> Country code when vat has no prefix.
>
> **requester\_vat** `string`
>
> Requester VAT number for an official live consultation.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not
