Skip to main content
API Ninjas logo
  • 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

Slug: API_NINJAS_ANALYZE_NUTRITIONTool 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

string
required
Text to extract nutrition information from. Specify quantities if needed (e.g., ‘1lb brisket and fries’).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: API_NINJAS_ANALYZE_SENTIMENTTool 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 requestsDiscount: 95

Input Parameters

string
required
Text to analyze for sentiment. Maximum 2000 characters.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: API_NINJAS_ASSESS_NAICS_RISKAssess documented compliance risk indicators for NAICS codes. Requires Business tier and above.

Input Parameters

string
One 2- to 6-digit NAICS 2022 code. Supply exactly one of code or codes.
string
Comma-separated 2- to 6-digit NAICS codes for batch lookup, up to 500 codes. Supply exactly one of code or codes.
string ("kyb" | "card" | "lending")
Risk lens; omit for kyb.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: API_NINJAS_CALCULATE_AIRPORT_DISTANCECalculate great-circle distance, initial bearing, and estimated flight time between two airports. Requires Premium only.

Input Parameters

string
required
Destination airport — IATA (3 chars) or ICAO (4 chars) code.
string
required
Origin airport — IATA (3 chars) or ICAO (4 chars) code.
string ("km" | "mi" | "nm")
Distance units. Must be one of: km (default), mi , nm .

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: API_NINJAS_CALCULATE_CALORIES_BURNEDTool 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 requestsDiscount: 95

Input Parameters

number
Body weight in pounds, between 50 and 500. Default is 160 pounds.
string
required
Name of the activity (e.g., ‘running’, ‘swimming’, ‘cycling’).
integer
Duration in minutes. If not provided, API uses default (typically 60 minutes).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: API_NINJAS_CALCULATE_CURRENCY_VOLATILITYCalculate realized volatility and percentile context for a currency pair. Requires Premium only.

Input Parameters

string
required
Currency pair to query, in the form currency1_currency2 (e.g. EUR_USD ).
string ("close_to_close" | "ewma")
Volatility method: close_to_close (default) or ewma .
integer
Lookback window for the headline realized volatility, in trading days. Defaults to 30 . Must be between 2 and 1000.
integer ("252" | "365")
Annualization factor: 252 trading days (default) or 365 calendar days.
boolean
Whether to treat the annualized figure as the headline value. Defaults to true .

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: API_NINJAS_CALCULATE_INCOME_TAXTool 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

number
required
Annual income amount; must be non-negative.
string
required
State/province code (e.g., ‘CA’, ‘NY’, ‘ON’).
string ("US" | "CA")
required
2-letter country code (e.g., ‘US’ for United States, ‘CA’ for Canada). Currently only US and CA are supported.
number
Total tax credits amount; non-negative. Defaults to 0.
number
Total tax deductions amount; non-negative. Defaults to 0.
string ("single" | "married" | "married_separate" | "head_of_household")
Tax filing status; required for US. Possible values: ‘single’, ‘married’, ‘married_separate’, or ‘head_of_household’.
boolean
Set to true for self-employed tax calculations (US only). Defaults to false.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: API_NINJAS_CALCULATE_MORTGAGETool 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 requestsDiscount: 95

Input Parameters

number
Total value of the home or asset. Must be greater than downpayment.
number
Downpayment on the home or asset. Cannot exceed home_value.
number
Principal loan amount. Either this OR (home_value + downpayment) must be provided.
number
Monthly homeowner association fees
number
required
Annual interest rate (in %). For example, a 3.5% interest rate would be 3.5
integer
Loan duration in years (1-10000). Defaults to 30.
number
Annual property tax owed
number
Annual homeowner’s insurance bill

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: API_NINJAS_CALCULATE_PAYCHECK_WITHHOLDINGCalculate federal, FICA, and optional state paycheck withholding. Requires Premium only.

Input Parameters

string
Two-letter state code; omit for federal-only.
integer
Tax year; currently 2026.
number
required
Gross pay for this period in USD.
number
Year-to-date gross before this paycheck in USD.
integer
Pre-2020 W-4 allowances.
number
Annual deductions over the standard deduction in USD.
string ("weekly" | "biweekly" | "semimonthly" | "monthly" | "quarterly" | "semiannually" | "annually" | "daily")
required
Payroll period.
string ("2020_or_later" | "pre_2020")
W-4 worksheet version.
number
Annual other income in USD.
string ("single" | "married" | "married_separate" | "head_of_household")
required
Tax filing status.
boolean
W-4 multiple-jobs checkbox.
number
Annual dependent credit in USD.
number
Extra per-period federal withholding in USD.
number
Pre-tax deductions for this paycheck in USD.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: API_NINJAS_CALCULATE_SALES_TAXTool 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 requestsDiscount: 95

Input Parameters

string
City name (must be used with state parameter). Use this with state OR use zip_code for location.
string
State name (must be used with city parameter). Use this with city OR use zip_code for location.
number
required
Purchase amount to calculate sales tax on. Must be non-negative.
string
Valid US ZIP code (5 digits). Use this OR both city and state parameters for location.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: API_NINJAS_CHECK_BANK_HOLIDAYCheck whether banks are closed on a date in a country or subdivision.

Input Parameters

string
required
Date in YYYY-MM-DD format. Free supports past and current calendar years; future calendar years require Premium.
string
required
Country code or exact English country name.
string
ISO 3166-2 subdivision code.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: API_NINJAS_CHECK_DISPOSABLE_EMAILTool to check whether an email address is from a disposable email provider. Use when validating user emails prior to sending communications.

Input Parameters

string
required
The email address to check for disposability.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: API_NINJAS_CHECK_DOMAINTool 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 requestsDiscount: 95

Input Parameters

string
required
Valid domain to check (e.g., example.com). For top-level domains other than .com, a premium subscription is required.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: API_NINJAS_CHECK_HOLIDAYReturn 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

string
required
Date in YYYY-MM-DD format. Free supports past and current calendar years; future calendar years require Premium.
string
Country code or exact English country name.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: API_NINJAS_CHECK_IS_PUBLIC_HOLIDAYTool 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 requestsDiscount: 95

Input Parameters

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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: API_NINJAS_CHECK_IS_WORKING_DAYCheck 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 requestsDiscount: 95

Input Parameters

string
required
Date in YYYY-MM-DD format. Must be between 1980-01-01 and 2050-12-31 (inclusive).
string
required
Country code (2-letter ISO 3166-1 alpha-2 code, e.g., ‘US’ for United States, ‘GB’ for United Kingdom).
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.
boolean
Whether to include public holidays as non-working days. Defaults to true if not specified.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: API_NINJAS_CHECK_LOTTERY_TICKETScore a supported lottery ticket against a draw. Requires Premium only.

Input Parameters

string
required
Draw date in YYYY-MM-DD format. Developer covers the last two years; Business tier and above covers any supported draw.
string ("powerball" | "megamillions" | "millionaireforlife")
required
Supported lottery game slug.
string
required
Ticket bonus ball.
string
required
Comma-separated main ticket numbers.
string ("2" | "3" | "4" | "5" | "10")
Mega Millions printed multiplier.
boolean
Whether a Powerball ticket has Power Play.
boolean
Set to true to score the Double Play draw.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: API_NINJAS_CHECK_SALES_TAX_NEXUSEvaluate supplied sales and transaction totals against a state’s economic-nexus rules. Requires Premium only.

Input Parameters

string
Two-letter state code or full state name.
number
Revenue in US dollars measured using the state’s threshold definition.
number
Gross sales in US dollars delivered into the state.
number
Retail sales in US dollars delivered into the state.
integer
Count of transactions delivered into the state.
number
Taxable sales in US dollars delivered into the state.
number
Marketplace-facilitated sales in US dollars.
integer
Count of marketplace-facilitated transactions.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: API_NINJAS_CHECK_SPELLINGTool 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 requestsDiscount: 95

Input Parameters

string
required
The text to be spell-checked. Can be a single word or multiple words.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: API_NINJAS_CLASSIFY_BUSINESS_NAICSClassify a business description to a NAICS code. Requires Business tier and above.

Input Parameters

string
required
Business or establishment description, up to 2000 characters.
number
Minimum confidence from 0 to 1.
boolean
Whether to return rejected candidate codes.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: API_NINJAS_COMPUTE_TEXT_SIMILARITYTool 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 requestsDiscount: 95

Input Parameters

string
required
First text to compare for similarity.
string
required
Second text to compare for similarity.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: API_NINJAS_CONVERT_AIRPORT_CODEResolve an IATA, ICAO, GPS, ident, or local airport code to the matching airport record.

Input Parameters

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.
string
3-character IATA airport code. Supply exactly one of iata, icao, or code.
string
4-character ICAO airport code. Supply exactly one of iata, icao, or code.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: API_NINJAS_CONVERT_CURRENCYConvert 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 requestsDiscount: 95

Input Parameters

string
required
Source currency code (e.g., USD, EUR, GBP, JPY). The currency you currently have.
string
required
Target currency code (e.g., USD, EUR, GBP, AUD). The currency you want to convert to.
number
required
Amount to convert in the source currency. Must be a positive number.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: API_NINJAS_CONVERT_UNITConvert 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 requestsDiscount: 95

Input Parameters

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’).
number
required
The numerical value to convert. Must be a positive or negative number.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: API_NINJAS_DETECT_FACESDetect faces and return their pixel bounding boxes in a JPEG or PNG image.

Input Parameters

object
required
Image file containing faces. Must be either JPEG or PNG format.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: API_NINJAS_DETECT_OBJECTSDetect labeled objects and bounding boxes in a JPEG or PNG image smaller than 2000 by 2000 pixels.

Input Parameters

object
required
JPEG or PNG image smaller than 2000 by 2000 pixels.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: API_NINJAS_DETECT_TEXT_LANGUAGETool 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 requestsDiscount: 95

Input Parameters

string
required
Input text to detect language from. Maximum 1000 characters. For best results, use 10 words or more.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: API_NINJAS_EXTRACT_TEXT_FROM_IMAGEExtract text blocks and pixel bounding boxes from a JPEG or PNG image.

Input Parameters

object
required
JPEG or PNG image. Free accounts accept up to 200 KB; premium accounts accept up to 5 MB.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: API_NINJAS_EXTRACT_WEBPAGE_CONTENTRetrieve 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 requestsDiscount: 95

Input Parameters

string
required
The URL of the webpage to extract content from. Must be a valid HTTP or HTTPS URL.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: API_NINJAS_FILTER_PROFANITYTool 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 requestsDiscount: 95

Input Parameters

string
required
Text to filter for profanity. Maximum 1000 characters.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: API_NINJAS_FIND_CLOSEST_AIRPORTFind airports near coordinates, with distance and optional size, runway, and IATA filters. Requires Premium only.

Input Parameters

number
required
Latitude of the search center, in decimal degrees (-90 to 90).
number
required
Longitude of the search center, in decimal degrees (-180 to 180).
string ("large" | "medium" | "small")
Restrict to size: large , medium , or small .
integer
Maximum number of results. Must be between 1 and 50. Default is 10.
string ("km" | "mi")
Distance units. Must be km (default) or mi .
number
Search radius in kilometres. Default is 50, maximum is 500.
boolean
Filter by whether the airport has an IATA code ( true or false ).
number
Minimum runway length in feet.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: API_NINJAS_FIND_EV_CHARGING_STATIONSTool 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 requestsDiscount: 95

Input Parameters

number
required
Latitude coordinate of the search location.
number
required
Longitude coordinate of the search location.
integer
Filter by charging level: 1 (slow), 2 (medium), or 3 (fast/DC).
integer
Maximum number of results to return. Range: 1-30, default 3.
integer
Number of results to skip for pagination.
number
Search distance in kilometers defining the provider search box around the coordinates. Maximum 50 km, default 3 km.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: API_NINJAS_FORECAST_CURRENCY_VOLATILITYForecast currency-pair volatility across requested trading-day horizons. Requires Premium only.

Input Parameters

string
required
Currency pair to query, in the form currency1_currency2 (e.g. GBP_JPY ).
number
EWMA decay factor, used only when method=ewma . Defaults to 0.94 (RiskMetrics). Must be between 0.80 and 0.99.
string ("garch_11" | "ewma")
Forecast method: garch_11 (default) or ewma .
string
Comma-separated list of forecast horizons in trading days (e.g. 1,5,21,63 ). Defaults to 1,5,21,63 .
integer ("252" | "365")
Annualization factor: 252 trading days (default) or 365 calendar days.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: API_NINJAS_GENERATE_BARCODEGenerate a barcode image for specified text in PNG or SVG format. Returns the image data as a base64-encoded string.

Input Parameters

string
required
Text to encode in the barcode
string ("code39" | "code128" | "ean" | "ean13" | "ean8" | "gtin" | "isbn" | "isbn10" | "isbn13" | "issn" | "jan" | "pzn" | "upc" | "upca")
Type of barcode to generate. GS1 is not supported.
string ("png" | "svg")
Image format to return
boolean
Whether to include the text below the barcode

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: API_NINJAS_GENERATE_LOREM_IPSUMTool 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 requestsDiscount: 95

Input Parameters

integer
Number of paragraphs of Lorem Ipsum text to generate. Must be a positive integer. Defaults to 1 if not specified.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: API_NINJAS_GENERATE_PASSWORDTool 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 requestsDiscount: 95

Input Parameters

integer
Password length in characters. Default is 16.
boolean
Include numbers (0-9) in the password.
boolean
Include special characters (!@#$%^&*() etc.) in the password.
boolean
Compatibility option fixed to true: API Ninjas cannot exclude lowercase letters. False is not supported.
boolean
Compatibility option fixed to true: API Ninjas cannot exclude uppercase letters. False is not supported.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: API_NINJAS_GENERATE_QR_CODETool 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 requestsDiscount: 95

Input Parameters

string
required
Data to encode in the QR code. Can be any text, URL, or other string content.
string ("png" | "svg")
Output format for the QR code image. Choose ‘png’ for raster image or ‘svg’ for vector graphics.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: API_NINJAS_GENERATE_RANDOM_USERTool 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 requestsDiscount: 95

Input Parameters

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.
integer
Number of random user profiles to generate. Must be between 1 and 30. Default: 10
array
Profile fields to include in the response. Only these fields are returned.
string ("male" | "female" | "nonbinary" | "any")
Gender filter for random user generation
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’
array
Profile fields to exclude from the response. All other fields are returned.
integer
Maximum age for generated users. Must be between 0 and 1000. Default: 100
integer
Minimum age for generated users. Must be between 0 and 1000. Default: 0

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: API_NINJAS_GENERATE_SUDOKUTool 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 requestsDiscount: 95

Input Parameters

integer
Seed value for reproducible puzzle generation. Use the same seed to generate the same puzzle. Optional.
integer
Width of each box in the Sudoku grid. Must be between 2 and 4. Default is 3 (standard 9x9 Sudoku).
integer
Height of each box in the Sudoku grid. Must be between 2 and 4. Default is 3 (standard 9x9 Sudoku).
string ("easy" | "medium" | "hard")
Supported difficulty levels for Sudoku puzzle generation.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: API_NINJAS_GENERATE_TEXT_EMBEDDINGSTool 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 requestsDiscount: 95

Input Parameters

string
required
Text to generate embeddings for. Maximum 5,000 characters.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: API_NINJAS_GENERATE_TEXT_EMBEDDINGS_BATCHGenerate 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

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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: API_NINJAS_GENERATE_USER_AGENTTool 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 requestsDiscount: 95

Input Parameters

string
Operating system to filter by (e.g., ‘Windows’, ‘iOS’, ‘Android’, ‘macOS’, ‘Linux’). If not specified, any OS may be used.
string
Device manufacturer/brand to filter by (e.g., ‘Apple’, ‘Samsung’, ‘Google’, ‘LG’). If not specified, any brand may be used.
string
Device model name to filter by (e.g., ‘iPhone’, ‘Galaxy’, ‘Pixel’). If not specified, any model may be used.
string
Browser application to filter by (e.g., ‘Chrome’, ‘Firefox’, ‘Safari’, ‘Edge’). If not specified, any browser may be used.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: API_NINJAS_GET_ACCOUNT_ANALYTICSReturn connected-account subscription and API usage analytics while redacting the API key. Requires Professional or Enterprise; account-private and zero-quota.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: API_NINJAS_GET_ADVICETool 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 requestsDiscount: 95

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: API_NINJAS_GET_AIRCRAFTTool 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 requestsDiscount: 95

Input Parameters

string
Aircraft model name (e.g., ‘G550’, ‘747’, ‘Citation’).
integer
Maximum range in nautical miles. Filter aircraft with range less than or equal to this value.
integer
Maximum speed in knots. Filter aircraft with speed less than or equal to this value.
integer
Minimum range in nautical miles. Filter aircraft with range greater than or equal to this value.
integer
Minimum speed in knots. Filter aircraft with speed greater than or equal to this value.
string
Aircraft manufacturer name (e.g., ‘Gulfstream’, ‘Boeing’, ‘Cessna’).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: API_NINJAS_GET_AIRLINESTool 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

string
2-letter IATA airline code (e.g., ‘LH’ for Lufthansa, ‘SQ’ for Singapore Airlines).
string
3-letter ICAO airline code (e.g., ‘DLH’ for Lufthansa, ‘SIA’ for Singapore Airlines).
string
Airline name to search for (e.g., ‘Lufthansa’, ‘Singapore Airlines’). Partial matches are supported.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: API_NINJAS_GET_AIRPORTSTool 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 requestsDiscount: 95

Input Parameters

string
City name to search for airports (e.g., ‘New York’, ‘London’, ‘Paris’). Returns all airports in the specified city.
string
3-letter IATA airport code (e.g., ‘JFK’, ‘LHR’, ‘CDG’). Use this to search for a specific airport by its international code.
string
4-letter ICAO airport code (e.g., ‘KJFK’, ‘EGLL’, ‘LFPG’). Use this to search for a specific airport by its ICAO designation.
string
Airport name to search for (e.g., ‘John F Kennedy International Airport’, ‘Heathrow’). Partial matches are supported.
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).
string
Region or state to search for airports (e.g., ‘California’, ‘Texas’, ‘England’). Returns all airports in the specified region.
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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: API_NINJAS_GET_AIR_QUALITYTool 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 requestsDiscount: 95

Input Parameters

number
Latitude coordinate (-90 to 90). Must be used together with lon parameter.
number
Longitude coordinate (-180 to 180). Must be used together with lat parameter.
string
City name. Must provide either city or coordinates (lat/lon).
string
US state name or abbreviation (for US cities only). Use with city parameter to disambiguate locations.
string
Country name or ISO 3166-1 alpha-2 code. Use with city parameter to disambiguate locations.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: API_NINJAS_GET_ANIMALSTool 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 requestsDiscount: 95

Input Parameters

string
required
Common name of the animal to search for. Returns up to 10 matching results.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: API_NINJAS_GET_BABY_NAMESTool 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 requestsDiscount: 95

Input Parameters

string ("boy" | "girl" | "neutral")
Gender filter for baby names
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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: API_NINJAS_GET_BALANCE_SHEETDeprecated 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

string
Company Central Index Key (e.g., 796343). Supply exactly one of ticker or cik.
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.
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.
string
Company ticker symbol (e.g., ADBE). Supply exactly one of ticker or cik.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: API_NINJAS_GET_BITCOIN_MARKET_DATATool to retrieve the latest Bitcoin price and 24-hour market data. Use when you need real-time Bitcoin metrics in USD.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: API_NINJAS_GET_BITCOIN_PRICE_HISTORYDeprecated 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

integer
End timestamp in Unix format (in seconds). If not provided, defaults to current time.
integer
Maximum number of data points to return. Default is 100, maximum is 1000.
integer
Start timestamp in Unix format (in seconds). If not provided, the most recent limit data points are returned.
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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: API_NINJAS_GET_BUCKETLISTTool 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 requestsDiscount: 95

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: API_NINJAS_GET_CAR_FACETSReturn 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

string
Narrow counts to one body style.
string
Narrow counts to one fuel type.
string
Narrow counts to one manufacturer.
integer
Narrow counts to one production year.
string
Narrow counts to one drive type.
string
Narrow counts to one model.
array
required
Dimensions to group and count, from make, model, generation, chassis_code, body, doors, fuel, transmission, drive, cylinders, year, or badge.
string
Narrow counts to one generation.
string
Narrow counts to one transmission.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: API_NINJAS_GET_CARSQuery current car specifications by identity or documented filters. Requires Premium only.

Input Parameters

string
A stable car handle. Mutually exclusive with ids. At least one identity or filter field is required.
string
Comma-separated stable car handles, at most 50. Mutually exclusive with id. At least one identity or filter field is required.
string ("Sedan" | "Coupe" | "Convertible" | "Wagon" | "Hatchback" | "Liftback" | "SUV" | "MPV" | "Van" | "Pickup")
Body style.
string ("gasoline" | "diesel" | "electric" | "hybrid" | "plugin_hybrid" | "lpg" | "cng" | "hydrogen" | "ethanol")
Fuel type.
string
Manufacturer name.
string ("power_hp" | "-power_hp" | "year" | "-year" | "name" | "make")
Result ordering.
integer
Production year.
string
Model designation.
integer
Number of doors.
string ("fwd" | "rwd" | "awd" | "4wd")
Drive type.
integer
Results to return.
string
Model name.
integer
Results to skip.
integer
Maximum production year.
integer
Minimum production year.
integer
Number of cylinders.
string ("gas" | "diesel" | "electricity")
Legacy fuel filter. Used as-is with MPG filters; otherwise gas maps to gasoline and electricity maps to electric.
string
Vehicle generation.
string
Manufacturer engine code.
integer
Legacy maximum highway-MPG filter. Supplying it uses the v1 Cars API.
integer
Legacy minimum highway-MPG filter. Supplying it uses the v1 Cars API.
string
Chassis code.
integer
Legacy maximum city-MPG filter. Supplying it uses the v1 Cars API.
number
Maximum horsepower.
integer
Legacy minimum city-MPG filter. Supplying it uses the v1 Cars API.
number
Minimum horsepower.
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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: API_NINJAS_GET_CASH_FLOWDeprecated 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

string
Company Central Index Key (e.g., 796343). Supply exactly one of ticker or cik.
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.
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.
string
Company ticker symbol (e.g., ADBE). Supply exactly one of ticker or cik.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: API_NINJAS_GET_CATSTool 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 requestsDiscount: 95

Input Parameters

string
Cat breed name to search for (e.g., ‘persian’, ‘siamese’). Partial matches are supported.
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).
integer
Grooming needs on a scale of 1-5, where 1 requires maximum grooming effort and 5 requires minimum grooming effort.
integer
Shedding level on a scale of 1-5, where 1 is minimal shedding and 5 is heavy shedding.
integer
Maximum weight in pounds. Must be greater than min_weight if both are specified.
integer
Minimum weight in pounds. Must be less than max_weight if both are specified.
integer
Playfulness level on a scale of 1-5, where 1 is less playful and 5 is very playful.
integer
Family friendliness level on a scale of 1-5, where 1 is less family-friendly and 5 is very family-friendly.
integer
Maximum life expectancy in years. Must be greater than min_life_expectancy if both are specified.
integer
Minimum life expectancy in years. Must be less than max_life_expectancy if both are specified.
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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: API_NINJAS_GET_CELEBRITYTool 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 requestsDiscount: 95

Input Parameters

string
Name of the celebrity you wish to search. This field is case-insensitive.
integer
Number of results to offset for pagination.
number
Maximum height of celebrities in meters.
number
Minimum height of celebrities in meters.
string
Nationality of celebrities. Must be an ISO 3166 Alpha-2 country code (e.g., US, GB, FR).
integer
Maximum net worth of celebrities in US dollars.
integer
Minimum net worth of celebrities in US dollars.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: API_NINJAS_GET_CHUCK_NORRIS_JOKETool 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 requestsDiscount: 95

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: API_NINJAS_GET_CITYTool 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 requestsDiscount: 95

Input Parameters

string
City name to search for (e.g., ‘London’, ‘New York’).
integer
Number of results to return per request (range: 1-30). Premium feature only.
integer
Pagination offset to skip the first N results.
string
ISO-3166 alpha-2 country code to filter cities (e.g., ‘US’, ‘GB’, ‘JP’).
number
Maximum latitude coordinate for geographic filtering (range: -90 to 90).
number
Maximum longitude coordinate for geographic filtering (range: -180 to 180).
number
Minimum latitude coordinate for geographic filtering (range: -90 to 90).
number
Minimum longitude coordinate for geographic filtering (range: -180 to 180).
integer
Maximum population count for filtering cities.
integer
Minimum population count for filtering cities.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: API_NINJAS_GET_COCKTAILTool 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 requestsDiscount: 95

Input Parameters

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.
string
Comma-separated ingredients to search for. At least one of name or ingredients is required. Uses AND logic and is case-insensitive.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: API_NINJAS_GET_COMMODITY_CONTRACTReturn one contract by exact symbol, or all matching contracts by root symbol. Requires Business tier and above, or any annual plan.

Input Parameters

string
Specific contract symbol to look up (e.g., GCK26). Supply exactly one of symbol or symbol_root.
string
Commodity root to filter contracts (e.g., GC returns GCK26 and GCM26). Supply exactly one of symbol or symbol_root.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: API_NINJAS_GET_COMMODITY_FORWARD_CURVEReturn every active futures contract, sorted by month, for one commodity forward curve. Requires Business tier and above, or any annual plan.

Input Parameters

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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: API_NINJAS_GET_COMMODITY_MARKET_SNAPSHOTReturn a current commodity market snapshot across supported contracts.

Input Parameters

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 .
string ("CME" | "NYMEX" | "COMEX" | "ICE")
Filter to commodities listed on a single exchange. One of CME , NYMEX , COMEX , ICE .

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: API_NINJAS_GET_COMMODITY_PRICEGet 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

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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: API_NINJAS_GET_COMMODITY_PRICE_HISTORYReturn historical commodity futures OHLCV prices without silently accepting a provider-truncated series. Requires Premium only.

Input Parameters

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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: API_NINJAS_GET_COMMODITY_SPOT_PRICEReturn 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

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).
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.
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.
string
ISO 4217 currency code to convert prices into (e.g. EUR , GBP ). Defaults to USD.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: API_NINJAS_GET_COMPANY_LOGORetrieve 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 requestsDiscount: 95

Input Parameters

string
Company name that supports partial matching (case-insensitive). Either name or ticker is required.
string
Company ticker symbol for publicly traded companies. Either name or ticker is required.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: API_NINJAS_GET_COMPANY_PROFILERetrieve 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

string
required
Stock ticker symbol (e.g., ‘AAPL’, ‘MSFT’, ‘GOOGL’)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: API_NINJAS_GET_COUNTERDeprecated 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

string
required
ID to specify the counter. Use a new id to create a new counter.
boolean
Increments counter by 1 when set to true. If false or not provided, counter is not incremented.
integer
Sets counter to specific value. Use 0 to reset the counter. If provided, this overrides the ‘hit’ parameter.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: API_NINJAS_GET_COUNTER_VALUERead the current value of a persistent counter scoped to the connected API key without incrementing or setting it.

Input Parameters

string
required
Identifier of an existing counter in persistent state scoped to the connected API key.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: API_NINJAS_GET_COUNTRY_FLAGTool 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 requestsDiscount: 95

Input Parameters

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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: API_NINJAS_GET_COUNTRY_INFOTool 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 requestsDiscount: 95

Input Parameters

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.
integer
How many results to return. Must be between 1 and 30. Default is 5.
number
Maximum gross domestic product (GDP) of country, in US Dollars.
number
Minimum gross domestic product (GDP) of country, in US Dollars.
number
Maximum fertility rate, in average children per woman.
number
Minimum fertility rate, in average children per woman.
number
Maximum GDP growth rate in %.
integer
Maximum population of country, in thousands.
number
Minimum GDP growth rate in %.
integer
Minimum population of country, in thousands.
number
Maximum surface area of country in km2.
number
Maximum unemployment rate in %.
number
Minimum surface area of country in km2.
number
Minimum unemployment rate in %.
number
Maximum infant mortality rate per 1,000 live births.
number
Minimum infant mortality rate per 1,000 live births.
number
Maximum urban population rate in %.
number
Minimum urban population rate in %.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: API_NINJAS_GET_COUNTYTool 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 requestsDiscount: 95

Input Parameters

integer
Number of results to return. Must be between 1 and 30. Default is 1. Premium only.
string
2-letter state code (e.g., ‘CA’, ‘OR’, ‘NY’). At least one of county, zipcode, or state must be provided.
string
Full county name (e.g., ‘Los Angeles County’, ‘Multnomah County’). At least one of county, zipcode, or state must be provided.
integer
Number of results to offset for pagination. Default is 0. Premium only.
string
5-digit ZIP code to search for county information. At least one of county, zipcode, or state must be provided.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: API_NINJAS_GET_COVID19_DATAReturn COVID-19 case or death statistics for a country or date.

Input Parameters

string
Date for a single-day snapshot in YYYY-MM-DD format. At least one of date or country is required.
string ("cases" | "deaths")
Metric to retrieve. Defaults to cases.
string
US county name. Requires country=United States and a region.
string
Administrative region. Requires country; omitting it returns every region available for that country.
string
Country name (case-insensitive). At least one of date or country is required.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: API_NINJAS_GET_CRYPTO_PRICEGet 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

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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: API_NINJAS_GET_CRYPTO_PRICE_HISTORYReturn historical cryptocurrency OHLCV prices for a symbol and interval. Requires Premium only.

Input Parameters

integer
End timestamp in Unix format (in seconds). If not provided, defaults to current time.
integer
Maximum number of data points to return. Default is 100, maximum is 1000.
integer
Start timestamp in Unix format (in seconds). If not provided, defaults to 24 hours ago.
string
required
Cryptocurrency symbol (e.g. ETHUSDT , BTCUSD ). Crypto-quoted and USD-quoted symbols only; other fiat quotes are not available on this endpoint.
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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: API_NINJAS_GET_CURRENCY_VOLATILITY_HISTORYReturn historical realized-volatility observations for a currency pair. Requires Premium only.

Input Parameters

integer
Length of the trailing date range in calendar days, ending today. Defaults to 90 . Maximum 1825. Mutually exclusive with start_date / end_date .
string
required
Currency pair to query, in the form currency1_currency2 (e.g. EUR_USD ).
string ("close_to_close" | "ewma")
Volatility method: close_to_close (default) or ewma .
integer
Rolling window for volatility, in trading days. Defaults to 30 .
string
End of the date range, in YYYY-MM-DD form. Provide together with start_date .
integer ("252" | "365")
Annualization factor: 252 trading days (default) or 365 calendar days.
boolean
Whether to treat the annualized figure as the headline value. Defaults to true .
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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: API_NINJAS_GET_DAD_JOKETool 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 requestsDiscount: 95

Input Parameters

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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: API_NINJAS_GET_DAY_IN_HISTORYTool 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 requestsDiscount: 95

Input Parameters

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.
integer
The maximum number of results to return. Must be between 1 and 30. Default is 1.
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.
integer
The number of results to skip. Must be zero or a positive integer. Used for pagination. Default is 0.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: API_NINJAS_GET_DICTIONARY_DEFINITIONTool 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 requestsDiscount: 95

Input Parameters

string
required
Word to look up in the dictionary. Must be a valid English word.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: API_NINJAS_GET_DOGSTool 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 requestsDiscount: 95

Input Parameters

string
Dog breed name to search for (e.g., ‘husky’, ‘labrador’).
integer
Energy level (1-5, where 1 is lowest and 5 is highest).
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).
integer
Barking level (1-5, where 1 is lowest and 5 is highest).
integer
Shedding level (1-5, where 1 is lowest and 5 is highest).
integer
Maximum height in inches.
integer
Maximum weight in pounds.
integer
Minimum height in inches.
integer
Minimum weight in pounds.
integer
Trainability level (1-5, where 1 is lowest and 5 is highest).
integer
Protectiveness level (1-5, where 1 is lowest and 5 is highest).
integer
Maximum life expectancy in years.
integer
Minimum life expectancy in years.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: API_NINJAS_GET_EARNINGSRetrieve 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 requestsDiscount: 95

Input Parameters

string
Company Central Index Key. Mutually exclusive with ticker. Supply a company identifier, date, or complete date range.
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.
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.
integer
Results to skip; pages contain 50.
string ("q1" | "q2" | "q3" | "q4" | "fy")
Fiscal period. Mutually exclusive with quarter and requires a company identifier and year.
string
Company ticker symbol. Mutually exclusive with cik. Supply a company identifier, date, or complete date range.
string ("1" | "2" | "3" | "4")
Fiscal quarter. Mutually exclusive with period and requires a company identifier and year.
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.
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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: API_NINJAS_GET_EARNINGS_CALENDARReturns historical actual and estimated EPS and revenue by stock ticker, with an option for premium subscribers to include upcoming scheduled earnings dates.

Input Parameters

integer
Maximum number of earnings records to return (1-100). Premium subscribers only.
string
required
Stock ticker symbol to get earnings data for (e.g., ‘AAPL’, ‘MSFT’, ‘GOOGL’).
boolean
Whether to include upcoming/scheduled earnings dates in addition to past earnings. Defaults to false. Premium subscribers only.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: API_NINJAS_GET_EARNINGS_CALL_TRANSCRIPTRetrieve 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

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.
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.
string
Company stock ticker symbol (e.g., ‘AAPL’ for Apple Inc.). Either ticker or cik must be provided.
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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: API_NINJAS_GET_ELECTRIC_VEHICLE_INFOGet 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 requestsDiscount: 95

Input Parameters

string
Vehicle manufacturer (e.g., ‘tesla’, ‘nissan’, ‘chevrolet’). Case-insensitive.
integer
How many results to return. Must be between 1 and 10. Default is 1.
string
Vehicle model (e.g., ‘model3’, ‘leaf’, ‘bolt’). Case-insensitive.
integer
Number of results to skip for pagination. Default is 0.
integer
Maximum vehicle model year (e.g., 2023). Filter results to vehicles up to this year.
integer
Minimum vehicle model year (e.g., 2020). Filter results to vehicles from this year onwards.
integer
Maximum electric range in kilometers (e.g., 600). Filter results to vehicles with at most this range.
integer
Minimum electric range in kilometers (e.g., 250). Filter results to vehicles with at least this range.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: API_NINJAS_GET_EMOJITool 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 requestsDiscount: 95

Input Parameters

string
Unicode character code for the emoji (e.g., ‘U+1F642’). Must be uppercase with U+ prefix.
string
Descriptive name of emoji to search for (e.g., ‘smile’, ‘heart’).
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.
integer
Number of results to offset for pagination. Use this to retrieve results beyond the first 30. Default is 0.
string
Sub-category to filter emojis within a group. The subgroup must be valid for the selected group.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: API_NINJAS_GET_ETF_INFORetrieve 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

string
required
ETF ticker symbol. Case-insensitive. Examples: ‘SPY’ (S&P 500), ‘QQQ’ (NASDAQ-100), ‘VTI’ (Total Stock Market), ‘BND’ (Bond Market).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: API_NINJAS_GET_EU_VAT_RATESRetrieve current or historical EU VAT rates by country, with optional VAT type and effective-date filters.

Input Parameters

string ("standard" | "reduced" | "super_reduced" | "exempted" | "parking")
Enumeration of VAT rate classifications.
integer
Number of results to return. Must be between 1 and 30. Default is 5. Premium accounts only.
integer
Number of results to skip for pagination. Default is 0. Use with limit to paginate through results. Premium accounts only.
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).
string
Filter results to only include VAT rates effective before this date. Must be in YYYY-MM-DD format (e.g., ‘2024-12-31’).
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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: API_NINJAS_GET_EXCHANGE_RATEGet 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 requestsDiscount: 95

Input Parameters

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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: API_NINJAS_GET_EXCHANGE_RATE_HISTORYReturn historical exchange rates for a currency pair and date range. Requires Premium only.

Input Parameters

string
Single date to query, in YYYY-MM-DD format. Either date OR both start_date and end_date must be provided.
string
required
Currency pair to query. Must be in the form of currency1_currency2 (e.g. USD_EUR ).
string
End date of a range query, in YYYY-MM-DD format. Date range cannot exceed 180 days.
string
Start date of a range query, in YYYY-MM-DD format. Must be used together with end_date .

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: API_NINJAS_GET_EXECUTIVE_COMPENSATIONReturn disclosed executive compensation records for a public company.

Input Parameters

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.
string
Company name to search for (for example Apple). Exactly one of ticker, name, or cik is required.
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.
string
The company’s stock ticker (for example AAPL). Exactly one of ticker, name, or cik is required.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: API_NINJAS_GET_EXERCISESTool 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 requestsDiscount: 95

Input Parameters

string
Name of the exercise to search for. Searches for exercises matching this name.
string ("cardio" | "olympic_weightlifting" | "plyometrics" | "powerlifting" | "strength" | "stretching" | "strongman")
Exercise type categories
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.
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).
string ("beginner" | "intermediate" | "expert")
Exercise difficulty levels

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: API_NINJAS_GET_FACT_OF_THE_DAYTool 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 requestsDiscount: 95

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: API_NINJAS_GET_FACTSTool 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 requestsDiscount: 95

Input Parameters

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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: API_NINJAS_GET_FINANCIAL_STATEMENTRetrieve one balance sheet, cash-flow statement, or income statement and its SEC filing metadata for a company and fiscal period.

Input Parameters

string
Company SEC Central Index Key, such as 796343. Exactly one of ticker or cik is required.
integer
Fiscal year after 2000. Provide period and year together.
string ("q1" | "q2" | "q3" | "q4" | "fy")
Fiscal period. Provide period and year together; omit both for the latest statement.
string
Company ticker symbol, such as ADBE. Exactly one of ticker or cik is required.
string ("balance_sheet" | "cash_flow" | "income_statement")
required
Financial statement to retrieve: balance_sheet, cash_flow, or income_statement.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: API_NINJAS_GET_GDPTool 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 requestsDiscount: 95

Input Parameters

integer
Year for which to retrieve GDP data. At least one of country or year must be set.
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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: API_NINJAS_GET_GEOCODINGTool 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 requestsDiscount: 95

Input Parameters

string
required
City name to geocode. Required parameter for converting a city location to latitude and longitude coordinates.
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’).
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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: API_NINJAS_GET_GOLD_PRICEReturn the current COMEX gold futures price and contract month; use Get Gold Spot Price for immediate-delivery spot pricing.

Input Parameters

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 .
string
ISO 4217 currency code to convert the price into (e.g. EUR , GBP ). Defaults to USD.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: API_NINJAS_GET_GOLD_PRICE_HISTORYReturn historical COMEX gold futures OHLCV observations. Requires Premium only.

Input Parameters

integer
End timestamp in Unix format. If not provided, defaults to current time.
integer
Start timestamp in Unix format. If not provided, defaults to 24 hours ago.
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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: API_NINJAS_GET_GOLD_SPOT_PRICEReturn current immediate-delivery gold spot pricing, bid, and ask; use Get Gold Price for COMEX futures. Requires Premium only.

Input Parameters

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 .
string
ISO 4217 currency code to convert prices into (e.g. EUR , GBP , INR ). Defaults to USD.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: API_NINJAS_GET_HELICOPTERTool 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 requestsDiscount: 95

Input Parameters

integer
Number of results to return. Must be between 1 and 30. Defaults to 1 if not specified.
string
Helicopter model name (e.g., ‘206L-3’, ‘UH-60’).
number
Maximum range in nautical miles.
number
Maximum air speed ceiling in knots.
number
Minimum range in nautical miles.
number
Minimum maximum air speed in knots.
number
Maximum height in feet.
number
Maximum length in feet.
number
Minimum height in feet.
number
Minimum length in feet.
string
Company that designed and built the helicopter (e.g., ‘Bell’, ‘Airbus’, ‘Sikorsky’).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: API_NINJAS_GET_HISTORICAL_EVENTSTool 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 requestsDiscount: 95

Input Parameters

integer
Calendar day of the month to filter events (1-31).
string
Keywords or short phrases to search events. Useful for finding events related to specific topics or people.
integer
4-digit year to filter events. Use negative values for BC/BCE dates (e.g., -351 for 351 BC).
integer
Month number to filter events (1-12, e.g., 3 for March).
integer
Number of results to offset for pagination. Premium feature only.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: API_NINJAS_GET_HISTORICAL_FIGURESTool 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 requestsDiscount: 95

Input Parameters

string
required
Name of the person to search. Supports partial matching (e.g., ‘julius’ will match Julius Caesar). Case-insensitive.
integer
Number of results to offset for pagination.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: API_NINJAS_GET_HOBBIESTool 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 requestsDiscount: 95

Input Parameters

string ("general" | "sports_and_outdoors" | "education" | "collection" | "competition" | "observation")
Hobby category options

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: API_NINJAS_GET_HOLIDAYSRetrieve 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

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.
integer
Calendar year from 2005 through 2039. Free plans can omit it or use the current year; other years require Premium.
string
required
ISO alpha-2/alpha-3 code or exact English country name.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: API_NINJAS_GET_HOROSCOPETool 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 requestsDiscount: 95

Input Parameters

string
Historical horoscope retrieval in YYYY-MM-DD format (premium feature). Must be current date or earlier. Defaults to today’s date if omitted.
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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: API_NINJAS_GET_HOSPITALSFind 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 requestsDiscount: 95

Input Parameters

string
City where the hospital is located (e.g., ‘New York’, ‘Los Angeles’).
string
Hospital name to search for (e.g., ‘General Hospital’, ‘Memorial’). Partial matches are supported.
integer
Number of results to return per request (maximum 100, free users limited to 5).
string
State where the hospital is located (e.g., ‘NY’, ‘CA’, ‘Texas’).
string
County where the hospital is located (e.g., ‘New York County’, ‘Los Angeles County’).
integer
Provider-row offset to skip the first N results. Geographic bounds are enforced within each provider page; advance offset to inspect further pages.
string
Hospital ZIP code (e.g., ‘10001’, ‘90001’).
number
Maximum latitude coordinate for geographic filtering (range: -90 to 90).
number
Minimum latitude coordinate for geographic filtering (range: -90 to 90).
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.
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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: API_NINJAS_GET_INCOME_STATEMENTDeprecated 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

string
Company Central Index Key (for example 796343). Exactly one of ticker or cik is required.
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.
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.
string
Company ticker symbol (for example ADBE). Exactly one of ticker or cik is required.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: API_NINJAS_GET_INCOME_TAXGet federal and regional income-tax rates for a country and year.Instant: Supported on the latest version.Instant pricing: $0.059 per 100 API requestsDiscount: 95

Input Parameters

integer
required
Tax year to retrieve.
string
required
Two-letter country code, such as US or CA.
string
Comma-separated region codes or ‘federal’; omit for all regions.
boolean
Legacy filter. True maps to regions=‘federal’; false or null leaves regions unfiltered.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: API_NINJAS_GET_INFLATION_DATATool to get current inflation data for a country. Use when you need latest CPI or HICP monthly and annual inflation rates.

Input Parameters

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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: API_NINJAS_GET_INFLATION_HISTORYReturn historical CPI or HICP inflation observations for a country. Requires Premium only.

Input Parameters

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.
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.
integer
End time for the data range, specified as a UNIX timestamp in seconds.
integer
Start time for the data range, specified as a UNIX timestamp in seconds.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: API_NINJAS_GET_INSIDER_DETAILSReturn holdings and recent transactions for an exact insider name. Requires Premium only.

Input Parameters

string
required
Name of the insider (exact match). Use the /v1/insiderslist endpoint to look up insider names.
string
Central Index Key (CIK) of the company to filter transactions (e.g., 789019 ).
string
Company ticker symbol to filter transactions (e.g., AAPL , MSFT ).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: API_NINJAS_GET_INSIDER_TRANSACTIONSTool 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 requestsDiscount: 95

Input Parameters

string
Central Index Key (CIK) of the company. Alternative to ticker for identifying companies (e.g., ‘789019’).
integer
Maximum number of results to return. Use to limit response size.
string
Company ticker symbol (e.g., ‘AAPL’, ‘MSFT’). Use to filter transactions by company stock symbol.
string ("3" | "4" | "5")
SEC form types for insider trading
string
Exact name of the insider; partial matching is not supported. Use to find transactions by a specific insider.
string ("director" | "10_percent_owner" | "officer")
Type of insider
string ("P" | "S" | "A" | "D" | "F")
Transaction codes for insider trading
string
Exact transaction date in YYYY-MM-DD format. Use to find transactions on a specific date.
string
Type of transaction (e.g., ‘Purchase’, ‘Sale’, ‘Award’). Use to filter by transaction category.
string
Maximum transaction date in YYYY-MM-DD format. Use with min_transaction_date to define a date range.
string
Minimum transaction date in YYYY-MM-DD format. Use with max_transaction_date to define a date range.
number
Maximum transaction value in USD. Use with min_transaction_value to define a value range.
number
Minimum transaction value in USD. Use to filter significant transactions (e.g., 1000000 for transactions over $1M).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: API_NINJAS_GET_INSTITUTIONAL_OWNERSHIPReturn institutional holders or the ownership summary for one security.

Input Parameters

string ("value" | "shares" | "manager_name")
Result ordering.
string
Nine-character CUSIP. Exactly one of ticker or cusip is required.
integer
Results in this page, from 1 to 1000.
integer
Results to skip.
string
Quarter-end date in YYYY-MM-DD format.
string
Ticker symbol, for example AAPL. Exactly one of ticker or cusip is required.
boolean
Set to true to return the concentration aggregate; requires Business, Professional, or an annual plan. Omit to return holder records.
string ("put" | "call")
Return put or call positions; omit for long positions.
number
Minimum market value in USD.
number
Minimum shares held.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: API_NINJAS_GET_INTEREST_RATELook 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

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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: API_NINJAS_GET_INTEREST_RATE_HISTORYReturn paginated historical observations for a named benchmark interest rate. Requires Premium only.

Input Parameters

string
Opaque cursor from the previous response’s next field.
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.
string
Inclusive UTC end date in YYYY-MM-DD format; mutually exclusive with end_time.
integer
End UNIX timestamp in seconds.
string
Inclusive UTC start date in YYYY-MM-DD format; mutually exclusive with start_time.
integer
Start UNIX timestamp in seconds.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: API_NINJAS_GET_JOKE_OF_THE_DAYTool 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 requestsDiscount: 95

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: API_NINJAS_GET_JOKESTool 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 requestsDiscount: 95

Input Parameters

integer
How many jokes to return. Must be between 1 and 30. Default is 1.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: API_NINJAS_GET_LIBOR_HISTORYReturn historical values for a documented LIBOR tenor. Requires Business tier and above.

Input Parameters

string ("overnight" | "1_month" | "3_months" | "6_months" | "12_months")
required
LIBOR tenor.
integer
Range end Unix timestamp in seconds.
integer
Range start Unix timestamp in seconds.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: API_NINJAS_GET_LOTTERY_DRAWGet one game’s draw, or the latest draws for games in a state or country.

Input Parameters

string
Draw date in YYYY-MM-DD format. Developer covers the last two years; Business tier and above covers any archived date.
string
Lottery game slug. At least one of game, state, or country is required.
string
US state or territory code. At least one of game, state, or country is required.
string
Alpha-2 country code. At least one of game, state, or country is required.
string
Named intraday draw session.
integer
Operator draw number.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: API_NINJAS_GET_LOTTERY_DRAW_HISTORYReturn 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

string
Inclusive latest draw date in YYYY-MM-DD format.
string
required
Lottery game slug.
integer
Draws to return, from 1 to 1000.
string
Inclusive earliest draw date in YYYY-MM-DD format.
integer
Draws to skip.
string
Named draw session.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: API_NINJAS_GET_MARKET_CAPTool 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

string
required
Stock ticker symbol, e.g., ‘NVDA’

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: API_NINJAS_GET_METALS_PRICESReturn 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

string ("troy_ounce" | "g" | "kg" | "oz" | "lb" | "metric_ton" | "short_ton" | "hundredweight")
Target weight unit; omit for the metal’s native unit.
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.
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.
string
ISO 4217 target currency.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: API_NINJAS_GET_MORTGAGE_RATEGet current or historical 15-year and 30-year mortgage rates.

Input Parameters

string
Premium: one date to query in YYYY-MM-DD format; do not combine with a range.
string
Premium: last date in a YYYY-MM-DD range; requires min_date.
string
Premium: first date in a YYYY-MM-DD range; requires max_date.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: API_NINJAS_GET_MOTOR_CARRIERReturn a motor carrier record by USDOT or docket number.

Input Parameters

string
USDOT number. Exactly one of dot or motor_carrier_number is required.
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.
number
BI&PD coverage threshold in USD used by checks; defaults to 1,000,000. Requires Business tier and above.
number
Cargo coverage threshold in USD used by checks; defaults to 100,000. Requires Business tier and above.
string
Docket number with or without MC, MX, or FF prefix. Exactly one of dot or motor_carrier_number is required.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: API_NINJAS_GET_MOTOR_CARRIER_INSURANCEReturn active insurance filings for a motor carrier.

Input Parameters

string
USDOT number. Exactly one of dot or motor_carrier_number is required.
string
Docket number with or without its prefix. Exactly one of dot or motor_carrier_number is required.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: API_NINJAS_GET_MOTOR_CARRIER_SAFETYReturn crash, inspection, and BASIC safety data for a carrier.

Input Parameters

string
USDOT number. Exactly one of dot or motor_carrier_number is required.
string
Docket number with or without its prefix. Exactly one of dot or motor_carrier_number is required.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: API_NINJAS_GET_MOTORCYCLESTool 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 requestsDiscount: 95

Input Parameters

string
Name of manufacturer/brand. Supports partial matching (e.g., ‘Harley’ matches ‘Harley-Davidson’). Either make or model must be provided.
string
Release year in YYYY format (e.g., ‘2022’).
string
Name of motorcycle model. Supports partial matching (e.g., ‘Ninja’ matches ‘Ninja 650’). Either make or model must be provided.
integer
Number of results to offset for pagination. Default is 0. Premium feature only.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: API_NINJAS_GET_MUTUAL_FUNDGet 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 requestsDiscount: 95

Input Parameters

string
International Securities Identification Number of the fund share class. Supply exactly one of ticker or isin.
string
Mutual Fund ticker symbol. Case-insensitive. Supply exactly one of ticker or isin.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: API_NINJAS_GET_MX_RECORDSTool 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 requestsDiscount: 95

Input Parameters

string
required
A valid domain name to query MX records for (e.g., example.com).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: API_NINJAS_GET_NAICS_CODELook up NAICS records by code, batch, or official title.

Input Parameters

string
A two- to six-digit NAICS code. Exactly one of code, codes, or title is required.
integer
NAICS revision. The only accepted value is 2022.
string
Comma-separated batch of at most 500 NAICS codes. Exactly one of code, codes, or title is required.
string
Partial official title lookup. Exactly one of code, codes, or title is required.
string
Country. The only accepted value is US.
string
Earlier revision to crosswalk to. The only accepted value is 2017.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: API_NINJAS_GET_NAICS_SIZE_STANDARDReturn SBA size standards and optional eligibility calculations. Requires Premium only.

Input Parameters

string
One six-digit NAICS code.
string
Comma-separated codes for batch lookup: up to 50 on Developer and 500 on Business tier and above.
number
Annual receipts in USD.
integer
Employee count.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: API_NINJAS_GET_NUTRITION_ITEMReturn nutrition for one food item and quantity.

Input Parameters

string
required
One food item to query.
string
required
Quantity with a supported unit, such as 1 cup or 100g.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: API_NINJAS_GET_OIL_PRICEReturn current futures-contract prices and contract metadata for oil and energy benchmarks; use Get Oil Spot Price for physical immediate-delivery prices.

Input Parameters

string ("wti" | "brent" | "natural_gas" | "gasoline" | "diesel")
Single oil or energy benchmark.
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.
string
Comma-separated benchmarks for batch lookup.
string
ISO 4217 target currency.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: API_NINJAS_GET_OIL_PRICE_HISTORYReturn historical OHLCV data for an oil or energy benchmark. Requires Premium only.

Input Parameters

integer
Range end Unix timestamp.
string ("wti" | "brent" | "natural_gas" | "gasoline" | "diesel")
Oil or energy benchmark; omit for WTI.
integer
Range start Unix timestamp.
string ("1m" | "5m" | "15m" | "30m" | "1h" | "4h" | "1d")
Interval between data points.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: API_NINJAS_GET_OIL_SPOT_PRICEReturn assessed physical spot pricing for oil and energy benchmarks. Requires Premium only.

Input Parameters

string ("wti" | "brent" | "natural_gas" | "gasoline" | "diesel")
Single benchmark.
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.
string
Comma-separated benchmarks for batch lookup.
string
ISO 4217 target currency.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: API_NINJAS_GET_PLANETSTool 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 requestsDiscount: 95

Input Parameters

string
The name of the planet to search for.
integer
Offset results for pagination. Returns at most 30 results per request.
number
Maximum mass of the planet in Jupiters (1 Jupiter = 1.898 × 10²⁷ kg).
number
Minimum mass of the planet in Jupiters (1 Jupiter = 1.898 × 10²⁷ kg).
number
Maximum orbital period of the planet in Earth days.
number
Maximum average radius of the planet in Jupiters (1 Jupiter = 69911 km).
number
Minimum orbital period of the planet in Earth days.
number
Minimum average radius of the planet in Jupiters (1 Jupiter = 69911 km).
number
Maximum average surface temperature in Kelvin.
number
Minimum average surface temperature in Kelvin.
number
Maximum distance from Earth in light years.
number
Minimum distance from Earth in light years.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: API_NINJAS_GET_POPULATIONGet 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 requestsDiscount: 95

Input Parameters

integer
Offset results for pagination.
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.
integer
Maximum population of country. At least one of country, min_population, or max_population must be set.
integer
Minimum population of country. At least one of country, min_population, or max_population must be set.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: API_NINJAS_GET_POSTAL_CODETool 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 requestsDiscount: 95

Input Parameters

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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: API_NINJAS_GET_PROPERTY_TAXTool 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 requestsDiscount: 95

Input Parameters

string
The ZIP Code to look up. At least one of city, county, or zip must be specified.
string
Full name of the city (case-sensitive). At least one of city, county, or zip must be specified.
string
2-letter state abbreviation (case-insensitive).
string
Name of the county requesting property tax data. At least one of city, county, or zip must be specified.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: API_NINJAS_GET_PUBLIC_HOLIDAYSTool 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 requestsDiscount: 95

Input Parameters

integer
Calendar year to retrieve public holidays for. Must be between 1980 and 2050 (inclusive). Defaults to current year if not specified.
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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: API_NINJAS_GET_QUOTE_OF_THE_DAYTool 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 requestsDiscount: 95

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: API_NINJAS_GET_QUOTESDeprecated 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 requestsDiscount: 95

Input Parameters

integer
Number of quotes to return. Must be between 1 and 10. Default is 1 if not specified.
string
Author name to filter quotes. Supports partial matching and is case-insensitive (e.g., ‘einstein’ matches ‘Albert Einstein’).
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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: API_NINJAS_GET_RANDOM_IMAGETool 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 requestsDiscount: 95

Input Parameters

string
Image category filter (e.g., wildlife, nature, city). Premium subscription required for category filtering.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: API_NINJAS_GET_RANDOM_QUOTESTool 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 requestsDiscount: 95

Input Parameters

string
Filter by work/book title using partial string matching. Matches quotes from works whose titles contain this string.
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.
string
Filter by author name using partial string matching. Matches quotes from authors whose names contain this string.
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.
string
Comma-separated list of categories to exclude. Results won’t match any listed categories.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: API_NINJAS_GET_RANDOM_WORDTool 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 requestsDiscount: 95

Input Parameters

string ("noun" | "verb" | "adjective" | "adverb")
Filter by word type. Options: noun, verb, adjective, adverb. Leave empty for any type.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: API_NINJAS_GET_RECIPESearch recipes by title, up to five ingredients, or nutrition filters.

Input Parameters

integer
Results to return: up to 5 on free accounts or 10 on premium accounts.
string
Recipe title to search for.
integer
Legacy name for limit. Must be between 1 and 10 inclusive.
integer
Premium: number of matching recipes to skip for pagination.
number
Premium: maximum total fat in grams for the whole recipe.
number
Premium: minimum total fat in grams for the whole recipe.
integer
Premium: rescale ingredient quantities and nutrition to 1-1000 servings.
number
Premium: maximum total carbohydrates in grams for the whole recipe.
number
Premium: minimum total carbohydrates in grams for the whole recipe.
number
Premium: maximum sodium in milligrams for the whole recipe.
number
Premium: maximum sugars in grams for the whole recipe.
string
Comma-separated ingredients, up to five.
number
Premium: maximum protein in grams for the whole recipe.
number
Premium: minimum protein in grams for the whole recipe.
number
Premium: maximum calories for the whole recipe.
number
Premium: minimum calories for the whole recipe.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: API_NINJAS_GET_REVERSE_GEOCODINGTool 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 requestsDiscount: 95

Input Parameters

number
required
Latitude coordinate in decimal degrees (range: -90 to 90). Required for reverse geocoding.
number
required
Longitude coordinate in decimal degrees (range: -180 to 180). Required for reverse geocoding.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: API_NINJAS_GET_RHYMESTool 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 requestsDiscount: 95

Input Parameters

string
required
The word to find rhymes for. Must be a valid English word.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: API_NINJAS_GET_RIDDLESTool 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 requestsDiscount: 95

Input Parameters

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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: API_NINJAS_GET_SALES_TAXTool 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 requestsDiscount: 95

Input Parameters

string
City name. Must be used together with state parameter as alternative to zip_code. Use either zip_code alone OR city+state together.
string
State name. Must be used together with city parameter as alternative to zip_code. Use either zip_code alone OR city+state together.
string
Valid US ZIP code. Required if city and state are not provided. Use either zip_code alone OR city+state together.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: API_NINJAS_GET_SALES_TAX_FILING_REQUIREMENTSReturn state sales-tax filing frequencies, thresholds, and due dates for a year. Requires Business tier and above.

Input Parameters

integer
Four-digit calendar year.
string
Two-letter state code or full state name.
string
State-specific filing frequency tier, such as monthly, quarterly, semiannual, annual, or monthly_accelerated.
number
Annual sales-tax liability in US dollars.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: API_NINJAS_GET_SEC_FILINGTool 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 requestsDiscount: 95

Input Parameters

integer
Number of results to return, from 1 to 100. By default, up to 2 results are returned. Use to control response size.
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).
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.
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.
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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: API_NINJAS_GET_SHORT_INTERESTReturn reported short-interest observations for a stock ticker.

Input Parameters

integer
Historical records to return, from 1 to 200.
string
required
Stock ticker symbol.
string
Settlement date in YYYY-MM-DD format; use a provider reporting date.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: API_NINJAS_GET_SHORT_VOLUMEReturn daily short-sale volume observations for a stock ticker.

Input Parameters

integer
Historical records to return.
string
required
Stock ticker symbol.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: API_NINJAS_GET_SP500_CONSTITUENTSTool 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

string
Company name to search for (full or partial match). Returns companies whose names contain the search term.
integer
Maximum number of results to return. Use this to control the size of the response.
integer
Number of results to skip (for pagination). Use with limit to paginate through results.
string
GICS Sector to filter by (e.g., ‘Information Technology’, ‘Financials’, ‘Health Care’). Returns companies in the specified sector.
string
Stock ticker symbol to filter by (e.g., ‘AAPL’, ‘MSFT’, ‘GOOGL’). Returns companies matching the specified ticker.
string
Latest date company was added to the S&P 500 (format: YYYY-MM-DD). Returns companies added on or before this date.
string
Earliest date company was added to the S&P 500 (format: YYYY-MM-DD). Returns companies added on or after this date.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: API_NINJAS_GET_STARSRetrieve 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 requestsDiscount: 95

Input Parameters

string
The name of the star to search for. Note that many star names contain Greek characters.
integer
Offset results for pagination. Returns at most 30 results per request.
string
The constellation that the star belongs to.
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.
number
Maximum absolute magnitude (intrinsic brightness of the star).
number
Maximum apparent magnitude (brightness as seen from Earth). Lower values indicate brighter stars.
number
Minimum absolute magnitude (intrinsic brightness of the star).
number
Minimum apparent magnitude (brightness as seen from Earth). Lower values indicate brighter stars.
number
Maximum distance from Earth in light years.
number
Minimum distance from Earth in light years.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: API_NINJAS_GET_STOCK_EXCHANGETool 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 requestsDiscount: 95

Input Parameters

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).
string
City where the stock exchange is located (e.g., ‘New York’, ‘London’, ‘Tokyo’).
string
Stock exchange name to search for (e.g., ‘New York Stock Exchange’, ‘NASDAQ’). Partial matches are supported.
string
2-letter ISO country code (ISO-3166-1 alpha-2) to filter exchanges by country (e.g., ‘US’, ‘GB’, ‘JP’).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: API_NINJAS_GET_STOCK_EXCHANGE_HOURSReturn stock exchange session hours and open status for a date or timestamp. Requires Business tier and above.

Input Parameters

string
Market Identifier Code.
string
Date in YYYY-MM-DD format.
integer
Unix timestamp in seconds.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: API_NINJAS_GET_STOCK_PRICETool 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 requestsDiscount: 95

Input Parameters

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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: API_NINJAS_GET_STOCK_PRICE_HISTORYReturn historical OHLCV stock-price points for a ticker and interval. Requires Premium only.

Input Parameters

integer
End UNIX timestamp; provider defaults to current time.
integer
Start UNIX timestamp; provider defaults to recent history. Requests more than five years back require Business, Professional, Enterprise, or any annual plan.
string ("1m" | "5m" | "15m" | "30m" | "1h" | "4h" | "1d")
Interval between data points.
string
required
Stock ticker symbol.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: API_NINJAS_GET_SWIFT_CODETool 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 requestsDiscount: 95

Input Parameters

string
The name of the bank to look up. This parameter supports partial matching (premium only)
string
Name of the municipality where the bank operates
string
The SWIFT Code identifier for a specific bank to retrieve
integer
The number of results to offset for pagination. Requires an annual premium subscription; omit for a lookup without pagination
string
ISO 3166 2-letter country code designation

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: API_NINJAS_GET_THESAURUSTool 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 requestsDiscount: 95

Input Parameters

string
required
Word to find synonyms and antonyms for. Must be a valid English word.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: API_NINJAS_GET_TIMEZONETool 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 requestsDiscount: 95

Input Parameters

number
Latitude coordinate in decimal degrees (range: -90 to 90). PREMIUM ONLY - requires premium API subscription. Must be used with ‘lon’ parameter.
number
Longitude coordinate in decimal degrees (range: -180 to 180). PREMIUM ONLY - requires premium API subscription. Must be used with ‘lat’ parameter.
string
City name to get timezone information. PREMIUM ONLY - requires premium API subscription.
string
US state name or abbreviation (only for US cities). PREMIUM ONLY - requires premium API subscription.
string
Country code (ISO 3166 alpha-2) or country name. PREMIUM ONLY - requires premium API subscription.
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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: API_NINJAS_GET_TREASURY_YIELDReturn the latest or dated Treasury par, real, bill, or combined yield curve.

Input Parameters

string
Business day in YYYY-MM-DD format; provider defaults to latest.
string ("par" | "real" | "bill" | "all")
Treasury curve type.
string ("json" | "csv")
Response format.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: API_NINJAS_GET_TREASURY_YIELD_HISTORYReturn a paginated Treasury yield time series for one maturity or full curves by date. Requires Premium only.

Input Parameters

string
Pagination cursor returned in the previous response’s next field.
string ("par" | "real" | "bill")
Treasury curve type; provider defaults to par.
string ("json" | "csv")
Response format.
string
Inclusive range end in YYYY-MM-DD format.
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.
string
Inclusive range start in YYYY-MM-DD format.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: API_NINJAS_GET_TRIVIATool 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 requestsDiscount: 95

Input Parameters

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.
string ("artliterature" | "language" | "sciencenature" | "general" | "fooddrink" | "peopleplaces" | "geography" | "historyholidays" | "entertainment" | "toysgames" | "music" | "mathematics" | "religionmythology" | "sportsleisure")
Valid trivia categories for API Ninjas trivia endpoint.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: API_NINJAS_GET_TRIVIA_OF_THE_DAYTool 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 requestsDiscount: 95

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: API_NINJAS_GET_UNEMPLOYMENTTool 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 requestsDiscount: 95

Input Parameters

integer
Year for which to retrieve unemployment data. At least one of country or year must be provided.
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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: API_NINJAS_GET_UNIVERSITYTool 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 requestsDiscount: 95

Input Parameters

string
Name of the university to search for. Can be a partial match (e.g., ‘Harvard’, ‘MIT’, ‘Stanford’).
integer
Number of results to return (range: 1-30 for premium, max 5 for free tier).
integer
Pagination offset to skip the first N results. Premium feature.
string
Country where university is located. Accepts an English country name or a 2- or 3-letter ISO country code.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: API_NINJAS_GET_WEATHERTool 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 requestsDiscount: 95

Input Parameters

number
Latitude coordinate (-90 to 90). Must be used together with lon parameter.
number
Longitude coordinate (-180 to 180). Must be used together with lat parameter.
string
City name to get weather for. Must provide either city or coordinates (lat/lon).
string
US state name or abbreviation (for US cities only). Use with city parameter to disambiguate locations.
string
Country name or ISO 3166-1 alpha-2 code. Use with city parameter to disambiguate locations.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: API_NINJAS_GET_WEATHER_FORECASTTool 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 requestsDiscount: 95

Input Parameters

number
Latitude coordinate (-90 to 90). Must be used together with lon parameter.
number
Longitude coordinate (-180 to 180). Must be used together with lat parameter.
string
5-digit ZIP code for United States locations only (premium feature). Alternative to lat/lon.
string
City name (premium feature). Alternative to lat/lon.
string
US state name or abbreviation (for United States cities only, premium feature). Use with city parameter.
string
Country name or ISO code (premium feature). Use with city parameter.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: API_NINJAS_GET_WHOISTool 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 requestsDiscount: 95

Input Parameters

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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: API_NINJAS_GET_WORKING_DAYSGet 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 requestsDiscount: 95

Input Parameters

integer
Calendar year between 1980 and 2050 (inclusive). Defaults to current year if not specified.
integer
Month number (1-12). If specified, returns working days for that specific month only.
string
required
Country code (2-letter ISO 3166-1 alpha-2 code, e.g., ‘US’ for United States, ‘GB’ for United Kingdom).
array
Weekend days. Each item must be mon, tue, wed, thu, fri, sat, or sun. Overrides the country’s default weekend.
boolean
Whether to include public holidays as non-working days. Defaults to true if not specified.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: API_NINJAS_GET_WORLDTIMETool 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 requestsDiscount: 95

Input Parameters

number
Latitude coordinate in decimal degrees (range: -90 to 90). PREMIUM ONLY - requires premium API subscription. Must be used with ‘lon’ parameter.
number
Longitude coordinate in decimal degrees (range: -180 to 180). PREMIUM ONLY - requires premium API subscription. Must be used with ‘lat’ parameter.
string
City name to get current time. PREMIUM ONLY - requires premium API subscription.
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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: API_NINJAS_GET_ZIPCODETool 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 requestsDiscount: 95

Input Parameters

string
The ZIP Code to look up (at least one of zip, city, or state must be provided).
string
Full name of the city to search (case-sensitive). Premium tier required. At least one of zip, city, or state must be provided.
string
2-letter abbreviation of the state (case-insensitive). Premium tier required. At least one of zip, city, or state must be provided.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: API_NINJAS_LIST_AIRPORTSList airport ICAO codes and names with offset pagination. Requires Annual plans only.

Input Parameters

integer
Number of results to offset for pagination. Default is 0.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: API_NINJAS_LIST_BALANCE_SHEET_PERIODSDeprecated 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

string
Company Central Index Key, such as 796343. Exactly one of ticker or cik is required.
string
Company ticker symbol, such as ADBE. Exactly one of ticker or cik is required.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: API_NINJAS_LIST_BANK_HOLIDAYSList bank holidays for a country and year, including regional and observed dates.

Input Parameters

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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: API_NINJAS_LIST_BREEDSList all cat or dog breed names accepted by the corresponding API Ninjas animal endpoint. Requires Premium.

Input Parameters

string ("cat" | "dog")
required
Animal species whose accepted breed names to list.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: API_NINJAS_LIST_CALORIE_BURNING_ACTIVITIESList activity names accepted by the Calories Burned calculator. Requires Premium only.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: API_NINJAS_LIST_CAR_GENERATIONSList vehicle generations for a make and model, optionally limited to generations with cars. Requires Business tier and above, or any annual plan.

Input Parameters

string
required
Manufacturer.
integer
Only generations in production in this year.
integer
Results to return, from 1 to 100.
string
required
Model.
integer
Results to skip.
boolean
Omit generations with no cars.
string
Filter to one chassis code.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: API_NINJAS_LIST_CAR_MAKESList vehicle makes, optionally filtered by search text or model year. Requires Premium only.

Input Parameters

integer
Only makes with a car in production in this year.
integer
Results to return, from 1 to 100.
integer
Results to skip.
Case-insensitive manufacturer substring.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: API_NINJAS_LIST_CAR_MODELSList vehicle models for a make, optionally filtered by search text or model year. Requires Premium only.

Input Parameters

string
required
Manufacturer.
integer
Only models in production in this year.
integer
Results to return, from 1 to 100.
integer
Results to skip.
string
Case-insensitive model substring.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: API_NINJAS_LIST_CASH_FLOW_PERIODSDeprecated 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

string
Company Central Index Key, such as 796343. Exactly one of ticker or cik is required.
string
Company ticker symbol, such as ADBE. Exactly one of ticker or cik is required.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: API_NINJAS_LIST_CAT_BREEDSDeprecated 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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: API_NINJAS_LIST_COMMODITY_CONTRACTSList all available commodity futures contracts and their symbols; this endpoint accepts no root filter. Requires Business tier and above, or any annual plan.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: API_NINJAS_LIST_COMPANY_INSIDERSList corporate insiders and current holdings for a public company. Requires Premium only.

Input Parameters

string
Company Central Index Key, such as 789019. Exactly one of ticker or cik is required.
string
Company ticker symbol, such as AAPL or MSFT. Exactly one of ticker or cik is required.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: API_NINJAS_LIST_COUNTRIESList 2-letter country codes accepted by the Country API. Requires Premium only.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: API_NINJAS_LIST_COUNTRY_FLAGSList country codes with square and rectangular SVG flag image URLs. Requires Premium only.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: API_NINJAS_LIST_CRYPTO_SYMBOLSList cryptocurrency symbol pairs accepted by the Crypto Price API. Requires Premium only.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: API_NINJAS_LIST_DOG_BREEDSDeprecated 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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: API_NINJAS_LIST_EARNINGS_CALENDAR_COMPANIESList companies covered by the earnings calendar. Requires Premium only.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: API_NINJAS_LIST_EARNINGS_CALL_PARTICIPANTSList executives or analysts who appeared on a company’s earnings calls. Requires Business tier and above.

Input Parameters

string
Company Central Index Key, such as 320193. Provide ticker or cik; at least one is required.
integer
Results per page. Default 50 (max 200 ).
integer
Number of results to skip. Default 0 .
string
Company ticker symbol, such as AAPL. Provide ticker or cik; at least one is required.
string ("appearance_count" | "last_appearance_date" | "name")
Sort field: appearance_count (default), last_appearance_date , or name .
string ("asc" | "desc")
Sort direction: asc or desc .
string ("executive" | "analyst")
Restrict to executive (management roster) or analyst (covering analysts).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: API_NINJAS_LIST_EARNINGS_TRANSCRIPTSList companies with available earnings-call transcripts. Requires Premium only.

Input Parameters

integer
Number of results to return. Default is unlimited - all results will be returned.
integer
Number of results to skip for pagination. Default: 0 .

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: API_NINJAS_LIST_ELECTRIC_VEHICLE_MAKESList electric-vehicle makes available to the Electric Vehicle API. Requires Business tier and above, or any annual plan.

Input Parameters

integer
Filter manufacturers by year (e.g. 2023 ).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: API_NINJAS_LIST_ELECTRIC_VEHICLE_MODELSList electric-vehicle models for a selected make. Requires Business tier and above, or any annual plan.

Input Parameters

string
required
Vehicle manufacturer (e.g. tesla ).
integer
Vehicle model year (e.g. 2023 ).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: API_NINJAS_LIST_ETFSList ETF ticker symbols available to the ETF API. Requires Business tier and above, or any annual plan.

Input Parameters

integer
Number of results to skip for pagination. Default 0 . Page size is 1000 .

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: API_NINJAS_LIST_EXERCISESList exercise names for a target muscle group with offset pagination. Requires Business tier and above, or any annual plan.

Input Parameters

integer
Maximum number of results to return. Default is 10 , maximum is 100 .
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.
integer
Number of results to offset for pagination. Default is 0 .

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: API_NINJAS_LIST_FAILURES_TO_DELIVERList the latest and historical SEC failures-to-deliver records for a security.

Input Parameters

integer
Number of records to return, 1 to 250. Defaults to 30. Free plans are limited to the latest record.
string
required
The stock or ETF ticker symbol (for example GME ).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: API_NINJAS_LIST_FINANCIAL_STATEMENT_PERIODSList fiscal years and periods with an available balance sheet, cash-flow statement, or income statement for a company. Requires Premium.

Input Parameters

string
Company SEC Central Index Key, such as 796343. Exactly one of ticker or cik is required.
string
Company ticker symbol, such as ADBE. Exactly one of ticker or cik is required.
string ("balance_sheet" | "cash_flow" | "income_statement")
required
Financial statement availability to list: balance_sheet, cash_flow, or income_statement.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: API_NINJAS_LIST_INCOME_STATEMENT_PERIODSDeprecated 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

string
Company Central Index Key, such as 796343. Exactly one of ticker or cik is required.
string
Company ticker symbol, such as ADBE. Exactly one of ticker or cik is required.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: API_NINJAS_LIST_INSTITUTIONAL_MOVERSList securities with the largest recent institutional ownership changes. Requires Premium only.

Input Parameters

string
Rank the moves within a single institution instead of market-wide.
integer
Number of ranked rows to return. Default 50, max 1000.
string
Quarter-end date (YYYY-MM-DD); defaults to the latest quarter.
string ("new_buys" | "exits" | "adds" | "trims")
new_buys (default), exits , adds , or trims .

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: API_NINJAS_LIST_IPO_CALENDARList documented US IPO calendar records and filing details.

Input Parameters

string
Numeric SEC CIK.
string
Single date in YYYY-MM-DD format.
integer
Maximum records to return, from 1 to 1000.
integer
Records to skip.
array
IPO lifecycle statuses to include: filed, amended, priced, listed, or withdrawn.
string
Company ticker symbol.
string
Range end in YYYY-MM-DD format.
string ("NASDAQ" | "NYSE" | "AMEX")
US exchange code.
string
SEC SIC code, up to four digits.
array
Deal types to include: ipo, spac_ipo, or direct_listing.
string ("listing_date" | "filing_date")
Date field to filter.
string
Range start in YYYY-MM-DD format.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: API_NINJAS_LIST_LOTTERY_GAMESList documented lottery games and their rules.

Input Parameters

string
Return one game by slug.
string
Return games in one US state or territory.
string
Return games in one country.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: API_NINJAS_LIST_LOTTERY_JACKPOTSList current lottery jackpots using optional geography and currency filters. Requires Premium only.

Input Parameters

number
Minimum jackpot amount.
string
US state or territory code.
string
Alpha-2 country code.
string
ISO 4217 currency code.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: API_NINJAS_LIST_MOTORCYCLE_MAKESList motorcycle manufacturers accepted by the motorcycle API. Requires Business tier and above, or any annual plan.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: API_NINJAS_LIST_MOTORCYCLE_MODELSList motorcycle models for a manufacturer. Requires Business tier and above, or any annual plan.

Input Parameters

string
required
Motorcycle manufacturer.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: API_NINJAS_LIST_QUOTE_AUTHORSList quote authors available to the Quotes API with offset pagination. Requires Premium only.

Input Parameters

integer
Authors to return, from 1 to 500.
integer
Authors to skip.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: API_NINJAS_LIST_SALES_TAX_HOLIDAYSReturn US sales tax holiday periods, eligible categories, price caps, and coverage metadata.

Input Parameters

string
Date to test in YYYY-MM-DD format.
integer
Calendar year; provider defaults to current year.
string
Two-letter state code or full state name.
number
Item price in US dollars to test against a cap.
string
Item category to test.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: API_NINJAS_LIST_SHORT_INTEREST_CALENDARList short-interest settlement and publication dates for a calendar year.

Input Parameters

integer
Calendar year.
integer
Calendar entries to return.
boolean
Return upcoming reporting dates.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: API_NINJAS_LIST_STOCK_EXCHANGE_HOLIDAYSList market holidays and closure details for a stock exchange. Requires Business tier and above.

Input Parameters

string
Market Identifier Code.
string
Exchange name.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: API_NINJAS_LIST_STOCK_EXCHANGESList all stock exchanges and their identity, location, market size, currency, timezone, and session details. Requires Business tier and above.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: API_NINJAS_LIST_STOCK_NEWSList dated news articles for one or more stock tickers with offset pagination. Requires Premium only.

Input Parameters

string
Single UTC publication date in YYYY-MM-DD format; mutually exclusive with start_date and end_date.
integer
Results to skip, at most 10000.
string
One ticker symbol or multiple symbols encoded as a comma-separated string.
string
Inclusive UTC publication range end in YYYY-MM-DD format; do not combine with date.
string
Inclusive UTC publication range start in YYYY-MM-DD format; do not combine with date.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: API_NINJAS_LIST_STOCK_SPLITSList forward or reverse stock splits for a ticker or date range.

Input Parameters

string
Single effective date in YYYY-MM-DD format; mutually exclusive with date_start and date_end.
integer
Results to return, at most 1000.
integer
Results to skip.
string
Company ticker symbol.
string
Effective-date range end in YYYY-MM-DD format; do not combine with date.
string
Exchange code.
string
Effective-date range start in YYYY-MM-DD format; do not combine with date.
string ("forward" | "reverse")
Split direction.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: API_NINJAS_LIST_STOCK_TICKERSTool 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 requestsDiscount: 95

Input Parameters

integer
required
Number of results to return. Must be between 1 and 1000.
integer
required
Number of results to offset for pagination. Must be provided (use 0 for first page).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: API_NINJAS_LIST_UPCOMING_EARNINGSList scheduled company earnings announcements by date or ticker. Requires Premium only.

Input Parameters

string
Single earnings date in YYYY-MM-DD format; mutually exclusive with start_date and end_date.
integer
Results to return, from 1 to 100.
integer
Results to skip.
string
Company ticker.
string
Range end in YYYY-MM-DD format; provider defaults to ten years from today and this field must not be combined with date.
string
Exchange code.
string
Range start in YYYY-MM-DD format; provider defaults to today and this field must not be combined with date.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: API_NINJAS_LIST_WEATHER_ICONSList weather condition codes and their icon metadata. Requires Premium only.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: API_NINJAS_LOOKUP_BINLook up issuer, country, and payment-network details for a BIN.

Input Parameters

string
required
The first 6 or 8 digits of a credit or debit card number.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: API_NINJAS_LOOKUP_BSBLook up an Australian BSB and return its bank, branch, address, and payment-network details.

Input Parameters

string
required
The 6-digit Australian BSB number, with or without a hyphen (e.g. 062-000 or 062000 ).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: API_NINJAS_LOOKUP_CANADA_ROUTING_NUMBERLook up a Canadian routing number or transit and institution pair to return branch details.

Input Parameters

string
The 9-digit Canadian routing number in EFT format ( 0AAATTTTT ).
string
The 5-digit branch transit number. Must be used together with institution_number .
string
The 3-digit financial institution number. Must be used together with transit_number .

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: API_NINJAS_LOOKUP_DNS_RECORDSTool to retrieve DNS records for a specified domain. Use when you need DNS record details for troubleshooting or validation.

Input Parameters

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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: API_NINJAS_LOOKUP_IBANTool 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

string
required
International Bank Account Number to look up

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: API_NINJAS_LOOKUP_INDIA_PIN_CODELook up Indian postal locations by PIN code, city, district, or state.

Input Parameters

string
Post office or locality name.
string
State or union territory.
string
Six-digit Indian PIN code; spaces and hyphens are accepted.
string
District name.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: API_NINJAS_LOOKUP_IP_ADDRESSLook up geolocation and ISP information for an IPv4 or IPv6 address. City, coordinates and ISP information may require Premium access.

Input Parameters

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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: API_NINJAS_LOOKUP_PHONE_NUMBERDeprecated 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

string
required
Phone number, including country code when country is omitted.
string
Two-letter ISO 3166 country code.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: API_NINJAS_LOOKUP_SORT_CODELook up a UK sort code and return its bank, branch, address, and payment capabilities.

Input Parameters

string
required
UK bank sort code.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: API_NINJAS_LOOKUP_URLTool 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

string
required
Valid URL to check. It supports schemes (e.g., http://example.com) as well as schemeless formats (e.g., example.com).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: API_NINJAS_LOOKUP_VINTool 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 requestsDiscount: 95

Input Parameters

string
required
17-character Vehicle Identification Number to decode

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: API_NINJAS_PARSE_USER_AGENTParse a user-agent string into browser, operating-system, and device details.

Input Parameters

string
required
User-agent string to parse.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: API_NINJAS_SCRAPE_WEBSITETool 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 requestsDiscount: 95

Input Parameters

string
required
The website address to retrieve content from (must be a valid URL).
boolean
When enabled, extracts visible text while filtering out HTML markup and metadata. Defaults to false (returns full HTML content).
string
Custom User-Agent header string for the request. Use when you need to specify a particular browser or device identity.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: API_NINJAS_SCREEN_SANCTIONSScreen a person or organization against supported sanctions lists and return candidate matches.

Input Parameters

string
Date of birth in YYYY-MM-DD format.
string
required
Full name to screen.
string
ISO 3166-1 alpha-2 country code.
array
Sanctions lists to search: OFAC, EU, UK, UN, or AU.
integer
Minimum confidence score from 0 to 100.
string ("individual" | "entity" | "vessel" | "aircraft")
Entity type. Vessel and aircraft screening require Business tier and above.
string
Nationality filter.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: API_NINJAS_SCREEN_SHORT_INTERESTScreen securities by exchange and short-interest metrics. Requires Business tier and above.

Input Parameters

integer
Results to return.
string ("desc" | "asc")
Sort order.
string
Sector filter.
string ("short_percent_float" | "short_percent_outstanding" | "days_to_cover" | "change_percent" | "dollar_volume_short" | "percentile_2y" | "shares_short")
Field used to sort results.
string ("NYSE" | "NNM" | "SC" | "ARCA" | "BZX" | "AMEX" | "IEX" | "OTC")
Exchange filter.
number
Minimum share price.
string
Settlement date in YYYY-MM-DD format; provider defaults to latest.
number
Minimum days to cover.
boolean
Exclude capped float estimates.
integer
Minimum whole-share count outstanding.
number
Minimum short percentage of float.
integer
Maximum integer float-price gap in days.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: API_NINJAS_SEARCH_BITCOIN_TREASURIESDeprecated Bitcoin-only treasury search. Use API_NINJAS_SEARCH_CRYPTO_TREASURIES with asset=BITCOIN. <<DEPRECATED use API_NINJAS_SEARCH_CRYPTO_TREASURIES>>

Input Parameters

string
SEC Central Index Key of the filer, with or without leading zeros.
string
Case-insensitive substring match on the filer name. Requires a Business or Professional subscription.
integer
Maximum results to return. Capped at 5 on Free, 50 on Developer, and 250 on Business and Professional.
integer
Number of results to skip, for pagination. Default is 0 , maximum is 10000 .
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.
string
Stock ticker of the filer (e.g. MSTR ). Private filers have no ticker — use cik .
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.
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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: API_NINJAS_SEARCH_BRANDED_FOODSFind branded food nutrition by barcode, product name, or brand. Requires Premium only.

Input Parameters

string
UPC or EAN for exact lookup.
string
Product name to search for.
string
Brand-name filter.
integer
Maximum search results, from 1 to 50.
integer
Search results to skip, within the first 1000 matches.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: API_NINJAS_SEARCH_BSBSSearch Australian BSB branches by bank, suburb, state, or postcode. Requires Premium only.

Input Parameters

string
Australian state or territory code (e.g. NSW, VIC, QLD).
integer
Number of results to offset for pagination.
string
Suburb to search for branches.
string
4-digit Australian postcode to search for branches.
string
Bank name to search for.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: API_NINJAS_SEARCH_CANADA_ROUTING_NUMBERSSearch Canadian bank branches by institution, city, province, or postal code. Requires Premium only.

Input Parameters

string
City name to search for branches.
integer
Number of results to offset for pagination.
string
Two-letter province or territory code (e.g. ON, QC, BC).
string
Bank name to search for.
string
Postal code to search for branches.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: API_NINJAS_SEARCH_CRYPTO_TREASURIESSearch SEC-reported cryptocurrency holdings across supported digital assets.

Input Parameters

string
SEC Central Index Key of the filer, with or without leading zeros.
string
Case-insensitive substring match on the filer name. Requires a Business or Professional subscription.
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 .
integer
Maximum results to return. Capped at 5 on Free, 50 on Developer, and 250 on Business and Professional.
integer
Number of results to skip, for pagination. Default is 0 , maximum is 10000 .
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.
string
Stock ticker of the filer (e.g. MSTR ). Private filers have no ticker - use cik .
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.
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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: API_NINJAS_SEARCH_EARNINGS_CALL_SPEAKERSSearch earnings-call speakers or retrieve one speaker’s profile and appearance history. Requires Business tier and above.

Input Parameters

string
Case-insensitive speaker-name substring (search mode only).
string
Role or title substring, such as CEO (search mode only).
integer
Fiscal-year appearance filter.
integer
Page size: up to 100 speakers in search mode (default 25), or 200 appearances in detail mode (default 50).
integer
Number of speakers or appearances to skip.
string
In search mode, require an appearance on this company’s calls. In detail mode, filter appearance history to this company.
string
Executive primary-company substring (search mode only).
string ("1" | "2" | "3" | "4")
Fiscal-quarter appearance filter. In search mode, requires year.
string ("appearance_count" | "last_appearance_date" | "name")
Speaker sort field (search mode only).
string ("asc" | "desc")
Speaker sort direction (search mode only).
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.
string
Analyst-firm substring (search mode only).
string ("executive" | "analyst")
Speaker type (search mode only).
boolean
Include each speaker’s appearance list in search results when true (search mode only).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: API_NINJAS_SEARCH_EARNINGS_TRANSCRIPTSFind available earnings-call transcript records by company or call date; this does not search transcript text. Requires Premium only.

Input Parameters

string
Company Central Index Key (e.g., 789019 ). For US companies registered with the SEC only.
string
Filter results by earnings call date in YYYY-MM-DD format (e.g., 2024-05-02 ). Mutually exclusive with start_date / end_date .
integer
Maximum number of results to return. Default 20 ; values above 200 are clamped to 200 .
integer
Number of results to skip, for pagination. Default 0 .
string
Company ticker symbol (e.g., AAPL ).
string
End of the earnings call date range (inclusive), in YYYY-MM-DD format. Must be paired with 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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: API_NINJAS_SEARCH_ETFSSearch 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

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.
integer
Number of results to skip for pagination. Default 0 . Page size is 50 .
string
Filter by ISO listing-country code - the exchange the ETF trades on (e.g. US , GB , JP ), not the fund’s domicile.
number
Maximum assets under management in USD.
number
Minimum assets under management in USD (e.g. 10000000000 for $10B).
string
Comma-separated list of ticker symbols. Only ETFs that hold every listed ticker will be returned (AND match). Example: AAPL,MSFT .
number
Maximum annual expense ratio as a percentage.
number
Minimum annual expense ratio as a percentage (e.g. 0.1 for 0.1%).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: API_NINJAS_SEARCH_INSTITUTIONAL_HOLDINGSSearch an institutional manager’s holdings by manager CIK or exact manager name, with optional security and reporting-period filters.

Input Parameters

string
Manager SEC Central Index Key (e.g. 1067983 ).
string ("value" | "shares" | "percent_of_portfolio" | "issuer_name")
value (default), shares , percent_of_portfolio , or issuer_name .
string
Filter the portfolio to a single holding by CUSIP.
integer
Number of results per page. Default 50, max 1000.
integer
Number of results to skip, for pagination.
string
Quarter-end date (YYYY-MM-DD). Defaults to the latest quarter; free tier is limited to the most recent quarter.
string
Filter the portfolio to a single holding by ticker.
string
Use sector for a sector-allocation rollup. Requires Business tier and above, or any annual plan.
string ("put" | "call")
put or call to filter option positions.
number
Maximum reported market value (USD).
number
Minimum reported market value (USD).
array
Quarter-over-quarter change filters. Requires Business tier and above, or any annual plan.
string
Exact manager name (alternative to cik).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: API_NINJAS_SEARCH_INSTITUTIONAL_INVESTORSSearch the institutional-manager directory, filing history, or available quarters. Requires Premium only.

Input Parameters

string
Institution CIK; selects filing-history mode.
string
Institution-name substring; selects directory mode.
integer
Results per page. Default 50, maximum 1000.
integer
Number of results to skip.
string
Quarter-end date in YYYY-MM-DD format; selects all filings for that quarter.
boolean
Set true to enumerate available quarters and filing counts.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: API_NINJAS_SEARCH_MOTOR_CARRIERSSearch motor carriers using documented identity and location filters.

Input Parameters

string
Physical-address ZIP code.
string
Physical-address city.
string
Normalized company-name prefix, at least three characters.
string
Email address or domain reverse lookup.
integer
Results in this page, from 1 to 100.
string
Phone reverse lookup.
string
Physical-address state.
integer
Results to skip, at most 10000.
string ("active" | "inactive" | "pending")
Registration status.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: API_NINJAS_SEARCH_NAICS_CODESSearch official NAICS text for relevant codes.

Input Parameters

string ("2" | "3" | "4" | "5" | "6")
Restrict to this code digit length, 2 through 6.
integer
Maximum matches, from 1 to 25.
string
required
Industry keyword or phrase, up to 300 characters.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: API_NINJAS_SEARCH_ROUTING_NUMBERSSearch US routing numbers by bank name, location, ZIP code, or SWIFT code. Requires Premium only.

Input Parameters

string
City name.
string
Two-letter state code.
integer
Results to skip.
string
Five-digit ZIP code.
string
Bank name.
string
Eight- or eleven-character SWIFT/BIC code.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: API_NINJAS_SEARCH_SORT_CODESSearch UK bank branches by bank name, city, or postcode. Requires Premium only.

Input Parameters

string
City.
integer
Results to skip.
string
Postcode.
string
Bank name.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: API_NINJAS_SEARCH_TICKERSSearch public-company ticker symbols by company name and keyword exclusions. Requires Premium only.

Input Parameters

string
required
Company name to search.
string
Comma-separated company-name keywords to exclude.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: API_NINJAS_SOLVE_SUDOKUTool 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 requestsDiscount: 95

Input Parameters

integer
required
Width of each box in the Sudoku grid. Must be between 2 and 4. For standard 9x9 Sudoku, use width=3.
integer
required
Height of each box in the Sudoku grid. Must be between 2 and 4. For standard 9x9 Sudoku, use height=3.
array
required
Sudoku puzzle grid. Use 0 for empty cells.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: API_NINJAS_SUGGEST_AIRPORTSSuggest compact airport matches for a name or code query, optionally filtered by country and size. Requires Premium only.

Input Parameters

string ("large" | "medium" | "small")
Restrict results to a size. Must be one of: large , medium , small .
integer
Maximum number of results to return. Must be between 1 and 3. Default is 3.
string
required
Query string (minimum 2 characters).
string
Restrict results to a country. Must be a 2-character ISO country code (e.g. US ).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: API_NINJAS_UPDATE_COUNTERIncrement or set persistent counter state scoped to the connected API key; use value=0 to reset a counter.

Input Parameters

string
required
Counter identifier. Counter state persists across calls and is scoped to the connected API key.
integer
Set the counter to this exact value; use 0 to reset it.
boolean
Set to true to increment the counter by one.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: API_NINJAS_VALIDATE_EMAILValidate 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 requestsDiscount: 95

Input Parameters

string
required
Email address to validate and check deliverability.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: API_NINJAS_VALIDATE_PHONEValidate 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 requestsDiscount: 95

Input Parameters

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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: API_NINJAS_VALIDATE_PHONE_NUMBERValidate and normalize a phone number and return country, carrier, line-type, VoIP, mobile-network, and disposable-number metadata.

Input Parameters

string
Optional two-letter ISO 3166 country code for a national-format number.
string
required
Phone number to validate. Include a country calling code when country is omitted.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: API_NINJAS_VALIDATE_ROUTING_NUMBERTool 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 requestsDiscount: 95

Input Parameters

string
required
A 9-digit bank routing number to validate and look up

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: API_NINJAS_VALIDATE_VAT_NUMBERValidate a VAT number and return its registration and business details.

Input Parameters

string
required
VAT number, optionally including its country prefix.
string
Country code when vat has no prefix.
string
Requester VAT number for an official live consultation.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not