API Ninjas
API Ninjas offers over 120 unique APIs across various categories, enabling developers to build real applications with real data.
Tools (259)
Analyze Nutrition
Tool to extract nutrition information from text query. Use when you need to parse food-related text (e.g., recipes, menus) to calculate corresponding nutrition data.
Inputs: query
Analyze Text Sentiment
Tool to analyze the sentiment of text. Returns a numerical sentiment score from -1 to 1 and a classification (POSITIVE, WEAK_POSITIVE, NEUTRAL, WEAK_NEGATIVE, or NEGATIVE). Use when you need to determine the emotional tone or sentiment of text content.
Inputs: text
Assess NAICS Risk
Assess documented compliance risk indicators for NAICS codes. Requires Business tier and above.
Inputs: code, codes, framework
Calculate Airport Distance
Calculate great-circle distance, initial bearing, and estimated flight time between two airports. Requires Premium only.
Inputs: to, from, units
Calculate Calories Burned
Tool to calculate calories burned for an activity based on duration and body weight. Use when you need to estimate energy expenditure for physical activities.
Inputs: weight, activity, duration
Calculate Currency Volatility
Calculate realized volatility and percentile context for a currency pair. Requires Premium only.
Inputs: pair, method, window, day_count, annualized
Calculate Income Tax
Tool to calculate income taxes for US and Canada. Use when you need detailed breakdown of federal, state/provincial, and FICA taxes. Country and region codes must be correct.
Inputs: income, region, country, credits, deductions, filing_status, self_employed
Calculate Mortgage
Tool to calculate mortgage payments and breakdowns. Use when you need to determine monthly/annual payments, including mortgage, property tax, HOA, and insurance components.
Inputs: home_value, downpayment, loan_amount, monthly_hoa, interest_rate, duration_years, annual_property_tax, annual_home_insurance
Calculate Paycheck Withholding
Calculate federal, FICA, and optional state paycheck withholding. Requires Premium only.
Inputs: state, tax_year, gross_pay, ytd_gross, allowances, deductions, pay_period, w4_version, other_income, filing_status, multiple_jobs, dependents_amount, extra_withholding, pretax_deductions
Calculate Sales Tax
Tool to calculate sales tax for a purchase amount at a US location. Use when you need to determine the sales tax for a purchase based on ZIP code or city/state. Premium features include detailed breakdowns by city, county, and special districts.
Inputs: city, state, amount, zip_code
Check Bank Holiday
Check whether banks are closed on a date in a country or subdivision.
Inputs: date, country, subdivision
Check Disposable Email
Tool to check whether an email address is from a disposable email provider. Use when validating user emails prior to sending communications.
Inputs: email
Check Domain Availability
Tool to check domain availability and retrieve registration information. Use when you need to verify if a domain is available for registration or get details about an existing domain.
Inputs: domain
Check Holiday
Return all documented holiday categories on a date across every country when country is omitted; use Check Is Public Holiday for a country-specific public-holiday boolean or Check Bank Holiday for bank closures.
Inputs: date, country
Check If Date Is Public Holiday
Tool to check if a specific date is a public holiday in a given country. Use when you need to verify holiday status for scheduling, planning, or calendar-related tasks. Returns holiday name if applicable.
Inputs: date, country
Check If Date Is Working Day
Check whether a date is a working day in a country, with configurable weekend days and optional inclusion of public holidays.
Inputs: date, country, weekend_days, include_holidays
Check Lottery Ticket
Score a supported lottery ticket against a draw. Requires Premium only.
Inputs: date, game, bonus, numbers, multiplier, power_play, double_play
Check Sales Tax Nexus
Evaluate supplied sales and transaction totals against a state's economic-nexus rules. Requires Premium only.
Inputs: state, revenue, gross_sales, retail_sales, transactions, taxable_sales, marketplace_sales, marketplace_transactions
Check Spelling
Tool to check spelling and get corrections for text. Returns the original text, corrected version, and detailed corrections with alternative suggestions.
Inputs: text
Classify Business NAICS
Classify a business description to a NAICS code. Requires Business tier and above.
Inputs: description, min_confidence, include_alternatives
Compute Text Similarity
Tool to compute semantic similarity between two texts. Returns a similarity score from 0 to 1 using NLP embeddings and cosine similarity. Use when comparing text content, detecting duplicates, or measuring semantic relatedness.
Inputs: text_1, text_2
Convert Airport Code
Resolve an IATA, ICAO, GPS, ident, or local airport code to the matching airport record.
Inputs: code, iata, icao
Convert Currency
Convert between currencies using current exchange rates. Returns the converted amount with both source and target currency details. Use this when you need to know how much a specific amount in one currency is worth in another currency.
Inputs: have, want, amount
Convert Unit
Convert between measurement units across different categories. Returns converted values for all units in the same category. Use this when you need to convert measurements (length, weight, temperature, volume, area, time, speed, etc.) from one unit to another.
Inputs: unit, amount
Detect Faces
Detect faces and return their pixel bounding boxes in a JPEG or PNG image.
Inputs: image
Detect Objects
Detect labeled objects and bounding boxes in a JPEG or PNG image smaller than 2000 by 2000 pixels.
Inputs: image
Detect Text Language
Tool to detect the language of input text. Returns the ISO language code and full language name. For best accuracy, use text with 10 or more words.
Inputs: text
Extract Text From Image
Extract text blocks and pixel bounding boxes from a JPEG or PNG image.
Inputs: image
Extract Webpage Content
Retrieve URL information and webpage metadata, including domain, path, title, description, meta tags, and favicon.
Inputs: url
Filter Profanity from Text
Tool to detect and censor profanity in text. Returns the original text, censored version with profane words replaced by asterisks, and whether profanity was detected.
Inputs: text
Find Closest Airport
Find airports near coordinates, with distance and optional size, runway, and IATA filters. Requires Premium only.
Inputs: lat, lon, size, limit, units, radius, has_iata, min_runway_length
Find EV Charging Stations
Tool to find electric vehicle charging stations near a specified location. Use when you need to locate EV charging infrastructure by geographic coordinates.
Inputs: lat, lon, level, limit, offset, distance
Forecast Currency Volatility
Forecast currency-pair volatility across requested trading-day horizons. Requires Premium only.
Inputs: pair, lambda, method, horizon, day_count
Generate Barcode Image
Generate a barcode image for specified text in PNG or SVG format. Returns the image data as a base64-encoded string.
Inputs: text, type, format, include_text
Generate Lorem Ipsum Text
Tool to generate Lorem Ipsum placeholder text. Use when you need dummy text for design mockups, testing, or content placeholders.
Inputs: paragraphs
Generate Secure Password
Tool to generate secure random passwords with configurable length and character types. Use when you need to create strong passwords with a chosen length and optional exclusion of numbers or special characters. Uppercase and lowercase exclusions are not supported by the provider.
Inputs: length, numbers, special, lowercase, uppercase
Generate QR Code
Tool to generate QR code images for encoding data. Use when you need to create scannable QR codes for URLs, text, or other data. Returns the QR code as a PNG or SVG image file.
Inputs: data, format
Generate Random User Profiles
Tool to generate fake random user profiles with realistic data. Returns user profiles with names, addresses, contact info, job details, and technical data. Use when you need realistic test data, demo users, or placeholder profiles for development and testing purposes.
Inputs: seed, count, fields, gender, locale, exclude, max_age, min_age
Generate Sudoku Puzzle
Tool to generate a new Sudoku puzzle with a specified difficulty level. Use when you need to create Sudoku puzzles for games or educational purposes. Returns both the puzzle grid (with empty cells) and the complete solution.
Inputs: seed, width, height, difficulty
Generate Text Embeddings
Tool to encode text into vector embeddings using NLP models. Use when you need to generate semantic vectors for text comparison, search, or recommendation systems.
Inputs: text
Generate Text Embeddings Batch
Generate embeddings for up to ten texts using a bounded sequence of calls to the provider's singular embeddings endpoint, returning per-item vectors or errors.
Inputs: texts
Generate User Agent String
Tool to generate realistic random user agent strings with optional filters for brand, model, OS, and browser. Use when you need authentic-looking user agent strings for web scraping, testing, or browser simulation.
Inputs: os, brand, model, browser
Get Account Analytics
Return connected-account subscription and API usage analytics while redacting the API key. Requires Professional or Enterprise; account-private and zero-quota.
Get Random Life Advice
Tool to get a random piece of life advice from the API Ninjas Advice endpoint. Use when you need motivational or thought-provoking advice.
Get Aircraft Information
Tool to retrieve aircraft information by manufacturer and model including specifications and performance data. Use when you need technical details about specific aircraft models or want to search aircraft by performance criteria.
Inputs: model, max_range, max_speed, min_range, min_speed, manufacturer
Get Airline Information
Tool to retrieve airline information by name, IATA code, or ICAO code. Use when you need details about airlines including fleet size, base location, and branding assets.
Inputs: iata, icao, name
Get Airport Information
Tool to search for airport information by IATA code, ICAO code, name, city, country, or region. Use when you need to find airport details, coordinates, or codes. Returns up to 10 matching airports.
Inputs: city, iata, icao, name, offset, region, country
Get Air Quality Data
Tool to retrieve air quality index and pollutant data for a location. Use when you need current air quality information for environmental monitoring or health assessments. Query by city name or GPS coordinates.
Inputs: lat, lon, city, state, country
Get Animal Information
Tool to retrieve detailed scientific information about animal species. Use to look up taxonomy, habitat, diet, or physical characteristics for an animal species.
Inputs: name
Get Baby Names
Tool to get baby name suggestions by gender. Returns 10 baby name suggestions that can be filtered by gender (boy, girl, or neutral) and popularity. Use when you need baby name ideas or recommendations.
Inputs: gender, popular_only
Get Balance Sheet
Deprecated compatibility tool for balance sheets. Use API_NINJAS_GET_FINANCIAL_STATEMENT with statement_type=balance_sheet. <<DEPRECATED use API_NINJAS_GET_FINANCIAL_STATEMENT>>
Inputs: cik, year, period, ticker
Get Bitcoin Price and Market Data
Tool to retrieve the latest Bitcoin price and 24-hour market data. Use when you need real-time Bitcoin metrics in USD.
Get Bitcoin Price History
Deprecated Bitcoin-only history tool. Use API_NINJAS_GET_CRYPTO_PRICE_HISTORY with symbol=BTCUSD. Requires Premium only. <<DEPRECATED use API_NINJAS_GET_CRYPTO_PRICE_HISTORY>>
Inputs: end, limit, start, interval
Get Random Bucket List Idea
Tool to retrieve a random bucket list idea or activity. Use when you need inspiration for bucket list items or life goals.
Get Car Facets
Return grouped value counts for up to six caller-selected car dimensions; use LIST_CAR_MAKES, LIST_CAR_MODELS, or LIST_CAR_GENERATIONS for catalog listings.
Inputs: body, fuel, make, year, drive, model, facets, generation, transmission
Get Car Specifications
Query current car specifications by identity or documented filters. Requires Premium only.
Inputs: id, ids, body, fuel, make, sort, year, badge, doors, drive, limit, model, offset, max_year, min_year, cylinders, fuel_type, generation, engine_code, max_hwy_mpg, min_hwy_mpg, chassis_code, max_city_mpg, max_power_hp, min_city_mpg, min_power_hp, transmission
Get Cash Flow
Deprecated compatibility tool for cash-flow statements. Use API_NINJAS_GET_FINANCIAL_STATEMENT with statement_type=cash_flow. <<DEPRECATED use API_NINJAS_GET_FINANCIAL_STATEMENT>>
Inputs: cik, year, period, ticker
Get Cat Breed Information
Tool to retrieve information on cat breeds matching specified parameters. Use when you need to search for cat breeds by characteristics such as name, weight, life expectancy, shedding level, playfulness, grooming needs, or friendliness with family and other pets.
Inputs: name, offset, grooming, shedding, max_weight, min_weight, playfulness, family_friendly, max_life_expectancy, min_life_expectancy, other_pets_friendly
Get Celebrity Information
Tool to search for celebrity information by name or other criteria. Returns details including net worth, height, birthday, nationality, and occupation. Use when you need to find information about famous people, filter celebrities by attributes like net worth or nationality, or gather biographical data.
Inputs: name, offset, max_height, min_height, nationality, max_net_worth, min_net_worth
Get Chuck Norris Joke
Tool to retrieve a random Chuck Norris joke from the API Ninjas database. Use when you need humorous Chuck Norris content.
Get City Information
Tool to retrieve city information by name, country, coordinates, or population filters. Use when you need geographic data about cities including coordinates, population, and capital status. At least one search parameter is required.
Inputs: name, limit, offset, country, max_lat, max_lon, min_lat, min_lon, max_population, min_population
Get Cocktail Recipes
Tool to search for cocktail recipes by name or ingredients. Returns up to 10 cocktail recipes with ingredients and preparation instructions. Use when you need cocktail recipes, drink mixing instructions, or want to find drinks by specific ingredients.
Inputs: name, ingredients
Get Commodity Contract
Return one contract by exact symbol, or all matching contracts by root symbol. Requires Business tier and above, or any annual plan.
Inputs: symbol, symbol_root
Get Commodity Forward Curve
Return every active futures contract, sorted by month, for one commodity forward curve. Requires Business tier and above, or any annual plan.
Inputs: name
Get Commodity Market Snapshot
Return a current commodity market snapshot across supported contracts.
Inputs: category, exchange
Get Commodity Price
Get real-time commodity prices from major exchanges (CME, NYMEX, COMEX). Prices are based on rolling futures contracts in USD. Free tier has limited commodities that rotate weekly. Use snake_case for commodity names (e.g., 'micro_gold', 'natural_gas'). Example: "What is the current price of natural gas?"
Inputs: name
Get Commodity Price History
Return historical commodity futures OHLCV prices without silently accepting a provider-truncated series. Requires Premium only.
Inputs: end, name, start, period
Get Commodity Spot Price
Return one immediate-delivery spot price with name, or a batch array with comma-separated names (batch requires Business tier and above). Use futures-price tools for commodities without a public spot market. Requires Premium only.
Inputs: name, unit, names, currency
Get Company Logo
Retrieve a company logo URL by company name or ticker symbol. When multiple results are returned, only the first is returned.
Inputs: name, ticker
Get Company Profile
Retrieve company profile information for a publicly traded company by stock ticker symbol. Returns executive details, financial metrics, identifiers (CIK, CUSIP, ISIN), exchange, contact information, stock price, market cap, and latest earnings data. Use when you need detailed company information for a specific ticker.
Inputs: ticker
Get and Increment Counter
Deprecated compatibility tool that reads, increments, or sets persistent API-key-scoped counter state. Use GET_COUNTER_VALUE for reads or UPDATE_COUNTER for mutations. <<DEPRECATED use API_NINJAS_GET_COUNTER_VALUE or API_NINJAS_UPDATE_COUNTER>>
Inputs: id, hit, value
Get Counter Value
Read the current value of a persistent counter scoped to the connected API key without incrementing or setting it.
Inputs: id
Get Country Flag SVG
Tool to retrieve country flag images in SVG format. Use when you need flag URLs for display or download.
Inputs: country
Get Country Information
Tool to retrieve country information by name, ISO code, or economic and demographic filters. Use to retrieve country population, GDP, surface area, unemployment, fertility, and related statistics.
Inputs: name, limit, max_gdp, min_gdp, max_fertility, min_fertility, max_gdp_growth, max_population, min_gdp_growth, min_population, max_surface_area, max_unemployment, min_surface_area, min_unemployment, max_infant_mortality, min_infant_mortality, max_urban_population_rate, min_urban_population_rate
Get County Information
Tool to retrieve US county information by name, ZIP code, or state. Use when you need geographic, demographic, or administrative data about US counties. Returns county name, FIPS code, location coordinates, timezone, population, and median age.
Inputs: limit, state, county, offset, zipcode
Get COVID 19 Data
Return COVID-19 case or death statistics for a country or date.
Inputs: date, type, county, region, country
Get Crypto Price
Get the current real-time price for a cryptocurrency trading pair. Returns the latest price and timestamp for symbols like BTCUSDT (Bitcoin to USD), ETHUSDT (Ethereum to USD), or crypto-to-crypto pairs like LTCBTC (Litecoin to Bitcoin). Use this to check current cryptocurrency market prices.
Inputs: symbol
Get Crypto Price History
Return historical cryptocurrency OHLCV prices for a symbol and interval. Requires Premium only.
Inputs: end, limit, start, symbol, interval
Get Currency Volatility History
Return historical realized-volatility observations for a currency pair. Requires Premium only.
Inputs: days, pair, method, window, end_date, day_count, annualized, start_date
Get Random Dad Jokes
Tool to retrieve random dad jokes from API Ninjas. Returns one or more dad jokes suitable for light humor. Use when you need clean, family-friendly jokes.
Inputs: limit
Get Day in History Events
Tool to get historical events for a specific date. Use when you need to retrieve events that occurred on a particular day in history. Returns events for today's date if no parameters are provided.
Inputs: day, limit, month, offset
Get Dictionary Definition
Tool to retrieve dictionary definition for an English word. Use when you need the meaning or definition of a word.
Inputs: word
Get Dog Breed Information
Tool to get information on dog breeds matching specified parameters. Use when you need breed characteristics like temperament, size, life expectancy, or other traits.
Inputs: name, energy, offset, barking, shedding, max_height, max_weight, min_height, min_weight, trainability, protectiveness, max_life_expectancy, min_life_expectancy
Get Earnings
Retrieve earnings filings by company or filing date, optionally filtering a company by fiscal period and year.
Inputs: cik, date, year, offset, period, ticker, quarter, date_end, date_start
Get Earnings Calendar
Returns historical actual and estimated EPS and revenue by stock ticker, with an option for premium subscribers to include upcoming scheduled earnings dates.
Inputs: limit, ticker, show_upcoming
Get Earnings Call Transcript
Retrieve the full earnings call transcript for a publicly traded company. Use this tool when you need to analyze what was discussed during a company's quarterly earnings call, including management commentary, Q&A with analysts, financial guidance, and strategic updates. Note: This endpoint requires a premium API Ninjas subscription. Example use cases: - Analyze management sentiment during earnings calls - Extract forward guidance and projections - Review analyst questions and company responses - Compare earnings call content across quarters
Inputs: cik, year, ticker, quarter
Get Electric Vehicle Info
Get electric vehicle information by make, model, year range, or electric range. Returns details including battery capacity, charging power, dimensions, and performance specs. At least one filter parameter (make, model, min_year, max_year, min_range, or max_range) is required - limit and offset alone are not sufficient.
Inputs: make, limit, model, offset, max_year, min_year, max_range, min_range
Get Emoji Information
Tool to retrieve emoji information and images from the API Ninjas Emoji database. Use when you need emoji metadata, Unicode codes, or emoji images based on name, code, category, or subcategory. At least one search parameter (name, code, group, or subgroup) must be provided. Returns up to 30 results per request; use offset for pagination.
Inputs: code, name, group, offset, subgroup
Get ETF Info
Retrieve ETF information by ticker, including its name, ISIN, CUSIP, and country. Expense ratio, AUM, holdings, and number of holdings require a premium subscription and may be null for free-tier users; holdings are limited to the first 10.
Inputs: ticker
Get EU VAT Rates
Retrieve current or historical EU VAT rates by country, with optional VAT type and effective-date filters.
Inputs: type, limit, offset, country, max_date, min_date
Get Exchange Rate
Get the current exchange rate for a currency pair. Returns the conversion rate from the first currency to the second currency. Use this to check current foreign exchange rates between any two currencies.
Inputs: pair
Get Exchange Rate History
Return historical exchange rates for a currency pair and date range. Requires Premium only.
Inputs: date, pair, end_date, start_date
Get Executive Compensation
Return disclosed executive compensation records for a public company.
Inputs: cik, name, year, ticker
Get Exercises
Tool to get exercise information by muscle group, type, or difficulty level. Returns up to 10 exercises that match the specified criteria. Use when you need to find exercises for specific muscle groups, workout types, or difficulty levels.
Inputs: name, type, muscle, offset, difficulty
Get Fact of the Day
Tool to retrieve the fact of the day from API Ninjas. Returns the same fact for all users on a given day, with facts changing daily. Use when you need a daily interesting fact to display or share.
Get Random Facts
Tool to retrieve random interesting facts from API Ninjas. Returns facts about science, literature, philosophy, and other topics. Use when you need interesting factual information to display or share.
Inputs: limit
Get Financial Statement
Retrieve one balance sheet, cash-flow statement, or income statement and its SEC filing metadata for a company and fiscal period.
Inputs: cik, year, period, ticker, statement_type
Get GDP Data
Tool to get GDP data for a country. Use when you need GDP statistics including growth rate, nominal GDP, GDP per capita, and purchasing power parity data.
Inputs: year, country
Convert City to Coordinates
Tool to convert city names to geographic coordinates (forward geocoding). Returns latitude, longitude, and country code for specified city. Use when you need to find the coordinates of a location by its name.
Inputs: city, state, country
Get Gold Price
Return the current COMEX gold futures price and contract month; use Get Gold Spot Price for immediate-delivery spot pricing.
Inputs: unit, currency
Get Gold Price History
Return historical COMEX gold futures OHLCV observations. Requires Premium only.
Inputs: end, start, period
Get Gold Spot Price
Return current immediate-delivery gold spot pricing, bid, and ask; use Get Gold Price for COMEX futures. Requires Premium only.
Inputs: unit, currency
Get Helicopter Information
Tool to get helicopter information by manufacturer, model, and specifications. Use when you need detailed technical specifications for helicopters including speed, range, dimensions, and load capacity. At least one search parameter (manufacturer, model, or specification filter) must be provided.
Inputs: limit, model, max_range, max_speed, min_range, min_speed, max_height, max_length, min_height, min_length, manufacturer
Get Historical Events
Tool to retrieve historical events by date or keywords. Use when you need information about events that happened on a specific date or related to specific topics.
Inputs: day, text, year, month, offset
Get Historical Figures
Tool to search for historical figures by name. Returns biographical information including birth/death dates, titles, awards, offices held, and family details. Use when you need information about famous people from history.
Inputs: name, offset
Get Random Hobby Suggestions
Tool to get random hobby suggestions from API Ninjas. Use when you need inspiration for new hobbies or activities, optionally filtered by category.
Inputs: category
Get Holidays
Retrieve the full 26-type holiday taxonomy for 2005-2039. Use Get Public Holidays for official public holidays only, or List Bank Holidays for bank closures and observed dates.
Inputs: type, year, country
Get Daily Horoscope
Tool to get daily horoscope for a zodiac sign. Returns the horoscope text for the specified zodiac sign and date. Use when you need astrological predictions or daily horoscope information for any of the 12 zodiac signs.
Inputs: date, zodiac
Get Hospital Information
Find hospitals by name, city, state, ZIP code or county. Provide at least one of these filters; coordinate-only searches are not supported. Optional geographic bounds filter the requested provider page. Longitude bounds are applied locally; limit and offset select provider rows before local filtering, so results may be fewer than limit. Advance offset to inspect further pages, even after an empty filtered page.
Inputs: city, name, limit, state, county, offset, zipcode, max_latitude, min_latitude, max_longitude, min_longitude
Get Income Statement
Deprecated compatibility tool for income statements. Use API_NINJAS_GET_FINANCIAL_STATEMENT with statement_type=income_statement. <<DEPRECATED use API_NINJAS_GET_FINANCIAL_STATEMENT>>
Inputs: cik, year, period, ticker
Income Tax
Get federal and regional income-tax rates for a country and year.
Inputs: year, country, regions, federal_only
Get Inflation Data
Tool to get current inflation data for a country. Use when you need latest CPI or HICP monthly and annual inflation rates.
Inputs: type, country
Get Inflation History
Return historical CPI or HICP inflation observations for a country. Requires Premium only.
Inputs: type, country, end_time, start_time
Get Insider Details
Return holdings and recent transactions for an exact insider name. Requires Premium only.
Inputs: name, company_cik, company_ticker
Get Insider Transactions
Tool to get insider trading transactions for publicly traded companies. Returns SEC-filed insider trading data including purchases, sales, and awards by company executives, directors, and major shareholders. Use when you need to track insider activity, analyze insider sentiment, or research specific transactions by ticker, insider name, or transaction details.
Inputs: cik, limit, ticker, form_type, insider_name, insider_type, transaction_code, transaction_date, transaction_type, max_transaction_date, min_transaction_date, max_transaction_value, min_transaction_value
Get Institutional Ownership
Return institutional holders or the ownership summary for one security.
Inputs: sort, cusip, limit, offset, period, ticker, summary, put_call, min_value, min_shares
Get Interest Rate
Look up one current rate with rate (v2), or use legacy v1 aggregate mode with country or an empty request. This does not return a historical series; use Get Interest Rate History for historical observations.
Inputs: rate, country
Get Interest Rate History
Return paginated historical observations for a named benchmark interest rate. Requires Premium only.
Inputs: page, rate, end_date, end_time, start_date, start_time
Get Joke of the Day
Tool to retrieve the joke of the day from API Ninjas. Returns the same joke for all users on a given day, with jokes changing daily. Use when you need a daily joke to display or share.
Get Random Jokes
Tool to retrieve random jokes from API Ninjas. Returns one or more jokes suitable for entertainment. Use when you need general humor content.
Inputs: limit
Get Libor History
Return historical values for a documented LIBOR tenor. Requires Business tier and above.
Inputs: type, end_time, start_time
Get Lottery Draw
Get one game's draw, or the latest draws for games in a state or country.
Inputs: date, game, state, country, session, draw_number
Get Lottery Draw History
Return one bounded page of historical lottery draws. Free includes the latest 10 draws; Developer includes two years; Business tier and above includes the full archive.
Inputs: end, game, limit, start, offset, session
Get Market Cap
Tool to get real-time market cap data for a company. Use when you need up-to-date market capitalization by specifying the stock ticker. Example: "What is the market cap of NVDA?"
Inputs: ticker
Get Metals Prices
Return spot and matching futures data for precious metals plus copper and aluminum; unlike commodity spot tools, copper and aluminum use futures-based spot values identified by spot_type, and dedicated gold spot should be used for gold-only immediate-delivery requests.
Inputs: unit, metal, metals, currency
Get Mortgage Rate
Get current or historical 15-year and 30-year mortgage rates.
Inputs: date, max_date, min_date
Get Motor Carrier
Return a motor carrier record by USDOT or docket number.
Inputs: dot, checks, min_bipd, min_cargo, motor_carrier_number
Get Motor Carrier Insurance
Return active insurance filings for a motor carrier.
Inputs: dot, motor_carrier_number
Get Motor Carrier Links
Return carriers linked through shared identifying attributes.
Inputs: dot, motor_carrier_number
Get Motor Carrier Safety
Return crash, inspection, and BASIC safety data for a carrier.
Inputs: dot, motor_carrier_number
Get Motorcycle Specifications
Tool to get detailed motorcycle specifications by make, model, and year. Use when you need technical data about specific motorcycle models including engine specs, dimensions, transmission, suspension, and performance data.
Inputs: make, year, model, offset
Get Mutual Fund Info
Get mutual fund information by ticker or ISIN, including name, ISIN, CUSIP, and country. Price, expense ratio, assets under management, number of holdings, and holdings require a premium subscription and return null for free-tier users.
Inputs: isin, ticker
Get MX Records
Tool to retrieve MX (Mail Exchange) records for a specified domain. Use when you need to identify mail servers responsible for accepting email for a domain.
Inputs: domain
Get NAICS Code
Look up NAICS records by code, batch, or official title.
Inputs: code, year, codes, title, country, crosswalk_to
Get NAICS Size Standard
Return SBA size standards and optional eligibility calculations. Requires Premium only.
Inputs: code, codes, revenue, employees
Get Nutrition Item
Return nutrition for one food item and quantity.
Inputs: query, quantity
Get Oil Price
Return current futures-contract prices and contract metadata for oil and energy benchmarks; use Get Oil Spot Price for physical immediate-delivery prices.
Inputs: type, unit, types, currency
Get Oil Price History
Return historical OHLCV data for an oil or energy benchmark. Requires Premium only.
Inputs: end, type, start, period
Get Oil Spot Price
Return assessed physical spot pricing for oil and energy benchmarks. Requires Premium only.
Inputs: type, unit, types, currency
Get Planet Information
Tool to retrieve detailed information about planets and exoplanets including mass, radius, orbital period, temperature, and host star data. Use when you need astronomical data about planets in the known universe. At least one parameter (other than offset) must be set.
Inputs: name, offset, max_mass, min_mass, max_period, max_radius, min_period, min_radius, max_temperature, min_temperature, max_distance_light_year, min_distance_light_year
Get Population Data
Get historical and forecast population statistics for a country, including demographic and urban population metrics, or search countries by population range.
Inputs: offset, country, max_population, min_population
Get Postal Code Location Info
Tool to retrieve location information for Canadian postal codes. Returns city, province, coordinates, area code, and timezone data. Use when you need to find location details for a postal code or search by city/province.
Inputs: city, province, postal_code
Get Property Tax Rates
Tool to get property tax rates by city, county, or ZIP code. Use when you need effective property tax rate statistics for a specific location.
Inputs: zip, city, state, county
Get Public Holidays
Tool to retrieve official public holidays for a specific country and year. Use when you need information about federal and regional public holidays for planning, scheduling, or calendar-related tasks. Supports calendar years from 1980 to 2050.
Inputs: year, country
Get Quote of the Day
Tool to retrieve the quote of the day from API Ninjas. Returns the same quote for all users on a given day, with quotes changing daily. Use when you need an inspirational or thought-provoking daily quote to display or share.
Get Random Quotes
Deprecated limited random-quote tool. Use API_NINJAS_GET_RANDOM_QUOTES for larger limits and category exclusions or work-title filtering. <<DEPRECATED use API_NINJAS_GET_RANDOM_QUOTES>>
Inputs: limit, author, categories
Get Random Image
Tool to get a random image by category from API Ninjas. Use when you need random image content for display or download.
Inputs: category
Get Random Quotes
Tool to retrieve random quotes from API Ninjas. Filter by categories, author, or work title. Use when you need inspirational quotes, wisdom, or literary references for content or motivation.
Inputs: work, limit, author, categories, exclude_categories
Get Random Word
Tool to get a random English word from the API Ninjas Random Word endpoint. Use when you need random words for games, education, or creative projects. Optionally filter by word type (noun, verb, adjective, adverb).
Inputs: type
Get Recipe
Search recipes by title, up to five ingredients, or nutrition filters.
Inputs: limit, title, number, offset, max_fat, min_fat, servings, max_carbs, min_carbs, max_sodium, max_sugars, ingredients, max_protein, min_protein, max_calories, min_calories
Convert Coordinates to Location
Tool to convert geographic coordinates to location information (reverse geocoding). Returns location name, country code, and state/region for specified coordinates. Use when you need to find address or place information from latitude and longitude.
Inputs: lat, lon
Get Rhyming Words
Tool to get words that rhyme with a given word. Use when you need to find rhyming words for creative writing, poetry, or songwriting.
Inputs: word
Get Random Riddles
Tool to retrieve random riddles with answers from API Ninjas. Returns one or more riddles suitable for entertainment and brain teasers. Use when you need riddles for games, quizzes, or entertainment purposes.
Inputs: limit
Get Sales Tax Rates
Tool to get sales tax rates by ZIP code or city and state. Use when you need current sales tax rate information for a specific US location. Either provide zip_code alone OR city+state together.
Inputs: city, state, zip_code
Get Sales Tax Filing Requirements
Return state sales-tax filing frequencies, thresholds, and due dates for a year. Requires Business tier and above.
Inputs: year, state, frequency, annual_liability
Get SEC Filing
Tool to retrieve SEC filing information for publicly traded companies. Returns a list of SEC filings including the filing date, form type, and direct URL to the filing document. Use when you need to access company regulatory filings like 10-K annual reports, 10-Q quarterly reports, 8-K current reports, or other SEC documents.
Inputs: limit, filing, ticker, end_date, start_date
Get Short Interest
Return reported short-interest observations for a stock ticker.
Inputs: limit, ticker, settlement_date
Get Short Volume
Return daily short-sale volume observations for a stock ticker.
Inputs: limit, ticker
Get S&P 500 Constituents
Tool to retrieve current S&P 500 index constituents with filtering by ticker, name, sector, or date added. Use when you need information about companies in the S&P 500 index. Returns company details including ticker symbols, names, sectors, CIK numbers, sub-industries, headquarters locations, and dates added to the index.
Inputs: name, limit, offset, sector, ticker, dateadded_max, dateadded_min
Get Star Information
Retrieve star information including constellation, coordinates, magnitude, distance, and spectral classification. Search by name, constellation, or numeric criteria; an optional spectral-class prefix filters only the returned provider page.
Inputs: name, offset, constellation, spectral_class, max_absolute_magnitude, max_apparent_magnitude, min_absolute_magnitude, min_apparent_magnitude, max_distance_light_year, min_distance_light_year
Get Stock Exchange Information
Tool to retrieve stock exchange information by Market Identifier Code (MIC), name, city, or country. Use when you need details about stock exchanges including market data, location, and operational hours.
Inputs: mic, city, name, country
Get Stock Exchange Hours
Return stock exchange session hours and open status for a date or timestamp. Requires Business tier and above.
Inputs: mic, date, timestamp
Get Stock Price
Tool to get current stock price data for any publicly traded company or index. Use when you need real-time (premium) or most recent completed trading-session closing (free) stock prices, trading volume, and market data by ticker symbol.
Inputs: ticker
Get Stock Price History
Return historical OHLCV stock-price points for a ticker and interval. Requires Premium only.
Inputs: end, start, period, ticker
Get SWIFT Code
Tool to get bank information from SWIFT code or search by bank name, city, or country. Use when you need to look up bank details using a SWIFT/BIC code or search for banks by various criteria. At least one parameter must be provided.
Inputs: bank, city, swift, offset, country
Get Thesaurus
Tool to get synonyms and antonyms for an English word. Use when you need to find alternative words with similar or opposite meanings.
Inputs: word
Get Timezone Information
Tool to get timezone information for a location including UTC offset, local time, and timezone name. Use when you need timezone details for geographic locations or IANA timezone names. FREE tier supports timezone parameter; city, state, country, lat, and lon parameters require premium subscription.
Inputs: lat, lon, city, state, country, timezone
Get Treasury Yield
Return the latest or dated Treasury par, real, bill, or combined yield curve.
Inputs: date, type, format
Get Treasury Yield History
Return a paginated Treasury yield time series for one maturity or full curves by date. Requires Premium only.
Inputs: page, type, format, end_date, maturity, start_date
Get Trivia Questions
Tool to retrieve trivia questions by category from API Ninjas. Returns trivia questions with answers from various categories like music, sports, science, and more. Use when you need trivia questions for games, quizzes, or entertainment purposes.
Inputs: limit, category
Get Trivia of the Day
Tool to retrieve the trivia question of the day from API Ninjas. Returns the same trivia question for all users on a given day, with questions changing daily. Use when you need a daily trivia question to display or share.
Get Unemployment Rate
Tool to get unemployment rate data for countries. Use when you need historical or current unemployment statistics by country or year.
Inputs: year, country
Get University Information
Tool to retrieve university information by name or country. Use when you need details about universities worldwide including location, contact info, enrollment, tuition, and degree programs offered. At least one search parameter (name or country) is required.
Inputs: name, limit, offset, country
Get Current Weather
Tool to retrieve current weather data for a location. Use when you need real-time weather information including temperature, humidity, wind conditions, and sunrise/sunset times. Query by city name or GPS coordinates.
Inputs: lat, lon, city, state, country
Get Weather Forecast
Tool to retrieve 5-day weather forecast in 3-hour intervals for a location. Use when you need future weather predictions including temperature, humidity, wind, and sunrise/sunset times. Query by GPS coordinates or city name.
Inputs: lat, lon, zip, city, state, country
Get WHOIS Information
Tool to get WHOIS domain registration information including registrar, creation date, and expiration date. Use when you need details about domain registration.
Inputs: domain
Get Working Days
Get working-day counts and dates for a country by year or month, accounting for weekends and public holidays. Weekend days and whether public holidays count as non-working days can be configured.
Inputs: year, month, country, weekend, public_holidays
Get World Time
Tool to get current date and time for a location with detailed date/time components. Returns timezone, datetime, date, year, month, day, hour, minute, second, and day of the week. Use when you need detailed time information for a specific location or timezone.
Inputs: lat, lon, city, timezone
Get US Zipcode Location Info
Tool to retrieve location information for US zip codes. Returns city, state, county, coordinates, timezone, and area codes. Use when you need to find location details for a zip code or search by city/state.
Inputs: zip, city, state
List Airports
List airport ICAO codes and names with offset pagination. Requires Annual plans only.
Inputs: offset
List Balance Sheet Periods
Deprecated compatibility tool that lists only balance-sheet filing availability. Use API_NINJAS_LIST_FINANCIAL_STATEMENT_PERIODS with statement_type=balance_sheet. Requires Premium only. <<DEPRECATED use API_NINJAS_LIST_FINANCIAL_STATEMENT_PERIODS>>
Inputs: cik, ticker
List Bank Holidays
List bank holidays for a country and year, including regional and observed dates.
Inputs: year, country
List Breeds
List all cat or dog breed names accepted by the corresponding API Ninjas animal endpoint. Requires Premium.
Inputs: species
List Calorie Burning Activities
List activity names accepted by the Calories Burned calculator. Requires Premium only.
List Car Generations
List vehicle generations for a make and model, optionally limited to generations with cars. Requires Business tier and above, or any annual plan.
Inputs: make, year, limit, model, offset, has_cars, chassis_code
List Car Makes
List vehicle makes, optionally filtered by search text or model year. Requires Premium only.
Inputs: year, limit, offset, search
List Car Models
List vehicle models for a make, optionally filtered by search text or model year. Requires Premium only.
Inputs: make, year, limit, offset, search
List Cash Flow Periods
Deprecated compatibility tool that lists only cash-flow filing availability. Use API_NINJAS_LIST_FINANCIAL_STATEMENT_PERIODS with statement_type=cash_flow. Requires Premium only. <<DEPRECATED use API_NINJAS_LIST_FINANCIAL_STATEMENT_PERIODS>>
Inputs: cik, ticker
List Cat Breeds
Deprecated compatibility tool for listing cat breeds; use List Dog Breeds only for the old dog-specific interface. Use API_NINJAS_LIST_BREEDS with species=cat. Requires Premium only. <<DEPRECATED use API_NINJAS_LIST_BREEDS>>
List Commodity Contracts
List all available commodity futures contracts and their symbols; this endpoint accepts no root filter. Requires Business tier and above, or any annual plan.
List Company Insiders
List corporate insiders and current holdings for a public company. Requires Premium only.
Inputs: cik, ticker
List Countries
List 2-letter country codes accepted by the Country API. Requires Premium only.
List Country Flags
List country codes with square and rectangular SVG flag image URLs. Requires Premium only.
List Crypto Symbols
List cryptocurrency symbol pairs accepted by the Crypto Price API. Requires Premium only.
List Dog Breeds
Deprecated compatibility tool for listing dog breeds; use List Cat Breeds only for the old cat-specific interface. Use API_NINJAS_LIST_BREEDS with species=dog. Requires Premium only. <<DEPRECATED use API_NINJAS_LIST_BREEDS>>
List Earnings Calendar Companies
List companies covered by the earnings calendar. Requires Premium only.
List Earnings Call Participants
List executives or analysts who appeared on a company's earnings calls. Requires Business tier and above.
Inputs: cik, limit, offset, ticker, sort_by, sort_dir, speaker_type
List Earnings Transcripts
List companies with available earnings-call transcripts. Requires Premium only.
Inputs: limit, offset
List Electric Vehicle Makes
List electric-vehicle makes available to the Electric Vehicle API. Requires Business tier and above, or any annual plan.
Inputs: year
List Electric Vehicle Models
List electric-vehicle models for a selected make. Requires Business tier and above, or any annual plan.
Inputs: make, year
List ETFs
List ETF ticker symbols available to the ETF API. Requires Business tier and above, or any annual plan.
Inputs: offset
List Exercises
List exercise names for a target muscle group with offset pagination. Requires Business tier and above, or any annual plan.
Inputs: limit, muscle, offset
List Failures To Deliver
List the latest and historical SEC failures-to-deliver records for a security.
Inputs: limit, ticker
List Financial Statement Periods
List fiscal years and periods with an available balance sheet, cash-flow statement, or income statement for a company. Requires Premium.
Inputs: cik, ticker, statement_type
List Income Statement Periods
Deprecated compatibility tool for income-statement availability. Use API_NINJAS_LIST_FINANCIAL_STATEMENT_PERIODS with statement_type=income_statement. Requires Premium only. <<DEPRECATED use API_NINJAS_LIST_FINANCIAL_STATEMENT_PERIODS>>
Inputs: cik, ticker
List Institutional Movers
List securities with the largest recent institutional ownership changes. Requires Premium only.
Inputs: cik, limit, period, mover_type
List IPO Calendar
List documented US IPO calendar records and filing details.
Inputs: cik, date, limit, offset, status, ticker, date_end, exchange, sic_code, deal_type, date_field, date_start
List Lottery Games
List documented lottery games and their rules.
Inputs: game, state, country
List Lottery Jackpots
List current lottery jackpots using optional geography and currency filters. Requires Premium only.
Inputs: min, state, country, currency
List Motorcycle Makes
List motorcycle manufacturers accepted by the motorcycle API. Requires Business tier and above, or any annual plan.
List Motorcycle Models
List motorcycle models for a manufacturer. Requires Business tier and above, or any annual plan.
Inputs: make
List Quote Authors
List quote authors available to the Quotes API with offset pagination. Requires Premium only.
Inputs: limit, offset
List Sales Tax Holidays
Return US sales tax holiday periods, eligible categories, price caps, and coverage metadata.
Inputs: date, year, state, amount, category
List Short Interest Calendar
List short-interest settlement and publication dates for a calendar year.
Inputs: year, limit, upcoming
List Stock Exchange Holidays
List market holidays and closure details for a stock exchange. Requires Business tier and above.
Inputs: mic, name
List Stock Exchanges
List all stock exchanges and their identity, location, market size, currency, timezone, and session details. Requires Business tier and above.
List Stock News
List dated news articles for one or more stock tickers with offset pagination. Requires Premium only.
Inputs: date, offset, ticker, end_date, start_date
List Stock Splits
List forward or reverse stock splits for a ticker or date range.
Inputs: date, limit, offset, ticker, date_end, exchange, date_start, split_type
List Stock Tickers
Tool to retrieve a paginated list of all available stock ticker symbols and company names. Use when you need to browse available stocks or find ticker symbols for specific companies. Returns company tickers and names with pagination support.
Inputs: limit, offset
List Upcoming Earnings
List scheduled company earnings announcements by date or ticker. Requires Premium only.
Inputs: date, limit, offset, ticker, end_date, exchange, start_date
List Weather Icons
List weather condition codes and their icon metadata. Requires Premium only.
Lookup BIN
Look up issuer, country, and payment-network details for a BIN.
Inputs: bin
Lookup BSB
Look up an Australian BSB and return its bank, branch, address, and payment-network details.
Inputs: bsb
Lookup Canada Routing Number
Look up a Canadian routing number or transit and institution pair to return branch details.
Inputs: routing_number, transit_number, institution_number
Lookup DNS Records
Tool to retrieve DNS records for a specified domain. Use when you need DNS record details for troubleshooting or validation.
Inputs: domain
Lookup IBAN
Tool to look up and validate an International Bank Account Number (IBAN). Use when you have an IBAN and need to retrieve its components (country, bank code, account number, etc.) and its validity.
Inputs: iban
Lookup India Pin Code
Look up Indian postal locations by PIN code, city, district, or state.
Inputs: city, state, pincode, district
Lookup IP Address
Look up geolocation and ISP information for an IPv4 or IPv6 address. City, coordinates and ISP information may require Premium access.
Inputs: address
Lookup Phone Number
Deprecated compatibility tool using the phone-number lookup input and response. Use API_NINJAS_VALIDATE_PHONE_NUMBER. <<DEPRECATED use API_NINJAS_VALIDATE_PHONE_NUMBER>>
Inputs: number, country
Lookup Sort Code
Look up a UK sort code and return its bank, branch, address, and payment capabilities.
Inputs: sort_code
Lookup URL
Tool to get location information for a URL domain. Returns geolocation data including country, region, city, coordinates, ISP, and timezone. Use when you need to identify the geographic location or hosting provider of a URL.
Inputs: url
VIN Lookup
Tool to decode Vehicle Identification Number (VIN) and retrieve vehicle information. Returns make, model, year, manufacturing country, and VIN components. Use when you need to identify vehicle specifications from a 17-character VIN.
Inputs: vin
Parse User Agent
Parse a user-agent string into browser, operating-system, and device details.
Inputs: user_agent
Scrape Website Content
Tool to scrape HTML content from a URL using the API Ninjas Webscraper endpoint. Use when you need to retrieve website content programmatically without dealing with browser automation.
Inputs: url, text_only, user_agent
Screen Sanctions
Screen a person or organization against supported sanctions lists and return candidate matches.
Inputs: dob, name, country, sources, min_score, entity_type, nationality
Screen Short Interest
Screen securities by exchange and short-interest metrics. Requires Business tier and above.
Inputs: limit, order, sector, sort_by, exchange, min_price, settlement_date, min_days_to_cover, exclude_capped_float, min_shares_outstanding, min_short_percent_float, max_float_price_gap_days
Search Bitcoin Treasuries
Deprecated Bitcoin-only treasury search. Use API_NINJAS_SEARCH_CRYPTO_TREASURIES with asset=BITCOIN. <<DEPRECATED use API_NINJAS_SEARCH_CRYPTO_TREASURIES>>
Inputs: cik, name, limit, offset, period, ticker, entity_type, include_unverified
Search Branded Foods
Find branded food nutrition by barcode, product name, or brand. Requires Premium only.
Inputs: upc, name, brand, limit, offset
Search Bsbs
Search Australian BSB branches by bank, suburb, state, or postcode. Requires Premium only.
Inputs: state, offset, suburb, postcode, bank_name
Search Canada Routing Numbers
Search Canadian bank branches by institution, city, province, or postal code. Requires Premium only.
Inputs: city, offset, province, bank_name, postal_code
Search Crypto Treasuries
Search SEC-reported cryptocurrency holdings across supported digital assets.
Inputs: cik, name, asset, limit, offset, period, ticker, entity_type, include_unverified
Search Earnings Call Speakers
Search earnings-call speakers or retrieve one speaker's profile and appearance history. Requires Business tier and above.
Inputs: name, role, year, limit, offset, ticker, company, quarter, sort_by, sort_dir, speaker_id, analyst_firm, speaker_type, include_appearances
Search Earnings Transcripts
Find available earnings-call transcript records by company or call date; this does not search transcript text. Requires Premium only.
Inputs: cik, date, limit, offset, ticker, end_date, start_date
Search ETFs
Search ETFs by fund name, AUM, expense ratio, holdings, or listing country; use Get ETF for an exact ticker. Requires Business tier and above, or any annual plan.
Inputs: name, offset, country, max_aum, min_aum, holdings, max_expense_ratio, min_expense_ratio
Search Institutional Holdings
Search an institutional manager's holdings by manager CIK or exact manager name, with optional security and reporting-period filters.
Inputs: cik, sort, cusip, limit, offset, period, ticker, group_by, put_call, max_value, min_value, change_type, manager_name
Search Institutional Investors
Search the institutional-manager directory, filing history, or available quarters. Requires Premium only.
Inputs: cik, name, limit, offset, period, period_list
Search Motor Carriers
Search motor carriers using documented identity and location filters.
Inputs: zip, city, name, email, limit, phone, state, offset, status
Search NAICS Codes
Search official NAICS text for relevant codes.
Inputs: level, limit, query
Search Routing Numbers
Search US routing numbers by bank name, location, ZIP code, or SWIFT code. Requires Premium only.
Inputs: city, state, offset, zip_code, bank_name, swift_code
Search Sort Codes
Search UK bank branches by bank name, city, or postcode. Requires Premium only.
Inputs: city, offset, postcode, bank_name
Search Tickers
Search public-company ticker symbols by company name and keyword exclusions. Requires Premium only.
Inputs: name, negative_keywords
Solve Sudoku Puzzle
Tool to solve a Sudoku puzzle using the API Ninjas Sudoku Solver. Takes a partially filled puzzle grid and returns the complete solution if one exists. Use when you need to solve standard or custom-sized Sudoku puzzles (2x2, 3x3, or 4x4 box dimensions).
Inputs: width, height, puzzle
Suggest Airports
Suggest compact airport matches for a name or code query, optionally filtered by country and size. Requires Premium only.
Inputs: size, limit, query, country
Update Counter
Increment or set persistent counter state scoped to the connected API key; use value=0 to reset a counter.
Inputs: id, value, increment
Validate Email
Validate an email address and check its deliverability. Returns validity and domain information, whether the domain has MX records, disposability status, and email role categorization.
Inputs: email
Validate Phone Number Format
Validate phone-number formatting and return normalized national, international, and E.164 forms plus country, location, and time-zone information. This endpoint does not return carrier or line-type metadata; use Validate Phone Number for that lookup.
Inputs: number
Validate Phone Number
Validate and normalize a phone number and return country, carrier, line-type, VoIP, mobile-network, and disposable-number metadata.
Inputs: country, phone_number
Validate Routing Number
Tool to validate and retrieve bank information from a routing number. Use when you need to verify a 9-digit routing number and get associated bank details including name, location, and contact information.
Inputs: routing_number
Validate VAT Number
Validate a VAT number and return its registration and business details.
Inputs: vat, country, requester_vat