The API Ninjas connector lets your AI agent act in each user's API Ninjas account. Each user connects their own API Ninjas API key once, and Scalekit sends it with every call, so your agent never handles credentials. It comes with 38 tools.
- Tools
- 38
- What they doRead · write · destructive
- 37 · 1 · 037 read1 write0 destructive
- Users sign in with
- API key
Setup
Install the SDK
Terminal window npm install @scalekit-sdk/node dotenvTerminal window pip install scalekit-sdk-python python-dotenvSet your credentials
Add your Scalekit credentials to your
.envfile. Find values in app.scalekit.com > Developers > API Credentials..env SCALEKIT_ENVIRONMENT_URL=<your-environment-url>SCALEKIT_CLIENT_ID=<your-client-id>SCALEKIT_CLIENT_SECRET=<your-client-secret>Create the API Ninjas connection
In AgentKit > Connections, create an API Ninjas connection. The name you give it is the
connection_nameyour code passes. See Configure connections.Authorize a user and make your first call
quickstart.mts import { ScalekitClient } from '@scalekit-sdk/node'import 'dotenv/config'import { createInterface } from 'node:readline/promises'const scalekit = new ScalekitClient(process.env.SCALEKIT_ENVIRONMENT_URL,process.env.SCALEKIT_CLIENT_ID,process.env.SCALEKIT_CLIENT_SECRET,)const actions = scalekit.actionsconst connector = 'apininjas'const identifier = 'user_123'// Generate an authorization link for the userconst { link } = await actions.getAuthorizationLink({ connectionName: connector, identifier })console.log('Authorize API Ninjas:', link)const rl = createInterface({ input: process.stdin, output: process.stdout })await rl.question('Press Enter after authorizing...')rl.close()// Make your first callconst result = await actions.executeTool({connector,identifier,toolName: 'apininjas_get_inflation',toolInput: {},})console.log(result)Terminal window npx tsx quickstart.mtsquickstart.py import osfrom scalekit import ScalekitClientfrom dotenv import load_dotenvload_dotenv()scalekit_client = ScalekitClient(env_url=os.getenv("SCALEKIT_ENVIRONMENT_URL"),client_id=os.getenv("SCALEKIT_CLIENT_ID"),client_secret=os.getenv("SCALEKIT_CLIENT_SECRET"),)actions = scalekit_client.actionsconnection_name = "apininjas"identifier = "user_123"# Generate an authorization link for the userlink_response = actions.get_authorization_link(connection_name=connection_name,identifier=identifier,)print("Authorize API Ninjas:", link_response.link)input("Press Enter after authorizing...")# Make your first callresult = actions.execute_tool(tool_input={},tool_name="apininjas_get_inflation",connection_name=connection_name,identifier=identifier,)print(result)Terminal window python quickstart.pyEach user opens the link once and enters their API Ninjas credentials there. See Authorize a user for the full flow and statuses.
Tools
Pass the exact name toexecute_toolapininjas_analyze_sentimentScore the sentiment of a piece of text.Read-onlyAnalyze Sentiment
Score the sentiment of a piece of text. Returns text, score from -1 (most negative) to 1 (most positive) and sentiment: POSITIVE, WEAK_POSITIVE, NEUTRAL, WEAK_NEGATIVE or NEGATIVE. Use apininjas_analyze_sentiment for tone. Use apininjas_filter_profanity to find offensive words.
Inputs
textstringrequired- Text to analyse, up to 2000 characters. Example: The delivery was late but the support team was fantastic.
apininjas_check_domainCheck whether a domain is available to register, with basic registration and risk details.Read-onlyCheck Domain Availability
Check whether a domain is available to register, with basic registration and risk details. Returns domain, available, creation and expiration dates (Unix time), age in days and registrar. Update date, EPP status, MX presence, free-email, disposable and risky-TLD flags are Premium; IP, hosting provider and country need the Business tier. Domains outside .com need a paid (Premium) plan. Use apininjas_check_domain to test availability. Use apininjas_lookup_whois for the full registration record.
Inputs
domainstringrequired- Domain name to check, without a scheme. Example: github.com. Domains outside .com need a paid (Premium) plan.
apininjas_check_holidayList the holidays that fall on one date, in one country or worldwide.Read-onlyCheck Holiday On Date
List the holidays that fall on one date, in one country or worldwide. Returns an array of holidays with country, ISO code, year, date, day of week, name and type; an empty array means no holiday. Dates in future calendar years are Premium only. Use apininjas_check_holiday to test a single date. Use apininjas_list_holidays for a full year.
Inputs
datestringrequired- Date in YYYY-MM-DD format. Future calendar years are Premium only. Example: 2026-12-25.
countrystring- Country as a 2-letter ISO 3166 code (preferred), a 3-letter code or an English name. Omit for holidays in every country. Example: GB.
apininjas_convert_currencyConvert an amount of money from one currency to another at the current rate.Read-onlyConvert Currency
Convert an amount of money from one currency to another at the current rate. Returns old_amount, old_currency, new_amount, new_currency and a Unix timestamp. Free keys use once-daily rates; paid plans use real-time rates. Use apininjas_convert_currency to convert an amount. Use apininjas_get_exchange_rate for the rate alone.
Inputs
amountnumberrequired- Amount of the from-currency to convert. Example: 250.
havestringrequired- 3-letter ISO 4217 code of the currency you are converting from. Example: USD.
wantstringrequired- 3-letter ISO 4217 code of the currency you are converting to. Example: EUR.
apininjas_convert_unitsConvert an amount from one unit into every other unit of the same measurement type.Read-onlyConvert Units
Convert an amount from one unit into every other unit of the same measurement type. Returns type (for example length or temperature), the source unit and amount, and conversions, an object mapping each unit of that type to the converted value. Use apininjas_convert_units for physical units. Use apininjas_convert_currency for money.
Inputs
amountnumberrequired- Value to convert. Example: 5.
unitstringrequired- Source unit, lower case with spaces written as underscores. Examples: meter, kilometer, mile, foot, inch, liter, gallon, square_meter, acre, celsius, fahrenheit, kelvin, kilogram, pound, ounce.
apininjas_decode_vinDecode a 17-character Vehicle Identification Number, or a Japanese chassis number, into the vehicle's origin and model year.Read-onlyDecode VIN
Decode a 17-character Vehicle Identification Number, or a Japanese chassis number, into the vehicle's origin and model year. Returns vin, country and region of manufacture, model year and the WMI, VDS and VIS sections. Manufacturer, model and body class are Premium fields. Use apininjas_decode_vin for one specific vehicle. Use apininjas_search_cars to browse model specifications.
Inputs
vinstringrequired- 17-character VIN, or a Japanese chassis (frame) number such as ZVW30-1234567. Example: JHMCM56557C404453.
apininjas_define_wordLook up the dictionary definition of an English word.Read-onlyDefine Word
Look up the dictionary definition of an English word. Returns word, definition (one text block that can hold several numbered senses) and valid, which is false when the word is not in the dictionary. Use apininjas_define_word for meanings. Use apininjas_get_synonyms for similar and opposite words.
Inputs
wordstringrequired- English word to define. Example: serendipity.
apininjas_detect_languageDetect which language a piece of text is written in, across more than 50 languages.Read-onlyDetect Language
Detect which language a piece of text is written in, across more than 50 languages. Returns iso (2-letter ISO 639-1 code) and language (the language's full name). Use apininjas_detect_language to identify a language.
Inputs
textstringrequired- Text to analyse, up to 1000 characters. Ten words or more gives the best results. Example: Bonjour, comment allez-vous aujourd'hui ?
apininjas_filter_profanityCheck text for profanity and get a censored copy.Read-onlyFilter Profanity
Check text for profanity and get a censored copy. Returns original, censored (profane words replaced with asterisks) and has_profanity. Use apininjas_filter_profanity to screen or clean text. Use apininjas_analyze_sentiment to score tone.
Inputs
textstringrequired- Text to check, up to 1000 characters. Example: That was a damn good game.
apininjas_geocodeConvert a city name, optionally narrowed by state, country or US ZIP code, into latitude and longitude.Read-onlyGeocode Place
Convert a city name, optionally narrowed by state, country or US ZIP code, into latitude and longitude. Returns an array of matching places with name, latitude, longitude, country, state, IANA timezone, population and country details (currency, calling code, languages). Climate zone, urbanisation, nearest airport, county and area codes are Premium fields. Use apininjas_geocode to turn a place name into coordinates, for example before apininjas_get_weather on a free key. Use apininjas_reverse_geocode for the opposite direction.
Inputs
citystringrequired- Name of the city or place to look up. Example: London.
countrystring- Country to narrow the match, as a name, 2-letter ISO code or 3-letter ISO code. Example: GB.
statestring- US state, for United States cities only. Example: Texas.
zipcodestring- 5-digit US ZIP code, for United States cities only. Example: 73301.
apininjas_get_crypto_priceGet the current price of a cryptocurrency trading pair.Read-onlyGet Crypto Price
Get the current price of a cryptocurrency trading pair. Returns symbol, price and a Unix timestamp. Quoting a coin in a fiat currency (for example BTCEUR) is Premium only. Use apininjas_get_crypto_price for cryptocurrencies. Use apininjas_get_stock_price for stocks and indices.
Inputs
symbolstringrequired- Trading pair symbol, the coin followed by the quote asset with no separator. Example: BTCUSDT or ETHUSDT. Fiat quotes such as BTCEUR are Premium only.
apininjas_get_exchange_rateGet the current exchange rate between two currencies.Read-onlyGet Exchange Rate
Get the current exchange rate between two currencies. Returns currency_pair, exchange_rate and a Unix timestamp. Free keys get once-daily rates; paid plans get real-time rates. Use apininjas_get_exchange_rate for the rate itself. Use apininjas_convert_currency to convert a specific amount.
Inputs
pairstringrequired- Currency pair as two 3-letter ISO 4217 codes joined by an underscore, base first. Example: USD_EUR.
apininjas_get_inflationGet the latest monthly and annual inflation rates for one country or all covered countries.Read-onlyGet Inflation
Get the latest monthly and annual inflation rates for one country or all covered countries. Premium only: needs a paid API Ninjas plan. Returns an array with country, country code, indicator type (CPI or HICP), period, monthly rate and yearly rate in percent. Use apininjas_get_inflation for price inflation. Use apininjas_get_interest_rate for central bank and benchmark rates.
Inputs
countrystring- Country as a 2-letter ISO 3166 code or an English name, case-insensitive. Omit to return every covered country. Example: US.
typestring- Inflation indicator: CPI (Consumer Price Index) or HICP (Harmonised Index of Consumer Prices). Defaults to CPI.one of
CPIHICP
apininjas_get_interest_rateGet the latest value of a central bank, benchmark or prime lending rate.Read-onlyGet Interest Rate
Get the latest value of a central bank, benchmark or prime lending rate. Returns rate_name, rate_pct, last_updated, rate_type and, for prime and averaged rates, the source and bank count. Use apininjas_get_interest_rate for policy and benchmark rates. Use apininjas_get_inflation for inflation.
Inputs
ratestringrequired- Identifier of the rate. Central banks use central_bank_<country>, for example central_bank_us, central_bank_eu, central_bank_gb or central_bank_in. Benchmarks include sofr, effr, sonia, ester and euribor_3_months. Prime rates include prime_us and prime_ca.
apininjas_get_nutritionGet nutrition facts for foods described in plain text, scaled to any amounts mentioned.Read-onlyGet Nutrition Facts
Get nutrition facts for foods described in plain text, scaled to any amounts mentioned. Returns an array with one entry per food: name, serving size in grams, total and saturated fat, sodium, potassium, cholesterol, carbohydrates, fiber and sugar. Calories, protein, added sugars, net carbs, minerals, vitamins and an image URL are Premium fields. Use apininjas_get_nutrition for foods and meals. Use apininjas_search_recipes to find recipes.
Inputs
querystringrequired- Foods to analyse, separated by commas, new lines, semicolons or 'and', each with an optional amount. Example: 1lb brisket and fries.
apininjas_get_stock_priceGet the latest price of a stock or market index by ticker symbol.Read-onlyGet Stock Price
Get the latest price of a stock or market index by ticker symbol. Returns ticker, name, price, currency, exchange, volume, previous close, change and the Unix time the price was struck. Free keys get the last session's closing price; paid plans get live prices during market hours. Use apininjas_get_stock_price for equities and indices. Use apininjas_get_crypto_price for cryptocurrencies.
Inputs
tickerstringrequired- Stock or index ticker symbol. Example: AAPL, or ^DJI for the Dow Jones index.
apininjas_get_synonymsGet synonyms and antonyms of an English word.Read-onlyGet Synonyms And Antonyms
Get synonyms and antonyms of an English word. Returns word, synonyms (an array of similar words) and antonyms (an array of opposite words). Use apininjas_get_synonyms for alternative words. Use apininjas_define_word for a definition.
Inputs
wordstringrequired- English word to look up. Example: happy.
apininjas_get_timezoneGet the IANA timezone, UTC offset and current local time for a timezone name or, on a paid plan, a coordinate or city.Read-onlyGet Timezone
Get the IANA timezone, UTC offset and current local time for a timezone name or, on a paid plan, a coordinate or city. Returns timezone, utc_offset (seconds from UTC), local_time and city. Lookups by timezone name work on every plan; lat, lon, city, state and country are Premium only. Use apininjas_get_timezone to find which timezone a place is in. Use apininjas_get_world_time for a full breakdown of the current local date and time.
Inputs
citystring- Premium only (paid plan). City name. Example: Tokyo.
countrystring- Premium only (paid plan). Country name, used with city. Example: Japan.
latnumber- Premium only (paid plan). Latitude in decimal degrees. Use with lon. Example: 40.7128.
lonnumber- Premium only (paid plan). Longitude in decimal degrees. Use with lat. Example: -74.0060.
statestring- Premium only (paid plan). US state, for United States cities only. Example: New York.
timezonestring- IANA timezone name. Example: Europe/London. Provide timezone, lat and lon, or city.
apininjas_get_weatherGet the current weather for a location given as latitude/longitude or, on a paid plan, a city or US ZIP code.Read-onlyGet Current Weather
Get the current weather for a location given as latitude/longitude or, on a paid plan, a city or US ZIP code. Returns temperature, feels-like, min and max temperature (Celsius), humidity, cloud cover, wind speed (m/s) and direction, sunrise and sunset (Unix time), the weather category and description, and icon URLs. Free keys must use lat and lon; city, state, country and zip are Premium only. Use apininjas_get_weather for conditions right now. Use apininjas_get_weather_forecast for the next 5 days. Use apininjas_geocode first if you only have a place name on a free key.
Inputs
citystring- Premium only (paid plan). City name to use as the location instead of lat/lon. Narrow it with state and country. Example: London.
countrystring- Premium only (paid plan). Country name, used with city to pick the right place. Example: United Kingdom.
latnumber- Latitude of the location in decimal degrees, from -90 to 90. Use with lon; this is the location input that works on every plan. Example: 51.5074.
lonnumber- Longitude of the location in decimal degrees, from -180 to 180. Use with lat. Example: -0.1278.
statestring- Premium only (paid plan). US state, for United States cities only. Use with city. Example: California.
zipstring- Premium only (paid plan). 5-digit US ZIP code to use as the location instead of lat/lon. Example: 10001.
apininjas_get_weather_forecastGet a 5-day weather forecast in 3-hour steps for a location given as latitude/longitude or, on a paid plan, a city or US ZIP code.Read-onlyGet Weather Forecast
Get a 5-day weather forecast in 3-hour steps for a location given as latitude/longitude or, on a paid plan, a city or US ZIP code. Returns an array of forecast entries, each with a Unix timestamp and the same fields as the current weather: temperature, feels-like, humidity, cloud cover, wind, and the weather category and description. Free keys must use lat and lon; city, state, country and zip are Premium only. Use apininjas_get_weather_forecast for upcoming conditions. Use apininjas_get_weather for conditions right now.
Inputs
citystring- Premium only (paid plan). City name to use as the location instead of lat/lon. Narrow it with state and country. Example: London.
countrystring- Premium only (paid plan). Country name, used with city to pick the right place. Example: United Kingdom.
latnumber- Latitude of the location in decimal degrees, from -90 to 90. Use with lon; this is the location input that works on every plan. Example: 51.5074.
lonnumber- Longitude of the location in decimal degrees, from -180 to 180. Use with lat. Example: -0.1278.
statestring- Premium only (paid plan). US state, for United States cities only. Use with city. Example: California.
zipstring- Premium only (paid plan). 5-digit US ZIP code to use as the location instead of lat/lon. Example: 10001.
apininjas_get_world_timeGet the current local date and time for a timezone name, a coordinate or a city.Read-onlyGet World Time
Get the current local date and time for a timezone name, a coordinate or a city. Returns timezone, datetime, date, year, month, day, hour, minute, second, day of week, day of year, ISO week number, UTC offset and datetime, Unix time, timezone abbreviation and whether daylight saving time is in effect. Use apininjas_get_world_time for the current local time somewhere. Use apininjas_get_timezone when you only need the timezone name and offset.
Inputs
citystring- City name, optionally narrowed by state and country. Example: Tokyo.
countrystring- Country name, used with city. Example: Japan.
latnumber- Latitude in decimal degrees. Use with lon. Example: 35.6762.
lonnumber- Longitude in decimal degrees. Use with lat. Example: 139.6503.
statestring- US state, for United States cities only. Example: Illinois.
timezonestring- IANA timezone name. Example: Europe/London. Provide timezone, lat and lon, or city.
apininjas_list_holidaysList a country's holidays for a calendar year, optionally only one type such as public holidays.Read-onlyList Holidays
List a country's holidays for a calendar year, optionally only one type such as public holidays. Returns an array of holidays with country, ISO code, year, date (YYYY-MM-DD), day of week, name and type. Free keys get the current year only; other years (2005 to 2039) are Premium. Use apininjas_list_holidays for a year's calendar. Use apininjas_check_holiday to test one date.
Inputs
countrystringrequired- Country as a 2-letter ISO 3166 code (preferred), a 3-letter code or an English name, case-insensitive. Example: US.
typestring- Return only one holiday type, for example PUBLIC_HOLIDAY or BANK_HOLIDAY. Omit for every type.one of
PUBLIC_HOLIDAYSTATE_HOLIDAYLOCAL_HOLIDAYPROVINCE_TERRITORY_HOLIDAYDE_FACTO_HOLIDAYSUBSTITUTE_HOLIDAYBANK_HOLIDAYGOVERNMENT_HOLIDAYPRIVATE_SECTOR_HOLIDAYOPTIONAL_HOLIDAYRESTRICTED_TRADING_DAYCHRISTIAN_HOLIDAYORTHODOX_HOLIDAYMUSLIM_HOLIDAYJEWISH_HOLIDAYHINDU_HOLIDAYOBSERVANCEUNITED_NATIONS_OBSERVANCEFLAG_DAYSILENT_DAYHALF_DAYWORKING_DAYSEASONCLOCK_CHANGECOVID_19_MEASURESPORTING_EVENT yearinteger- Calendar year, 2005 to 2039. Defaults to the current year. Years other than the current one are Premium only. Example: 2026.
apininjas_lookup_dnsGet the DNS records of a domain.Read-onlyLook Up DNS Records
Get the DNS records of a domain. Returns an array of records, each with record_type and value, plus priority for MX and the SOA timers for SOA. On a free key only NS, PTR, SRV, SOA and CAA records are returned; A, AAAA, CNAME, MX and TXT are Premium. Domains outside .com need a paid (Premium) plan. Use apininjas_lookup_dns for DNS records. Use apininjas_lookup_whois for registration details and apininjas_check_domain for availability.
Inputs
domainstringrequired- Domain name to look up, without a scheme. Example: example.com. Domains outside .com need a paid (Premium) plan.
apininjas_lookup_ipLook up the location and network of an IPv4 or IPv6 address.Read-onlyLook Up IP Address
Look up the location and network of an IPv4 or IPv6 address. Returns is_valid, country, country code, region, region code, latitude, longitude, timezone and the address. City, ZIP, ISP, ASN, abuse contact and the datacenter, hosting, VPN, Tor and threat flags are Premium fields. Use apininjas_lookup_ip for an IP address. Use apininjas_lookup_url to locate the server behind a URL or domain.
Inputs
addressstringrequired- IP address to look up, in IPv4 form such as 73.9.149.180 or IPv6 form such as 2001:0db8:85a3:0000:0000:8a2e:0370:7334.
apininjas_lookup_urlFind where the server behind a URL or domain is located.Read-onlyLook Up URL Location
Find where the server behind a URL or domain is located. Returns is_valid, country, country code, region, region code, city, ZIP, latitude, longitude, timezone, ISP and the URL. Domains outside .com need a paid (Premium) plan. Use apininjas_lookup_url when you have a URL or domain. Use apininjas_lookup_ip when you already have the IP address.
Inputs
urlstringrequired- URL or domain to look up, with or without a scheme. Example: https://example.com. Domains outside .com need a paid (Premium) plan.
apininjas_lookup_whoisGet the WHOIS registration record of a domain.Read-onlyLook Up WHOIS
Get the WHOIS registration record of a domain. Returns domain name, registrar and registrar URL, WHOIS server, creation, update and expiry dates (Unix time), name servers, DNSSEC, contact emails and EU/EEA flags. Registrant name, organisation, country, state and privacy-service fields are Premium. Domains outside .com need a paid (Premium) plan. Use apininjas_lookup_whois for who registered a domain and when. Use apininjas_check_domain to see if a domain is free to register.
Inputs
domainstringrequired- Domain name to look up, without a scheme. Example: example.com. Domains outside .com need a paid (Premium) plan.
apininjas_reverse_geocodeConvert a latitude/longitude pair into the place it falls in.Read-onlyReverse Geocode Coordinates
Convert a latitude/longitude pair into the place it falls in. Returns an array of matching places with name, ISO country code and state. County, ZIP code, telephone area codes and timezone are Premium fields; free keys get a notice string in their place. Use apininjas_reverse_geocode to name a coordinate. Use apininjas_geocode to get coordinates from a place name.
Inputs
latnumberrequired- Latitude in decimal degrees, from -90 to 90. Example: 47.6062.
lonnumberrequired- Longitude in decimal degrees, from -180 to 180. Example: -122.3321.
apininjas_scrape_webpageFetch a web page and return its contents as HTML or as visible text only.Read-onlyScrape Web Page
Fetch a web page and return its contents as HTML or as visible text only. Returns data, holding the page's HTML, or its visible text when text_only is true. Use apininjas_scrape_webpage to read a page's content. Use apininjas_lookup_url to locate the server behind it.
Inputs
urlstringrequired- Full URL of the page to fetch. Example: https://example.com.
text_onlyboolean- Set to true to return only the visible text, without HTML tags and metadata. Default false returns the raw HTML.
user_agentstring- User-Agent header to send when fetching the page. Omit to use the default. Example: Mozilla/5.0 (Windows NT 10.0; Win64; x64).
apininjas_search_aircraftFind aircraft specifications by manufacturer, model or type code, or filter them by engine, speed, range and size.Read-onlySearch Aircraft
Find aircraft specifications by manufacturer, model or type code, or filter them by engine, speed, range and size. Returns an array of aircraft with manufacturer, model, ICAO and IATA type codes, engine type and count, speeds, ceiling, range, weights, dimensions and wake categories. Set at least one filter other than limit; the image URL needs the Business tier. Use apininjas_search_aircraft for aircraft types. Use apininjas_search_airlines for carriers and their fleets.
Inputs
engine_typestring- Engine type: piston, propjet or jet.one of
pistonpropjetjet iatastring- IATA aircraft type code. Family codes such as 32S or 737 return every type in the family. Example: 32N.
icaostring- ICAO aircraft type designator, exact match. Example: A20N.
limitinteger- Number of aircraft to return, from 1 to 30. Default 1.
manufacturerstring- Aircraft manufacturer. Example: Gulfstream.
max_heightinteger- Maximum height in feet. Example: 60.
max_lengthinteger- Maximum length in feet. Example: 250.
max_rangeinteger- Maximum range in nautical miles. Example: 8000.
max_speedinteger- Maximum top air speed in knots. Example: 600.
max_wingspaninteger- Maximum wingspan in feet. Example: 200.
min_heightinteger- Minimum height in feet. Example: 10.
min_lengthinteger- Minimum length in feet. Example: 50.
min_rangeinteger- Minimum range in nautical miles. Example: 3000.
min_speedinteger- Minimum top air speed in knots. Example: 400.
min_wingspaninteger- Minimum wingspan in feet. Example: 50.
modelstring- Aircraft model name. Example: G550.
apininjas_search_airlinesFind airlines by ICAO code, IATA code or name.Read-onlySearch Airlines
Find airlines by ICAO code, IATA code or name. Returns an array of airlines with name, country, year founded, base airport, IATA and ICAO codes, fleet counts by aircraft type, and logo URLs. Set at least one of icao, iata or name. Use apininjas_search_airlines for carriers. Use apininjas_search_aircraft for aircraft types and specs.
Inputs
iatastring- 2-character IATA airline code. Example: UA. Set icao, iata or name.
icaostring- 3-letter ICAO airline code. Example: UAL. Set icao, iata or name.
namestring- Airline name, partial match: United matches United Airlines. Set icao, iata or name.
apininjas_search_airportsFind airports by IATA or ICAO code, name, city, region, country or timezone, or filter them by size, elevation and runway length.Read-onlySearch Airports
Find airports by IATA or ICAO code, name, city, region, country or timezone, or filter them by size, elevation and runway length. Returns up to 10 airports by default, each with ICAO and IATA codes, name, city, region, country, latitude, longitude, elevation, timezone, size and type, scheduled service, runways and estimated annual passengers. Set at least one filter other than offset; name, city and region are Premium only. Use apininjas_search_airports for airports. Use apininjas_search_airlines for carriers.
Inputs
citystring- Premium only (paid plan). Airport city, partial case-insensitive match. Example: London.
countrystring- 2-letter ISO 3166 country code. Example: GB.
has_iatastring- true returns only airports with an IATA code; false returns only those without.one of
truefalse iatastring- IATA airport code, usually 3 letters. Partial, case-insensitive match. Example: LHR.
icaostring- ICAO airport code, 4 characters. Partial, case-insensitive match. Example: EGLL.
limitinteger- Maximum number of airports to return, from 1 to 100. Default 10.
max_elevationinteger- Maximum elevation in feet. Example: 5000.
min_elevationinteger- Minimum elevation in feet. Example: 0.
min_runway_lengthinteger- Minimum length in feet of at least one runway. Example: 10000.
namestring- Premium only (paid plan). Airport name, partial match. Example: Heathrow.
offsetinteger- Number of results to skip, for paging. Example: 10.
orderstring- Sort direction: desc (default) or asc.one of
ascdesc regionstring- Premium only (paid plan). State, province or region, partial case-insensitive match. Example: California.
sizestring- Airport size: large, medium or small.one of
largemediumsmall sortstring- Sort order: passengers (default), name, elevation or runway_length.one of
passengersnameelevationrunway_length timezonestring- IANA timezone of the airport. Example: Europe/London.
apininjas_search_carsFind car models and their full specifications by make, model, generation, body, fuel, drivetrain, power or production year, or fetch known cars by id.Read-onlySearch Cars
Find car models and their full specifications by make, model, generation, body, fuel, drivetrain, power or production year, or fetch known cars by id. Premium only: needs a paid API Ninjas plan. Returns up to 10 cars by default, each with an id, make, model, generation, chassis codes, production years, body and doors, trim, engine summary, power, displacement, cylinders, transmission, gears, drive, fuel and a full specs sheet. Set at least one filter, or id or ids. Use apininjas_search_cars for model specs. Use apininjas_decode_vin to identify one specific vehicle from its VIN.
Inputs
badgestring- Model designation; spacing and case are ignored. Example: 320d.
bodystring- Body style.one of
SedanCoupeConvertibleWagonHatchbackLiftbackSUVMPVVanPickup chassis_codestring- Chassis code; matches any generation whose chassis codes include it. Example: E91.
cylindersinteger- Number of cylinders. Example: 6.
doorsinteger- Number of doors. Example: 4.
drivestring- Driven wheels: fwd, rwd, awd or 4wd.one of
fwdrwdawd4wd engine_codestring- Manufacturer engine code. Example: N47D20.
fuelstring- Fuel type.one of
gasolinedieselelectrichybridplugin_hybridlpgcnghydrogenethanol generationstring- Generation name or code. Example: E90.
idstring- Car handle from an earlier search, to fetch that car again. Example: car_e71ff3416a.
idsstring- Comma-separated car handles, at most 50. Order is kept; an unknown handle comes back as null. Example: car_e71ff3416a,car_0b3c9d1e22.
limitinteger- Number of cars to return, from 1 to 100. Default 10. Out-of-range values are rejected.
makestring- Manufacturer; case and punctuation are ignored. Example: BMW.
max_power_hpinteger- Maximum engine power in horsepower. Example: 300.
max_yearinteger- Cars in production in or before this year. Example: 2020.
min_power_hpinteger- Minimum engine power in horsepower. Example: 150.
min_yearinteger- Cars still in production in or after this year. Example: 2015.
modelstring- Model; '3 Series', '3-series' and '3series' all match. Example: 3 Series.
offsetinteger- Number of results to skip, for paging. Default 0.
sortstring- Sort order. A leading minus sorts descending: -power_hp puts the most powerful first.one of
power_hp-power_hpyear-yearnamemake transmissionstring- Transmission type.one of
manualautomaticcvtdual_clutchautomated_manualsingle_speed yearinteger- Cars in production in this year. Example: 2018.
apininjas_search_citiesFind cities by name, country, coordinate box or population range.Read-onlySearch Cities
Find cities by name, country, coordinate box or population range. Returns an array of cities with name, latitude, longitude, ISO country code, population and whether it is a capital. Free keys search about 50,000 cities and get one result per call; paid plans search over 5 million places and can set limit and offset. Use apininjas_search_cities to look up or list cities. Use apininjas_geocode to get coordinates for one place.
Inputs
countrystring- 2-letter ISO 3166 country code. Example: US.
limitinteger- Premium only (paid plan). Number of cities to return, from 1 to 30. Default 1.
max_latnumber- Maximum latitude of the search box, in decimal degrees. Example: 45.
max_lonnumber- Maximum longitude of the search box, in decimal degrees. Example: -70.
max_populationinteger- Maximum city population. Example: 5000000.
min_latnumber- Minimum latitude of the search box, in decimal degrees. Example: 40.
min_lonnumber- Minimum longitude of the search box, in decimal degrees. Example: -80.
min_populationinteger- Minimum city population. Example: 1000000.
namestring- City name. Example: San Francisco.
offsetinteger- Premium only (paid plan). Number of results to skip, for paging past the first 30. Example: 30.
apininjas_search_countriesFind countries by name or currency, or filter them by GDP, population, area, unemployment or GDP growth.Read-onlySearch Countries
Find countries by name or currency, or filter them by GDP, population, area, unemployment or GDP growth. Returns an array of countries with name, ISO2 code, capital, region, currency, population, GDP and GDP per capita, surface area, unemployment, life expectancy, internet users, telephone codes, flag URLs and many other statistics. Use apininjas_search_countries for country facts. Use apininjas_search_cities for cities.
Inputs
currencystring- 3-letter currency code to find countries using it. Example: EUR.
limitinteger- Number of countries to return, from 1 to 30. Default 5.
max_areanumber- Maximum surface area in square kilometres. Example: 1000000.
max_gdpnumber- Maximum gross domestic product (GDP). The API documents this filter in US dollars, while the gdp field in results is reported in millions of US dollars, so confirm the scale with a known country first. Example: 5000000.
max_gdp_growthnumber- Maximum GDP growth rate in percent. Example: 6.
max_populationnumber- Maximum population, in thousands. Example: 200000 for 200 million.
max_unemploymentnumber- Maximum unemployment rate in percent. Example: 10.
min_areanumber- Minimum surface area in square kilometres. Example: 100000.
min_gdpnumber- Minimum gross domestic product (GDP). The API documents this filter in US dollars, while the gdp field in results is reported in millions of US dollars, so confirm the scale with a known country first. Example: 1000000.
min_gdp_growthnumber- Minimum GDP growth rate in percent. Example: 2.
min_populationnumber- Minimum population, in thousands. Example: 50000 for 50 million.
min_unemploymentnumber- Minimum unemployment rate in percent. Example: 5.
namestring- Country name, 2-letter ISO 3166 code or 3-letter ISO 3166 code. Example: Japan.
apininjas_search_recipesSearch recipes by title or, on a paid plan, by ingredients.Read-onlySearch Recipes
Search recipes by title or, on a paid plan, by ingredients. Returns an array of recipes with title, ingredients (with quantities), servings, step-by-step instructions and nutrition. Returns 1 recipe unless limit is set (up to 5 on free keys, 10 on paid plans); ingredient search and offset are Premium only. Use apininjas_search_recipes to find recipes. Use apininjas_get_nutrition for the nutrition of foods you already have.
Inputs
ingredientsstring- Premium only (paid plan). Comma-separated ingredients to search by, up to 5. Results rank by how many of them each recipe uses. Example: chicken,rice,garlic.
limitinteger- Number of recipes to return: 1 to 5 on free keys, 1 to 10 on paid plans. Default 1.
offsetinteger- Premium only (paid plan). Number of results to skip, for paging. Example: 10.
titlestring- Recipe title or keywords to search for. Example: mushroom risotto.
apininjas_validate_emailCheck whether an email address is well formed and its domain can receive mail.Read-onlyValidate Email
Check whether an email address is well formed and its domain can receive mail. Returns is_valid, email, domain, local part, whether the address is disposable or from a public provider such as Gmail, and a role category and sub-category inferred from the local part (for example support or sales). Use apininjas_validate_email to vet an address. Use apininjas_check_domain for details about the domain itself.
Inputs
emailstringrequired- Email address to validate. Example: jane.doe@example.com.
apininjas_validate_phoneCheck whether a phone number is valid and get its formats and location.Read-onlyValidate Phone Number
Check whether a phone number is valid and get its formats and location. Returns is_valid, is_possible, whether it was already formatted properly, country, location, timezones, national, international, E.164 and RFC 3966 formats, country calling code, line type and whether it is mobile. Use apininjas_validate_phone to verify or normalise a phone number.
Inputs
numberstringrequired- Phone number to check. Include the country calling code unless country is set; the leading + is optional. Example: +12065550100.
countrystring- 2-letter ISO 3166 country code the number belongs to, used when the number has no country calling code. Example: US.
apininjas_compare_text_similarityScore how similar in meaning two pieces of text are.WriteCompare Text Similarity
Score how similar in meaning two pieces of text are. Returns similarity, a score from 0 (unrelated) to 1 (the same meaning). Use apininjas_compare_text_similarity to compare two texts, for example to find duplicates. It reads data only; nothing is stored.
Inputs
text_1stringrequired- First text, up to 5000 characters. Example: This is an example sentence.
text_2stringrequired- Second text, up to 5000 characters. Example: This is just another example sentence.
No tools match.
