API Ninjas integration: operations for AI agents
API Ninjas connects to Type.com as an integration. This page lists the 264 operations documented for Claude and Codex in Type.com: 258 read, 6 write.
About API Ninjas
API Ninjas offers over 120 unique APIs across various categories, enabling developers to build real applications with real data.
Categories: Developer Tools & IT
How to connect API Ninjas to Type.com
- Access
- Organization connection: one shared account for the workspace.
To add the connection, follow the steps in Space connections.
Documented operations
264 operations. Your connection's permissions determine which operations are available. API references describe the vendor surface; they do not expand your connection's credentials or access.
264 operations listed.
Advice
- Read
Get a random piece of advice
Returns one random piece of life advice, drawn from a set of over 5000 entries. Takes no parameters and returns a different result each call.
Air Quality
- Read
Get air quality by city or location coordinates.
Returns the Air Quality Index plus CO, NO2, O3, SO2, PM2.5 and PM10 concentrations for a location. Requires a city or lat/lon; state and country disambiguate city names. Searching by city is premium only; free-tier requests can use lat/lon.
Aircraft
- Read
Get aircraft details
Returns airplane specs matching the given filters, or decodes an ICAO (icao=A20N) or IATA (iata=32N) aircraft type code. At least one parameter other than limit is required. Helicopter specs: /v1/helicopter.
Airlines
- Read
Get general and detailed fleet information for airlines.
Returns general and fleet information for airlines matching an ICAO code, IATA code, or name. At least one of icao, iata, or name must be set.
Airports
- Read
Get airport information
Returns airports matching filters such as IATA/ICAO code, name, city, country, region, elevation, size, or runway length. For typeahead suggestions use /airportsuggest.
- Read
Get a list of airport codes and names. Premium only.
Returns a paginated list of airport codes and names. For filtered airport detail use /airports. Requires a premium subscription.
- Read
Convert between IATA and ICAO airport codes. Premium only.
Converts an airport code between IATA and ICAO. Pass exactly one of iata, icao, or code (auto-detected). Requires a premium subscription.
- Read
Calculate the great-circle distance, initial bearing, and estimated flight time between two airports. Premium only.
Calculates great-circle distance, initial bearing, and estimated flight time between two airports. Requires from and to. Requires a premium subscription.
- Read
Autocomplete / typeahead suggestions for airport search. Matches against IATA, ICAO, name, and city. Premium only.
Returns autocomplete suggestions for airport search, matching IATA, ICAO, name, and city. Requires a q of at least 2 characters. Requires a premium subscription.
- Read
Find the airports nearest to a given latitude/longitude. Results are sorted by airport size (largest first), then by di…
Returns the airports nearest a coordinate, sorted by airport size then by distance. Requires lat and lon. Requires a premium subscription.
Analytics
- Read
Get account analytics
Returns usage analytics and API call history for your own account, including which APIs you call most. Pass your API key in the X-Api-Key header or as the apikey query parameter. Calls here do not consume quota.
Animals
- Read
Retrieve information about animals
Returns scientific facts about animal species whose common name matches the search term, including partial matches. Requires name.
Baby Names
- Read
Retrieve baby names
Returns baby names, optionally filtered by gender (boy, girl or neutral). By default only popular names, the top 10%, are returned; set popularonly to false for the full pool.
Balance Sheet
- Read
Get balance sheet data for a specific company, period, and year
Returns balance sheet data from SEC 10-Q and 10-K filings for one company, fiscal period and year. Requires ticker or cik. For which periods exist use /balancesheetavailability.
- Read
List which fiscal periods have balance sheet data for a company (premium)
Returns the fiscal years and quarters for which balance sheet data is available for a company. Requires a premium subscription (Developer tier and above).
Bank Holidays
- Read
Get bank holidays for a given country and year.
Returns bank holidays for a country and calendar year. Requires a country. To test a single date use /isbankholiday.
- Read
Check if a specific date is a bank holiday for a given country.
Checks whether banks are closed nationwide on a given date in a country, or in one of its regions when subdivision is given. Requires date and country. For a whole year's calendar use /bankholidays.
Barcode
- Read
Generate a barcode
Generates a barcode image encoding text. Optional type, format and includetext control the symbology and output. Requires text.
Bible
- Read
Get Bible passages, a random verse or the verse of the day
Returns Bible passages by reference, in one translation or up to five side by side, a random verse, or the verse of the day. A passage can be a single verse, a range, a whole chapter or a whole book. Provide ref, or set random or daily to true.
- Read
Search the Bible by keyword, phrase, Strong's number or meaning
Searches the Bible by keyword, exact phrase, Strong's number or meaning, and finds verses that are close in meaning to a given verse. Provide q or similarto.
- Read
Check whether a quote is really in the Bible
Checks whether a quote is really in the Bible: returns a verdict, where the words actually are, the Bible text, a similarity score and a word-by-word comparison, and flags quotes attributed to the wrong verse.
- Read
Check a quote or every quoted reference in a block of text (JSON body)
The same check as GET /v1/bibleverify with the parameters in a JSON body. Use it for long text (up to 20,000 characters).
Finance
- Read
Lookup bank information by BIN
Returns bank and issuer information for a Bank Identification Number. Requires a bin, typically the first 6-8 digits of a credit card number.
- Read
Converts an existing currency and amount into a new currency.
Converts an amount from one currency to another. Requires have, want and amount. For the raw rate without converting a figure use /exchangerate.
- Read
Latest realized volatility, volatility cone, and percentile context for a currency pair.
Returns the latest realised volatility for a currency pair, with optional window, method and annualisation. For a time series use /currencyvolatilityhistorical.
- Read
Historical time series of rolling volatility for a currency pair.
Returns a realised volatility time series for a currency pair across a date range or days lookback. For the latest single value use /currencyvolatility.
- Read
EWMA and GARCH(1,1) volatility forecasts for a currency pair.
Projects forward volatility for a currency pair over a horizon, using EWMA or a comparable method. For realised values instead use /currencyvolatility.
- Read
Get market cap data for a given company ticker.
Returns real-time market capitalization data for a company listed on a major exchange. Requires a ticker such as NVDA. Premium plans get live data; free plans get the market cap at the close of the most recent completed trading session.
- Read
Get sales tax information by ZIP code, city, or state
Returns the sales tax rate and its breakdown for a US zipcode, or for a streetaddress with city and state for the most accurate result. For thresholds use /salestaxnexus.
- Read
US sales tax filing due dates, frequencies and prepayment schedules (premium only)
PREMIUM ONLY - Business tier and above; requests below that return an error. Filing frequencies and due dates by US state. Calendars are GENERATED from each state's published rules, so all state due dates stay correct across years.
- Read
US sales tax holidays: dates, eligible categories and price caps
Sales tax holidays for US states, with timezone-aware start and end timestamps, eligible item categories and per-item price caps. Supply a date, category and amount to get an exemption determination for a single purchase.
- Read
Check US sales tax economic nexus thresholds and whether a seller has crossed them (premium only)
PREMIUM ONLY - requests on the free tier return an error. Returns economic nexus thresholds for US states. Call it with no sales figures as a reference lookup, or supply sales figures to get a determination. Omit the state parameter to evaluate all 50 states and DC in one call.
- Read
Upcoming US sales tax rate changes by state, county, city and district (premium only)
PREMIUM ONLY - Developer plans and above; requests below that return an error. Announced and scheduled changes to US sales and use tax rates for states, counties, cities and special districts, sorted by effective date (changes without a date yet come last).
Bitcoin
- Read
Get the latest Bitcoin price and market data
Returns the latest Bitcoin price and market data. Takes no parameters. For a price series over a past time range use /bitcoinhistorical.
- Read
Get historical Bitcoin price data
Returns historical Bitcoin price data over a chosen interval and Unix timestamp range. For the latest price instead use /bitcoin.
- Read
Get SEC-reported bitcoin holdings of companies and ETFs
Bitcoin positions reported to the SEC in quarterly XBRL filings, covering operating companies and spot bitcoin exchange-traded products. Each position is as of the filer's reported period end. For holdings in other crypto assets use /v1/cryptotreasury.
BSB
- Read
Get Australian Bank Branch Information by BSB Number
Looks up the bank, branch, address and supported payment systems for a 6-digit Australian BSB number. Requires bsb. To find a BSB by bank or location use /bsbsearch.
- Read
Search for Australian Bank Branches and BSB Numbers
Finds Australian bank branches and their BSB numbers by bank name, suburb, state or postcode. To look up a single BSB number already known use /bsblookup.
Bucket List
- Read
Get a random bucket list idea
Returns one randomly chosen bucket list idea. Takes no parameters, so call it again for a different suggestion.
Calories Burned
- Read
Calculate calories burned
Calculates calories burned from an activity, weight in pounds, and duration in minutes. Requires an activity. For valid names use /caloriesburnedactivities. The imageurl and iconurl fields are premium only.
- Read
List all supported activities
Returns the names of all activities supported by the calories-burned calculation. To compute calories for one of them use /caloriesburned.
Canada Routing Number
- Read
Get Canadian Bank Branch Information by Routing Number
Returns the Canadian bank branch for a 9-digit EFT routingnumber, or for a transitnumber plus institutionnumber. To search by name or location use /canadaroutingnumbersearch.
- Read
Search for Canadian Banks and Routing Numbers
Finds Canadian bank branches and their routing numbers by bank name, city, province or postal code. To decode a known routing number use /canadaroutingnumber. Requires a premium subscription.
Cars
- Read
Find cars, or fetch known cars by id. Always returns full specifications. Premium only.
The main endpoint. Search the whole catalogue by any combination of filters, or fetch cars you already know with id/ids. Every car is returned with its complete specification sheet attached, so no second call is needed.
- Read
Available values and counts for each dimension, given a selection.
Builds every dependent dropdown in one request instead of one request per level. Facets narrow with whatever is already selected. Available on every plan, including Free.
- Read
List manufacturers. Premium only.
Lists car manufacturers available in the catalogue. Use it to populate a make selector before calling /carmodels. Requires a paid plan (Premium).
- Read
List models for a manufacturer. Premium only.
Lists the models belonging to a given manufacturer. Pair with /carmakes upstream and /cargenerations downstream. Requires a paid plan (Premium).
- Read
List generations of a model, by chassis code where one exists. Business, Professional, or annual plans only.
The level most vehicle APIs do not expose. Optional: nothing downstream requires it. Generations with no cars are returned with carcount 0 so gaps are visible. Requires a Business or Professional plan, or any annual plan.
Cash Flow
- Read
Get cash flow statement data for a specific company, period, and year
Returns cash flow statement data from SEC 10-Q and 10-K filings for one company, fiscal period and year. Requires ticker or cik. For available periods use /cashflowavailability.
- Read
List which fiscal periods have cash flow data for a company (premium)
Returns the fiscal years and quarters for which cash flow data is available for a company. Requires a premium subscription (Developer tier and above).
Cats by API Ninjas
- Read
Get a list of cat breeds matching specified parameters.
Returns cat breeds matching the given parameters, including weight, life expectancy, shedding, grooming and friendliness traits. For breed names only use /allcats.
- Read
Returns a list of all cat breed names.
Returns the names of every cat breed in the database and nothing else. Takes no parameters. For full breed detail and filtering use /cats.
Celebrity
- Read
Get celebrity information
Returns celebrity records with net worth, profession, and birthday, filtered by name, net worth range, nationality, or height in meters.
Chuck Norris
- Read
Get a Chuck Norris joke
Returns one random Chuck Norris joke. Takes no parameters. For jokes on other topics such as pop culture, science or history use /jokes.
City
- Read
Get city data
Get city data from either a name or population range. Returns a list of cities that satisfies the parameters.
Cocktail
- Read
Search cocktail recipes
Searches cocktail recipes by name, with partial matches, or by a comma-separated ingredient list that returns only drinks containing every listed ingredient.
Commodity Price
- Read
Get current commodity price (single or batch)
Returns the current price for a single commodity (when name is provided) or a list of commodities (when names is provided). Optional currency and unit parameters convert the response from the native USD/USX quote into any supported currency and unit.
- Read
Get the current spot price of a commodity (single or batch)
Premium only. Returns the spot price (the price for immediate delivery) for commodities that have a spot market: gold, silver, platinum, and palladium (composite: a live spot price, with bid/ask) and WTI, Brent, natural gas, gasoline, and heating oil (assessed: the daily spot pr…
- Read
Get historical commodity prices
Returns a historical price series for a commodity over an optional Unix start/end range and interval. Requires a name. For the latest price use /commodityprice.
- Read
Get current prices for all supported commodities in a single call
Returns an enriched price object for all 30 supported commodities on every plan, including the free tier. Free responses carry the last completed daily settlement; premium plans return the live price. Optional filters narrow the result set.
- Read
Get price information for a specific commodity contract
Returns price information for a specific commodity contract or all contracts matching a commodity root. Either symbol or symbolroot must be provided, but not both.
- Read
Get a list of all available commodity contracts
Returns a list of all available commodity contracts with their symbols and commodity names. This endpoint is useful for discovering which contracts are available for querying.
- Read
Get the forward curve (all active contracts) for a commodity
Returns every active futures contract for the requested commodity, sorted by contract month, along with a contango/backwardation classification and 1-month and ~12-month percent slopes. Reserved for Business, Professional, and annual-subscription tiers.
Counter
- Read
Fetch and possibly update a counter.
Fetches a stored integer counter by id, optionally incrementing it with hit or setting it to a given value. Using a new id creates a new counter.
Country Flag
- Read
List flag URLs for all supported countries (premium only).
Returns flag image URLs for every supported country, territory and area. For one country's flag use /countryflag. Requires a premium subscription.
- Read
Get the SVG flag image URLs for one country.
Returns URLs of one country's square and rectangle SVG flag images. Requires a 2-letter ISO-3166 alpha-2 country code. For URLs of all supported flags use /allcountryflags.
Country
- Read
List 2-letter ISO country codes for all supported countries (premium only).
Returns the 2-letter ISO codes of every supported country. For statistics about a specific country use /country. Requires a premium subscription.
- Read
Get country data from given parameters.
Returns geographic, demographic, and economic statistics for countries matching filters such as name, currency, GDP, population, area, or unemployment rate.
Places
- Read
Get County Information
Returns details for one or more counties matching the input parameters.
- Read
Get unemployment data for a given country.
Returns national unemployment rates, optionally filtered by country and year. Omit both to retrieve the latest figures across countries.
Covid 19
- Read
Get Covid-19 case count or death data.
Returns Covid-19 case counts or deaths by country, administrative region, or US county, as a series or a single-day snapshot. Either date or country must be set.
Crypto Price
- Read
Get historical OHLCV data for a cryptocurrency
Returns historical OHLCV candles for a cryptocurrency at a chosen interval and time range. Requires a symbol such as ETHUSDT. For the live price use /cryptoprice.
- Read
Get current price of a cryptocurrency
Returns the current market price of a cryptocurrency. Requires a symbol such as ETHUSDT. For past prices and OHLCV candles use /cryptopricehistorical.
- Read
Get SEC-reported corporate crypto treasury holdings
Crypto asset positions reported to the SEC in quarterly XBRL filings. Coverage is limited to SEC filers (holders listed only outside the US are not included), and each position is as of the filer's reported period end.
Crypto Symbols
- Read
Retrieve cryptocurrency symbols
Returns the list of cryptocurrency ticker symbols available. Use it to find valid symbols before requesting quotes from the Crypto Price API.
Dad Jokes
- Read
Get a random dad joke
Returns one or more random dad jokes. The limit parameter, which returns up to 100 jokes in a call, is available on premium plans only.
Day in History
- Read
Get historical events for a specific date
Returns historical events that happened on a given month and day. Free requests cover today's date only; other dates plus limit and offset require premium.
Text
- Read
Look up word definition
Returns a string containing definitions for a given word.
- Read
Detects and censors profanity in text.
Screens text for profanity and returns a censored version plus a flag indicating whether anything was found. Requires text.
- Read
Detects the language of the given text.
Detects which language a text is written in, across over 50 supported languages. Requires text of at most 1000 characters.
- Read
Get synonyms and antonyms for a word
Returns the synonyms (similar words) and antonyms (opposite meanings) of a single English word. Requires a word to look up.
Disposable Email Checker by API Ninjas
- Read
Check if an email is from a disposable email provider
Checks whether an email address comes from a disposable or temporary email provider, for sign-up and fraud screening. Requires email.
DNS Lookup
- Read
Retrieve DNS records for a domain
Retrieves DNS records for a domain, covering the A, AAAA, CNAME, MX, NS, PTR, SRV, SOA, TXT and CAA record types. Requires domain.
Dogs
- Read
Get a list of dog breeds matching specified parameters.
Returns dog breeds matching filters such as name, height, weight, life expectancy, shedding, barking, energy, or trainability. For breed names only use /alldogs.
- Read
Returns a list of all dog breed names.
Returns the names of every dog breed in the database and no other fields. For breed traits and measurements such as height, weight, and shedding use /dogs.
Domain
- Read
Checks domain availability and retrieves basic registration information.
Checks whether a domain is available and returns basic registration information. Requires a domain; top-level domains other than .com need a premium subscription.
Earnings Calendar
- Read
Get earnings results and upcoming dates
Returns earnings reports for one company (ticker), one calendar date (date), or a date range (datestart/dateend). At least one of these is required, and date cannot be combined with a range. Covers 50,000+ tickers on US and international exchanges with history back to 2000.
- Read
Get a list of all available companies in the earnings calendar
Returns the list of companies covered by the earnings calendar. For a specific company's earnings results and reporting dates use /earningscalendar.
- Read
Get upcoming earnings dates with filtering
Returns a list of upcoming earnings dates with filtering capabilities. You can filter by date range, single date, exchange, or ticker symbol. Results are limited to dates from today onwards. Premium only.
Earnings Call Transcript
- Read
Get Earnings Call Transcript
Returns the full text of one company's earnings call. Requires a ticker or cik; to find which calls exist first, use /earningstranscriptsearch. Choosing a quarter requires premium.
- Read
List All Earnings Call Transcripts
Lists all available earnings call transcripts, paged with limit and offset. To filter by ticker, CIK or date use /earningstranscriptsearch; for the text of one call use /earningstranscript.
- Read
Search for available earnings call transcripts by ticker, CIK, date, or date range, with paginated results
Finds which earnings call transcripts are available by ticker, CIK, date or date range, with paginated results. Returns the matching calls, not their text; read that from /earningstranscript.
- Read
Search earnings-call speakers, or get one speaker's profile and appearance history by id
Searches earnings-call speakers by name, company, analyst firm, role or type, or returns one speaker's profile, coverage and appearance history when id is given.
- Read
List the executives and analysts who appeared on a company's earnings calls
Lists the executives and analysts who appeared on one company's earnings calls. Requires a ticker or cik. For a single person across companies use /earningstranscriptspeaker.
Earnings
- Read
Get earnings report data (returns an array; query by company or by filing date)
Returns reported earnings results, filtered by ticker, cik, year, quarter or filing date. For dates of upcoming reports use /earningscalendar.
Electric Vehicle
- Read
Get electric vehicle data by various parameters
Returns electric vehicle records with range, battery, charging, and performance data, filtered by make, model, year, or range. For maker names use /electricvehiclemakes.
- Read
Get a list of all electric vehicle manufacturers
Returns the list of electric vehicle manufacturers, optionally filtered by year. For the models of one manufacturer use /electricvehiclemodels.
- Read
Get all models for a specific manufacturer
Returns all electric vehicle models for one manufacturer, optionally filtered by year. Requires a make. For full vehicle specs use /electricvehicle.
AI
- Read
Analyzes the sentiment of the provided text
Analyzes the sentiment of a piece of text and returns a sentiment result for it. Requires text of at most 2000 characters.
- Write
Encode text to vector
Encodes any given text into a 768-dimensional vector using state-of-the-art NLP machine learning models.
- Write
Detect faces in an image
Runs computer-vision face detection on an image supplied in the POST request body and returns the faces found. Takes no query parameters.
- Write
Extracts text from an image
Given an input image, return all detected texts and their bounding boxes.
- Write
Detect objects in an image
Detects and labels the objects present in an image using a neural network. The image is sent in the body of the POST request.
Entertainment
- Read
Get Emojis
Returns a list of emojis according to input parameters. Returns at most 30 results. To access more than 30 results, use the offset parameter to offset results in multiple API calls.
- Read
Get daily horoscope for a specific zodiac sign
Returns the daily horoscope for one zodiac sign. An optional date in YYYY-MM-DD format gives a past day's horoscope; future dates are not accepted.
ETF
- Read
Get ETF Information
Returns holdings, expense ratio, assets under management and trailing total-return performance for one ETF. Look it up by ticker, or by isin to get the fund's most-traded listing. listings lists every exchange the same fund trades on.
- Read
List Supported ETF Tickers
Returns ETF ticker symbols supported by the ETF API, paginated up to 1000 per call. Increment the offset parameter by 1000 until fewer than 1000 results are returned to walk the entire list. Available to Business, Professional, or annual subscribers only.
- Read
Search ETFs
Search for ETFs by name, AUM, expense ratio, holdings, or country. Results are sorted by AUM descending and paginated 50 per page. At least one filter parameter is required. Available to Business, Professional, or annual subscribers only.
Euribor
- Read
Get current Euribor rates for different maturities.
Returns current Euribor interbank lending rates for maturities from 1 week to 12 months. Takes no parameters.
EV Charger
- Read
Find electric vehicle charging stations
Get electric vehicle charging stations near a location specified by latitude and longitude coordinates.
Exchange Rate
- Read
Get exchange rate for a given currency pair
Returns the current exchange rate for a currency pair such as USDEUR. To convert a specific amount instead use /convertcurrency.
- Read
Get daily historical exchange rates for a given currency pair
Returns daily historical exchange rates for a given currency pair. Data is available from 1999-01-01 onward. Provide either a single date or a startdate/enddate range (max 366 days). Premium subscription required.
Executive Compensation
- Read
Get executive compensation for a US public company
Returns named-executive-officer compensation for a company, sourced from SEC DEF 14A proxy statements, plus the structured Pay Versus Performance disclosure.
Exercises
- Read
Get exercises
Returns up to 5 exercises that satisfy the given parameters.
- Read
Get all exercises for a muscle group
Returns a comprehensive list of exercises that target a specific muscle group. Available on Business, Professional, or annual subscriptions only.
Facts
- Read
Get Random Facts
Returns one or more random facts. Free users have access to 100 facts - premium users have access to over 125,000 facts.
- Read
Get the fact of the day
Returns a single fact for the current day. The same fact is returned for all requests on the same day, and changes each day. No parameters are available for this endpoint, so everyone sees the same fact of the day.
GDP
- Read
Get GDP data
Get GDP data from given parameters. Returns GDP statistics that satisfy the parameters.
Geocoding
- Read
Get coordinates for a city, state, or US ZIP code
Converts a place name into latitude and longitude. Requires city; narrow with state, country or zipcode. For the reverse direction use /reversegeocoding.
- Read
Convert latitude/longitude coordinates to city locations.
Converts a lat and lon pair into the matching place name and administrative area. For the opposite direction use /geocoding.
Gold Price
- Read
Get current gold futures price
Returns the current gold futures price in USD. Free responses carry the last completed daily settlement; premium plans return the live price.
- Read
Get the current gold spot price
Premium only. Returns the gold spot price (XAU/USD) with bid and ask.
- Read
Get historical gold futures price data
Returns historical gold futures price data in OHLCV (Open, High, Low, Close, Volume) format. The data is returned in descending order (most recent first), and all prices are in USD. Premium subscribers only.
Helicopter
- Read
Get helicopter data
Returns technical specifications for helicopter models, filtered by manufacturer, model, or ranges of air speed, range, length, and height.
Miscellaneous
- Read
Search for historical events
Searches famous events in history by keyword text and/or year, month and day; negative years mean BC. Pagination with offset requires premium.
- Read
Search for historical figures
Searches notable people from history, ancient to modern, by name with partial matches supported, and returns their records. Requires name.
- Read
Get a random image
Returns a random royalty-free image, optionally constrained by category, width and height. Useful for placeholder or sample imagery.
- Read
Get fake random user profiles
Generates fake user profiles such as name, email, address and username for testing or placeholders, with count, gender, age, locale, field selection and seed options.
- Read
Converts between different units of measurement.
Converts a numeric value from one unit of measurement to another. Requires amount and the source unit, with spaces written as underscores.
Hobbies
- Read
Get a random hobby
Returns a random hobby suggestion, optionally restricted to a category such as general, sportsandoutdoors or education.
Holidays
- Read
Get holidays for a given country and year.
Returns holidays for a country and calendar year, optionally filtered by holiday type. Requires a country. For holidays falling on one date use /v1/isholiday.
- Read
Get all holidays that fall on a given date.
Returns all holidays that fall on a given date, optionally restricted to one country. Requires a date. For a full year's calendar use /v2/holidays.
Hospitals
- Read
Get hospital data based on given parameters
Returns US hospitals matching a name, city, state, ZIP code, county or latitude/longitude bounding box, with location, contact information and bed count.
IBAN
- Read
Look up and validate an IBAN
Validates an International Bank Account Number and returns the bank and account details encoded in it. Requires an iban.
Income Statement
- Read
Get income statement data for a specific company, period, and year
Returns income statement data from SEC 10-Q and 10-K filings for one company, fiscal period and year. Requires ticker or cik. For available periods use /incomestatementavailability.
- Read
List which fiscal periods have income statement data for a company (premium)
Returns the fiscal years and quarters for which income statement data is available for a company. Requires a premium subscription (Developer tier and above).
Income Tax Calculator
- Read
Calculates detailed tax information based on income, location, and filing status.
Calculates income tax for the United States or Canada from income, location, and filing status, including state or provincial tax. Requires country, region, income.
- Read
Calculates per-paycheck federal, state and FICA withholding from W-4 inputs.
Premium only. Returns per-paycheck federal withholding, FICA (Social Security, Medicare, Additional Medicare), and optional state withholding given gross pay and W-4 inputs. Supports both the 2020-or-later and pre-2020 W-4 forms. Requires grosspay, payperiod, filingstatus.
Income Tax
- Read
Retrieve income tax information
Returns comprehensive income tax information including tax brackets and rates at both federal and state/provincial levels (where applicable).
Inflation
- Read
Get current inflation data
Returns current monthly and annual inflation percentages. Premium subscribers only.
- Read
Get historical inflation rates
Returns historical inflation rates for a given country and (optionally) time range. The maximum number of data points returned per API call is 100. Premium subscribers only.
Insider Transactions
- Read
Get insider trading transactions
Returns a list of insider trading transactions that match the specified filters. Returns at most 100 results per request. For more results, use the offset parameter.
- Read
Get detailed transaction information for a given insider
Returns detailed transaction information for a given insider with optional filtering by company. Returns a maximum of 10 transactions, ordered by filing date (most recent first). Premium subscriptions only.
- Read
Get list of insiders for a company
Returns a list of all insiders for a given company (via ticker or CIK). For each insider, returns their name, position, and current share holdings based on their most recent filing. Either ticker or CIK is required. Premium subscriptions only.
Institutional Holdings
- Read
Get the full 13F portfolio of an institutional manager for a quarter
Returns an institutional manager's full 13F portfolio for a quarter. Requires cik or managername. For every holder of a single stock use /institutionalownership.
- Read
Get every institution holding a given stock for a quarter
Lists every institution holding a given stock in a quarter. Requires ticker or cusip. For one manager's entire portfolio use /institutionalholdings.
- Read
Search 13F institutions and their filing history (Premium only)
Searches the directory of 13F-filing institutions by name, CIK or quarter and returns their filing history rather than positions. Requires a premium subscription.
- Read
Get the biggest institutional buys and exits per quarter (Premium only)
Ranks the largest institutional new buys, exits, adds or trims for a quarter, market-wide or within one institution. Requires a premium subscription.
Interest Rate
- Read
Get current interest rates
Returns the latest published value of a central bank or benchmark rate. For the full history of that rate use /historicalinterestrates.
- Read
Get historical interest rates
Returns the published history of a benchmark rate over an optional date range, given as startdate/enddate (YYYY-MM-DD) or starttime/endtime (UNIX seconds). For the latest value only use /interestrate.
IP Lookup
- Read
Get location information for an IP address
Returns location information for an IP address. Requires an address in IPv4 form such as 73.9.149.180 or in IPv6 form.
IPO
- Read
Get past, current, and upcoming IPO records
Returns a list of IPO records matching the supplied filters. With no parameters, returns IPOs with listing dates between today and 30 days from now. All parameters are optional; combine them to narrow results by ticker, CIK, date range, status, deal type, exchange, or industry.
Jokes
- Read
Get a random joke
Returns random jokes about pop culture, science, history and other topics. Set limit to return between 1 and 100 jokes; the default is 1.
- Read
Get the joke of the day
Returns a single joke for the current day. The same joke is returned for all requests on the same day, and changes each day. No parameters are available for this endpoint, so everyone sees the same joke of the day.
Layoff Notices
- Read
Search WARN Act layoff notices
Searches official WARN Act layoff notices by company, ticker, location, date, number of workers and event type, newest first. All parameters are optional; without any, the latest notices from every state are returned.
- Read
Layoff notices and workers affected per month or year (premium only)
PREMIUM ONLY - Developer plans and above; requests below that return an error. Returns the number of layoff notices and workers affected per month or per year, nationally or for one state, counted by notice date.
- Read
Covered states with their agency, history and latest notice date
Lists every covered state with the agency that receives its notices, the date of its earliest notice, its latest notice date and its number of notices. Available on every plan.
LIBOR
- Read
Returns historical LIBOR rates for a specified tenor
Returns historical LIBOR rates for one tenor over an optional Unix timestamp range. Requires type: overnight, 1month, 3months, 6months or 12months.
Logo
- Read
Get company logos
Get a list of company names, ticker symbols, and logo image URLs matching the input parameters. Returns at most 10 results.
Lorem Ipsum
- Read
Generate Lorem Ipsum Text
Returns one or more paragraphs of lorem ipsum placeholder text.
Lottery
- Read
Get the latest or dated draw for a lottery game, state or country
Returns the latest draw for a game, the draw on a given date, or the latest draw of every game in a US state or a country. On paid plans results usually appear within minutes of the official publication; on the free plan they appear about 60 minutes later.
- Read
Get past draws for a lottery game
Returns past draws for a game, newest first. The free plan gets the latest 10 draws (each visible about 60 minutes after the draw); Developer plans a rolling two years; Business tier and above the full archive.
- Read
List lottery games with rules, schedules and odds
Lists the covered games with their number format, draw schedule, jackpot odds, prize tiers, rule-change history and archive range.
- Read
Check a lottery ticket against a draw
Premium only. Scores a ticket against a draw and returns the matched prize tier and prize. Supports Powerball (with Power Play and Double Play), Mega Millions (with the ticket's built-in multiplier) and Millionaire for Life. Ticket numbers are never stored.
- Read
List upcoming lottery jackpots
Premium only. Lists the next advertised jackpot for every active game that publishes one, largest first within each currency.
Metals Price
- Read
Get the current spot and futures price of a metal
Returns the current spot price of a metal with its futures price and contract.
Mortgage Calculator
- Read
Calculate mortgage payments
Calculates monthly and annual mortgage payments and interest from a loan amount or home value and downpayment, plus optional HOA, tax and insurance. Requires interestrate.
Mortgage Rate
- Read
Get Mortgage Rate Data
Returns 30-year and 15-year fixed-rate mortgage (FRM) data. If no parameters are set, the mortgage rate data for the most recent day is returned.
Motor Carrier
- Read
Look up a motor carrier by USDOT or MC number
Canonical carrier profile. Provide exactly one of dot or mc.
- Read
Search carriers by name or attributes
Find carriers by name, location or status, or reverse-look-up by phone or email (Business+).
- Read
Insurance filings for a carrier
Business+ only. Policy-level filings with coverage in US dollars, plus the 30-day BMC-35 cancellation window.
- Read
Crash, inspection and BASIC results
Crash counts, out-of-service rates against the national average, and public BASIC measures.
- Read
Carriers sharing an address, phone, email domain or officer
Business+ only. Entity graph over the full FMCSA census for chameleon-carrier and double-brokering review.
Motorcycles
- Read
Search motorcycles by make, model, and year
Returns technical specifications for motorcycle models matching a make, model and/or year, with partial matching on make and model and offset paging.
- Read
Get list of all motorcycle manufacturers
Returns the list of motorcycle manufacturers covered. For one manufacturer's model names use /motorcyclemodels; for a model's technical data use /motorcycles.
- Read
Get list of all models for a specific manufacturer
Returns the model names offered by one motorcycle manufacturer. Requires a make. For full technical specifications of a model use /motorcycles.
Mutual Fund
- Read
Get Mutual Fund Information
Returns details for a mutual fund including holdings, expense ratio, assets under management, and trailing total-return performance. Look it up by ticker (e.g. VFIAX) or by isin (e.g. US9229087104).
MX Lookup
- Read
Retrieve MX records for a domain
Returns the mail-exchange (MX) records for a domain, showing which servers accept its email. For other record types use /dnslookup.
NAICS Code
- Read
Look up a NAICS code
Returns the official title, description, full hierarchy, index terms and cross-references for a NAICS code. Pass crosswalkto to also map the code to another NAICS revision or to SIC. Available on all plans.
- Read
Search NAICS codes by keyword
Ranked candidate codes for a keyword or phrase, matched against over 20,000 official Census index terms plus titles and descriptions. Returns every plausible code without applying classification rules. Available on all plans; results capped at 5 on Free and Learner.
- Read
SBA small-business size standard for a NAICS code
Returns the SBA size standard from 13 CFR 121.201 for a code, and a small-business eligibility verdict when revenue or employees is supplied. Requires a Developer subscription or above; calculation basis, affiliation notes and exceptions require Business or above.
- Read
Classify a business description to a single NAICS code
Assigns one primary NAICS code to a business description by applying NAICS classification rules: the primary-activity test, cross-reference exclusions, and establishment scope. Returns the deciding rule and supporting evidence for audit. Requires a Business subscription or above.
- Read
Industry risk profile for a NAICS code
Returns a KYB and underwriting risk profile for an industry, including money-services, cash-intensive, cannabis, firearms, gambling and crypto flags, typical merchant category codes, and a review recommendation. Informational only, not a compliance determination.
Nutrition
- Read
Get nutrition information from text
Extracts nutrition data from free-form text, scaling values to any quantities mentioned. Requires query. For one food item with an explicit amount use /nutritionitem.
- Read
Get nutrition information for a single food item with a specific quantity
Returns nutrition data for a single food item at a stated amount. Requires query and quantity such as "1 cup". For free-form text with several foods use /nutrition.
- Read
Get nutrition information for branded/packaged foods by barcode, name, or brand
Look up nutrition, allergens, and ingredients for branded/packaged food products. A UPC/EAN barcode returns a single product; a name or brand search returns a ranked list. Provide at least one of upc, name, or brand. Premium only (any paid plan).
Oil Price
- Read
Get the current oil / energy benchmark price
Returns the current price for a crude oil or energy benchmark. Free tier returns the daily closing price for WTI (type=wti) and Brent (type=brent); premium tiers return the real-time price for all benchmarks and support optional currency and unit conversion.
- Read
Get the official daily spot price for an oil / energy benchmark
Premium only. Returns the daily spot price at the benchmark's physical delivery hub. Prices are published with a delay, so the date field says which trading day the price is for.
- Read
Get historical oil / energy benchmark prices
Returns historical OHLCV (Open, High, Low, Close, Volume) data for an oil/energy benchmark, most recent first. Reserved for premium subscribers.
Password Generator
- Read
Generate a random password
Generates one random password of the requested length, optionally excluding numbers or special characters. Defaults to 16 characters when no length is given.
Phone Lookup
- Read
Look up carrier, line type, and network metadata for a phone number
Returns carrier, line type, VOIP status and MCC/MNC for a phone number, with optional country. For format and validity checks only use /validatephone.
PIN Code
- Read
Look up an Indian PIN code
Returns the locations matching a six-digit Indian PIN code. Spaces and hyphens are normalized, so 110001, 110 001 and 110-001 all resolve. Searching by city, district or state instead of a pincode requires premium.
Planets
- Read
Get a list of planets
Get a list of planets matching specified parameters. Returns at most 30 results. To access more than 30 results, use the offset parameter to offset results in multiple API calls.
Population
- Read
Get population data
Get population data from given parameters. Returns a list of up to 5 country population statistics that satisfy the parameters. For more results use the offset parameter.
Postal Code
- Read
Get postal code information
Returns details for a Canadian postal code, given as A1A1A1 or A1A 1A1. Searching by city and province instead of a postal code requires premium.
Property Tax
- Read
Retrieve property tax rates
Returns one row per tax region with its 25th, 50th (median), and 75th percentile effective property tax rates. A ZIP code can return more than one row where several jurisdictions apply. At least one of city, county, or zip must be set; parameter values are not case-sensitive.
Public Holidays
- Read
Get public holidays for a given country and year
Returns public holidays for a country and calendar year. Requires a country. To test whether one date is a public holiday use /ispublicholiday.
- Read
Check if a given date is a public holiday for a given country
Checks whether a given date is a nationwide public holiday in a country, or in one of its regions when subdivision is given. Requires country and date. For a whole year of public holidays use /publicholidays.
QR Code
- Read
Generate QR Code
Generates a QR Code image for the specified data.
Quotes
- Read
Get quotes with pagination support (deterministic order)
Returns quotes in a deterministic, paginated order, filterable by category, author or work title. For a random selection instead use /randomquotes.
- Read
Get random quotes
Returns randomly chosen quotes, optionally filtered by category, author or work title. For stable paginated results use /quotes; for one fixed daily quote use /quoteoftheday.
- Read
Get today's quote (same quote all day)
Returns a single quote of the day that stays the same for the whole day. Takes no parameters. For varying quotes use /randomquotes or /quotes.
- Read
Get list of authors with multiple aphoristic quotes (premium only)
Lists authors who have multiple aphoristic quotes in the database, with limit and offset paging. Requires a premium subscription.
Random Word
- Read
Returns a random word.
Returns one or more random words, optionally restricted to a part of speech: noun, verb, adjective, or adverb.
Recipe
- Read
Get a list of recipes
Get a list of recipes for a given recipe name or ingredient(s). Returns a list of recipes with nutrition information. To access more results, use the limit parameter to limit the number of results and the offset parameter to offset results for pagination in multiple API calls.
Rhyme
- Read
Get rhyming words
Returns a list of rhyming words for any given word.
Riddles
- Read
Get Riddles
Returns one or more random riddles.
Routing Number
- Read
Get Bank Information by Routing Number
Returns the US bank identified by a routing number. Requires a 9-digit routingnumber. To find routing numbers by bank name or location instead use /routingnumbersearch.
- Read
Search for Banks and Routing Numbers
Finds US banks and their routing numbers by bank name, city, state, ZIP code or SWIFT/BIC code, with offset paging. To decode a known routing number use /routingnumber.
Sales Tax Calculator by API Ninjas
- Read
Calculates sales tax for a given amount and location.
Calculates US sales tax on a purchase amount for a location given by ZIP code or by city and state, returning the tax breakdown and total. Requires amount.
Sanctions Screening
- Read
Screen a name against major government sanctions lists
Returns ranked matches against the configured government sanctions lists. The set of lists and entity types available depends on subscription tier — Free covers OFAC SDN individuals only, Developer adds EU and entities, Business adds UK/UN/AU and vessels/aircraft.
SEC
- Read
Search SEC Filings
Returns a list of SEC filing information (including the submission URL) corresponding to the given search parameters.
Short Interest
- Read
Get short interest for a stock or ETF
Returns the latest bi-weekly short interest for a security plus history, enriched with short percent of outstanding and float, dollar notional short, and a two-year percentile.
- Read
Rank the whole market by short interest
Ranks every US security for a settlement date by short percent of float, short percent of outstanding, days to cover, two-week change, dollar notional short, or two-year percentile. This is how you find the most shorted stocks. Requires a Business plan or higher.
- Read
Get daily short sale volume
Reg SHO daily short sale volume — the portion of a day's OFF-EXCHANGE volume flagged as short sales. This is not short interest and not a percent of total market volume: FINRA covers only trades reported to its Trade Reporting Facilities, roughly 35-52% of consolidated volume.
- Read
Get SEC fails-to-deliver
Shares that did not settle on the contractual settlement date, published semi-monthly by the SEC.
- Read
Get the short interest settlement and publication calendar
Settlement dates, member reporting deadlines and publication dates. Short interest changes only 24 times a year, so this lets you schedule refreshes instead of polling. Available on every plan, including free.
Sort Code
- Read
Get UK Bank Branch Information by Sort Code
Looks up and validates a 6-digit UK sort code, returning its bank and branch details. Requires sortcode. To search by bank, city or postcode use /sortcodesearch.
- Read
Search for UK Bank Branches and Sort Codes
Finds UK bank branches and their sort codes by bank name, city or postcode. To look up a single sort code that is already known use /sortcode.
Spell Check
- Read
Checks spelling and provides corrections for any text.
Checks the spelling of text and returns corrections. Input is capped at 50 characters on the free tier and 500 characters for premium subscribers.
Sports
- Read
Get schedules, live scores and final scores
Returns games for one day, a team's season, a whole season or one game id. With only league, returns today's games (US Eastern).
- Read
Get league standings
Returns the league table for a season, ordered by league rank, or by conference or division rank when filtered.
- Read
List teams
Lists teams with conference, division and home venue.
- Read
Get rosters and player profiles
Returns current rosters and player profiles. Provide league with team or name, or a playerid.
Stars
- Read
Get a list of stars
Get a list of stars matching specified parameters. Returns at most 30 results. To access more than 30 results, use the offset parameter to offset results in multiple API calls.
Stock Exchange
- Read
Get stock exchange information
Returns stock exchange details matching a MIC, name, city, or country, including trading hours and number of listings. For every exchange use /allstockexchanges.
- Read
Get all stock exchanges (Business and Professional tier only)
Returns every supported stock exchange in one call. To look up one exchange by MIC, name, city, or country use /stockexchange. Business and Professional tiers only.
- Read
Check stock exchange hours and open/closed status (Business and Professional tier only)
Check if stock exchanges are open on a specific date or at a specific point in time. Returns trading hours (adjusted for early closures and holidays) and open/closed status.
- Read
Get stock exchange holiday calendars (Business and Professional tier only)
Returns holiday calendars for stock exchanges, including full closures and early close days. If no parameters are specified, returns holidays for all exchanges.
Stock News
- Read
Get latest stock news headlines
Returns up to 50 of the latest stock-market news headlines, sorted most recent first. Optionally filter by one or more ticker symbols. This endpoint is available to premium subscribers only.
Stock Price
- Read
Get current stock price
Returns the current price of a stock or market index. Requires a ticker such as AAPL or ^DJI. For past prices and OHLC bars use /stockpricehistorical.
- Read
Get historical stock prices
Returns historical price bars for a stock at intervals from 1 minute to 1 day over an optional Unix start/end range. Requires a ticker. For the latest price use /stockprice.
- Read
Get list of all available companies
Returns a list of all available companies and their ticker symbols. Supports pagination to retrieve results in batches. Premium only.
Stock Split
- Read
Get stock split records matching your filters
Returns historical and upcoming stock split records filtered by ticker, exchange, forward or reverse split type, and a single date or date range.
Sudoku
- Read
Generate a new Sudoku puzzle
Generates a new Sudoku puzzle at a chosen box width, height, difficulty and optional seed for reproducible output. To solve an existing puzzle use /sudokusolve.
- Write
Solve an existing Sudoku puzzle
Solves a Sudoku puzzle supplied in the request body. Requires the grid's box width and height. To create a new puzzle instead use /sudokugenerate.
SWIFT Code
- Read
Find SWIFT Codes
Returns a list of bank information (including SWIFT/BIC Code) that match the input parameter. Returns at most 100 results. For more results, use the offset parameter.
Text Similarity
- Write
Compute text similarity score
Returns a similarity score between 0 and 1 (1 is similar and 0 is dissimilar) of two given texts.
Ticker
- Read
Get detailed company profile information for any given ticker symbol
Returns the company profile for a ticker symbol, including executive details, financial metrics, identifiers, and contact information. Requires a ticker.
- Read
Search for ticker symbols by company name
Searches ticker symbols by company name, with optional negative keywords to exclude matches. Requires a name. For the full profile of a symbol use /ticker.
Timezone
- Read
Get timezone info by city/state/country or location coordinates.
Returns the IANA timezone and current local time for a location given as lat/lon, city, or an explicit timezone name.
Treasury Yield
- Read
Get the current (or a specific day's) Treasury yield curve.
Returns the US Treasury yield curve for one day, latest by default: par, real (TIPS) or bill rates with spreads. For a date range use /treasuryyieldhistorical. Deep history is premium.
- Read
Get a historical Treasury yield time series.
Returns a Treasury yield time series over a date range for the par, real or bill curve, for one maturity or, with premium, the whole curve. For a single day use /treasuryyield.
Trivia
- Read
Get Trivia Questions
Returns a random trivia question and answer.
- Read
Get Trivia of the Day
Returns a single trivia question and answer for the current day. The same question is returned for all requests on the same day, and changes each day. No filtering parameters are available for this endpoint to ensure everyone sees the same trivia of the day.
University
- Read
Get information about universities and colleges worldwide
Returns institutions matching the provided filters, closest name matches first, then by enrollment (largest first). At least one filter parameter (excluding offset/limit) is required. Free users can use name or country; all other filters are premium only.
URL Lookup
- Read
Lookup location information for a URL
Returns location information for a URL or domain name, including coordinates, city, country, and ISP details. Requires a url, with or without a scheme.
User Agent
- Read
Parse User Agent String
Parses a user agent string to extract device, OS, and browser information. All response fields are top-level.
- Read
Generate User Agent String
Generates a user agent string, optionally matching a device brand, model, os and browser. To parse an existing user agent string instead use /v2/useragentparse.
Validate Email
- Read
Validate an email address
Checks whether an email address is syntactically valid and has a deliverable mail domain. For disposable-address detection use /disposableemail.
Validate Phone
- Read
Validate a phone number and get its metadata
Validates a phone number and returns its normalised format, country and location. For carrier and line type use /phonelookup.
VAT
- Read
Get VAT rates for a specified EU country.
Returns current and historical VAT rates for a European Union country, filterable by rate type and date range. Requires a two-letter ISO country code.
VAT Validation
- Read
Validate an EU VAT number.
Validates an EU VAT number by format, checksum, and live EU registry status. Requires a vat with country prefix. Company name and address require a premium plan.
Transportation
- Read
Lookup vehicle information by VIN
Decodes a 17-character Vehicle Identification Number, or a Japanese domestic chassis number, and returns the vehicle's manufacturer, model, body class, country and region of manufacture, and model year.
Weather
- Read
Get current weather data
Get current weather, wind speed and direction, humidity, and temperature data by city, ZIP code, or geolocation coordinates (latitude/longitude). One of the following parameter combinations must be provided: lat and lon; or city, state (optional), and country (optional).
- Read
Get a 5-day weather forecast in 3-hour intervals
Returns a 5-day weather forecast in 3-hour intervals for a given city. One of the following parameter combinations must be provided: lat and lon; zip; or city, state (optional), and country (optional).
- Read
Get the complete weather icon catalog (Premium only)
Returns every light/dark SVG and 64/128/256-pixel PNG URL for the 74 icons, plus all 55 condition-code mappings. Requires an authenticated paid API Ninjas subscription; normal Weather API quotas apply. No anonymous demo access. No parameters required.
Web Scraper
- Read
Scrape data from a specified URL
Fetches a url and returns its contents, with textonly to strip markup. For the page title and metadata alone use /webpage.
Webpage
- Read
Retrieve web page metadata
Returns the URL information and web page metadata from a given URL.
Whois
- Read
Get domain registration details
Returns WHOIS registration details for a domain, including registrar, creation and expiry dates. For risk and email-provider signals use /domain.
Working Days
- Read
Get working and non-working days
Returns the working and non-working days for a country across a year or a single month, with configurable weekends. Requires country. For one date use /isworkingday.
- Read
Check if a specific date is a working day
Reports whether one specific date is a working day in a given country. Requires country and date. For a whole month or year use /workingdays.
World Time
- Read
Get the current date and time
Get the current date and time by city/state/country, location coordinates (latitude/longitude), or timezone.
Zip Code
- Read
Get ZIP Code details
Returns a list of ZIP Code details matching the input parameters.
No operations match.
See How connections work for access and permissions, or browse all integrations.