# API Ninjas

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

- **Category:** developer tools
- **Auth:** API_KEY
- **Composio Managed App Available?** N/A
- **Tools:** 129
- **Triggers:** 0
- **Slug:** `API_NINJAS`
- **Version:** 20260227_00

## Tools

### Analyze Text Sentiment

**Slug:** `API_NINJAS_ANALYZE_SENTIMENT`

Tool to analyze the sentiment of text. Returns a numerical sentiment score from -1 to 1 and a classification (POSITIVE, WEAK_POSITIVE, NEUTRAL, WEAK_NEGATIVE, or NEGATIVE). Use when you need to determine the emotional tone or sentiment of text content.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `text` | string | Yes | Text to analyze for sentiment. Maximum 2000 characters. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Generate Barcode Image

**Slug:** `API_NINJAS_BARCODE_GENERATE`

Tool to generate a barcode image for specified text. Use when you need a barcode image (PNG or SVG) of custom data.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `text` | string | Yes | Text to encode in the barcode |
| `type` | string ("code39" | "code128" | "ean" | "ean13" | "ean8" | "gs1" | "gtin" | "isbn" | "isbn10" | "isbn13" | "issn" | "jan" | "pzn" | "upc" | "upca") | No | Type of barcode to generate |
| `format` | string ("png" | "svg") | No | Image format to return |
| `include_text` | boolean | No | Whether to include the text below the barcode |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### BIN Lookup

**Slug:** `API_NINJAS_BIN_LOOKUP`

Tool to look up bank information from a Bank Identification Number. Use after you have a BIN to fetch issuer details (brand, type, country).

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `bin` | string | Yes | Bank Identification Number (first 6-8 digits of a credit/debit card). Must be numeric. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Bitcoin Price and Market Data

**Slug:** `API_NINJAS_BITCOIN`

Tool to retrieve the latest Bitcoin price and 24-hour market data. Use when you need real-time Bitcoin metrics in USD.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Calculate Calories Burned

**Slug:** `API_NINJAS_CALCULATE_CALORIES_BURNED`

Tool to calculate calories burned for an activity based on duration and body weight. Use when you need to estimate energy expenditure for physical activities.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `weight` | number | No | Body weight in kg or lbs. If not provided, API uses default. |
| `activity` | string | Yes | Name of the activity (e.g., 'running', 'swimming', 'cycling'). |
| `duration` | integer | No | Duration in minutes. If not provided, API uses default (typically 60 minutes). |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Calculate Mortgage

**Slug:** `API_NINJAS_CALCULATE_MORTGAGE`

Tool to calculate mortgage payments and breakdowns. Use when you need to determine monthly/annual payments, including mortgage, property tax, HOA, and insurance components.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `home_value` | number | No | Total value of the home or asset. Must be greater than downpayment. |
| `downpayment` | number | No | Downpayment on the home or asset. Cannot exceed home_value. |
| `loan_amount` | number | No | Principal loan amount. Either this OR (home_value + downpayment) must be provided. |
| `monthly_hoa` | number | No | Monthly homeowner association fees |
| `interest_rate` | number | Yes | Annual interest rate (in %). For example, a 3.5% interest rate would be 3.5 |
| `duration_years` | integer | No | Loan duration in years (1-10000). Defaults to 30. |
| `annual_property_tax` | number | No | Annual property tax owed |
| `annual_home_insurance` | number | No | Annual homeowner's insurance bill |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Calculate Sales Tax

**Slug:** `API_NINJAS_CALCULATE_SALES_TAX`

Tool to calculate sales tax for a purchase amount at a US location. Use when you need to determine the sales tax for a purchase based on ZIP code or city/state. Premium features include detailed breakdowns by city, county, and special districts.

#### Input Parameters

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

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Check Domain Availability

**Slug:** `API_NINJAS_CHECK_DOMAIN`

Tool to check domain availability and retrieve registration information. Use when you need to verify if a domain is available for registration or get details about an existing domain.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `domain` | string | Yes | Valid domain to check (e.g., example.com). For top-level domains other than .com, a premium subscription is required. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Check If Date Is Public Holiday

**Slug:** `API_NINJAS_CHECK_IS_PUBLIC_HOLIDAY`

Tool to check if a specific date is a public holiday in a given country. Use when you need to verify holiday status for scheduling, planning, or calendar-related tasks. Returns holiday name if applicable.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `date` | string | Yes | Date to check in YYYY-MM-DD format (e.g., '2026-01-01'). Must be between 1980-01-01 and 2050-12-31. |
| `country` | string | Yes | 2-letter ISO 3166-1 alpha-2 country code (e.g., 'US' for United States, 'GB' for United Kingdom, 'JP' for Japan). This determines which country's public holidays are checked. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Check If Date Is Working Day

**Slug:** `API_NINJAS_CHECK_IS_WORKING_DAY`

Tool to check if a date is a working day in a specific country. Returns whether the date is a working day, accounting for weekends and public holidays. Use when you need to determine if a business is likely to be open on a specific date.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `date` | string | Yes | Date in YYYY-MM-DD format. Must be between 1980-01-01 and 2050-12-31 (inclusive). |
| `country` | string | Yes | Country code (2-letter ISO 3166-1 alpha-2 code, e.g., 'US' for United States, 'GB' for United Kingdom). |
| `weekend_days` | string | No | Comma-separated list of weekend days (mon,tue,wed,thu,fri,sat,sun). Optional: if not provided, default weekend days are determined by country. |
| `include_holidays` | boolean | No | Whether to include public holidays as non-working days. Defaults to true if not specified. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Check Spelling

**Slug:** `API_NINJAS_CHECK_SPELLING`

Tool to check spelling and get corrections for text. Returns the original text, corrected version, and detailed corrections with alternative suggestions.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `text` | string | Yes | The text to be spell-checked. Can be a single word or multiple words. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Commodity Price

**Slug:** `API_NINJAS_COMMODITY_PRICE`

Get real-time commodity prices from major exchanges (CME, NYMEX, COMEX). Prices are based on rolling futures contracts in USD. Free tier has limited commodities that rotate weekly. Use snake_case for commodity names (e.g., 'micro_gold', 'natural_gas'). Example: "What is the current price of natural gas?"

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | Yes | Name of the commodity to fetch price for. Use snake_case format. Free tier commodities rotate weekly. Common free tier options include: micro_gold, micro_silver, natural_gas, heating_oil, lumber, lean_hogs, live_cattle. Premium commodities (require paid plan): gold, silver, crude_oil, corn, wheat, platinum, copper, coffee, sugar, cotton, soybeans, etc. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Compute Text Similarity

**Slug:** `API_NINJAS_COMPUTE_TEXT_SIMILARITY`

Tool to compute semantic similarity between two texts. Returns a similarity score from 0 to 1 using NLP embeddings and cosine similarity. Use when comparing text content, detecting duplicates, or measuring semantic relatedness.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `text_1` | string | Yes | First text to compare for similarity. |
| `text_2` | string | Yes | Second text to compare for similarity. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Convert Currency

**Slug:** `API_NINJAS_CONVERT_CURRENCY`

Convert between currencies using current exchange rates. Returns the converted amount with both source and target currency details. Use this when you need to know how much a specific amount in one currency is worth in another currency.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `have` | string | Yes | Source currency code (e.g., USD, EUR, GBP, JPY). The currency you currently have. |
| `want` | string | Yes | Target currency code (e.g., USD, EUR, GBP, AUD). The currency you want to convert to. |
| `amount` | number | Yes | Amount to convert in the source currency. Must be a positive number. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Convert Unit

**Slug:** `API_NINJAS_CONVERT_UNIT`

Convert between measurement units across different categories. Returns converted values for all units in the same category. Use this when you need to convert measurements (length, weight, temperature, volume, area, time, speed, etc.) from one unit to another.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `unit` | string | Yes | The source unit to convert from (e.g., 'meter', 'kilogram', 'celsius', 'gallon'). If the unit name has spaces, replace them with underscores (e.g., 'square_meter'). |
| `amount` | number | Yes | The numerical value to convert. Must be a positive or negative number. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Crypto Price

**Slug:** `API_NINJAS_CRYPTO_PRICE`

Get the current real-time price for a cryptocurrency trading pair. Returns the latest price and timestamp for symbols like BTCUSDT (Bitcoin to USD), ETHUSDT (Ethereum to USD), or crypto-to-crypto pairs like LTCBTC (Litecoin to Bitcoin). Use this to check current cryptocurrency market prices.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `symbol` | string | Yes | Cryptocurrency trading pair symbol. Common formats include crypto-to-USD pairs like 'BTCUSDT', 'ETHUSDT', 'XRPUSDT', 'DOGEUSDT', or crypto-to-crypto pairs like 'LTCBTC', 'ETHBTC'. Case-insensitive. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Detect Text Language

**Slug:** `API_NINJAS_DETECT_TEXT_LANGUAGE`

Tool to detect the language of input text. Returns the ISO language code and full language name. For best accuracy, use text with 10 or more words.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `text` | string | Yes | Input text to detect language from. Maximum 1000 characters. For best results, use 10 words or more. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Check Disposable Email

**Slug:** `API_NINJAS_DISPOSABLE_EMAIL_CHECKER`

Tool to check whether an email address is from a disposable email provider. Use when validating user emails prior to sending communications.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `email` | string | Yes | The email address to check for disposability. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### DNS Lookup

**Slug:** `API_NINJAS_DNS_LOOKUP`

Tool to retrieve DNS records for a specified domain. Use when you need DNS record details for troubleshooting or validation.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `domain` | string | Yes | The domain to look up DNS records for (e.g., example.com). Top-level domains other than .com require a premium subscription. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Earnings Calendar

**Slug:** `API_NINJAS_EARNINGS_CALENDAR`

Fetches historical earnings data (EPS and revenue - actual vs. estimated) for a publicly traded company by stock ticker. Returns past quarterly earnings dates with actual and estimated EPS/revenue figures. Useful for tracking earnings beats/misses and analyzing company financial performance over time.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Maximum number of earnings records to return (1-100). Premium subscribers only. |
| `ticker` | string | Yes | Stock ticker symbol to get earnings data for (e.g., 'AAPL', 'MSFT', 'GOOGL'). |
| `show_upcoming` | boolean | No | Whether to include upcoming/scheduled earnings dates in addition to past earnings. Defaults to false. Premium subscribers only. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Earnings Call Transcript

**Slug:** `API_NINJAS_EARNINGS_CALL_TRANSCRIPT`

Retrieve the full earnings call transcript for a publicly traded company. Use this tool when you need to analyze what was discussed during a company's quarterly earnings call, including management commentary, Q&A with analysts, financial guidance, and strategic updates. Note: This endpoint requires a premium API Ninjas subscription. Example use cases: - Analyze management sentiment during earnings calls - Extract forward guidance and projections - Review analyst questions and company responses - Compare earnings call content across quarters

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `cik` | string | No | Company Central Index Key (CIK), a unique identifier assigned by the SEC (e.g., '320193' for Apple Inc.). Either ticker or cik must be provided. |
| `year` | integer | No | Fiscal year of the earnings call (e.g., 2024). If omitted along with quarter, returns the most recent transcript. Must be between 2000 and the current year. |
| `ticker` | string | No | Company stock ticker symbol (e.g., 'AAPL' for Apple Inc.). Either ticker or cik must be provided. |
| `quarter` | integer ("1" | "2" | "3" | "4") | No | Fiscal quarter of the earnings call (1=Q1, 2=Q2, 3=Q3, 4=Q4). If omitted along with year, returns the most recent transcript. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### ETF Info

**Slug:** `API_NINJAS_ETF_INFO`

Retrieve detailed information about an Exchange-Traded Fund (ETF) by its ticker symbol. Returns the ETF's full name, ISIN, CUSIP, and country of origin. Note: expense_ratio, aum, holdings, and num_holdings require a premium API subscription and will return null for free-tier users.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `ticker` | string | Yes | ETF ticker symbol. Case-insensitive. Examples: 'SPY' (S&P 500), 'QQQ' (NASDAQ-100), 'VTI' (Total Stock Market), 'BND' (Bond Market). |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Extract Webpage Content

**Slug:** `API_NINJAS_EXTRACT_WEBPAGE_CONTENT`

Tool to extract main content and metadata from a webpage. Returns URL, domain, path, page title, description, meta tags, and favicon. Use when you need to retrieve structured information from any web page.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `url` | string | Yes | The URL of the webpage to extract content from. Must be a valid HTTP or HTTPS URL. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Filter Profanity from Text

**Slug:** `API_NINJAS_FILTER_PROFANITY`

Tool to detect and censor profanity in text. Returns the original text, censored version with profane words replaced by asterisks, and whether profanity was detected.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `text` | string | Yes | Text to filter for profanity. Maximum 1000 characters. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Find EV Charging Stations

**Slug:** `API_NINJAS_FIND_EV_CHARGING_STATIONS`

Tool to find electric vehicle charging stations near a specified location. Use when you need to locate EV charging infrastructure by geographic coordinates.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `lat` | number | Yes | Latitude coordinate of the search location. |
| `lon` | number | Yes | Longitude coordinate of the search location. |
| `level` | integer | No | Filter by charging level: 1 (slow), 2 (medium), or 3 (fast/DC). |
| `limit` | integer | No | Maximum number of results to return. Range: 1-30, default 3. |
| `offset` | integer | No | Number of results to skip for pagination. |
| `distance` | number | No | Search radius distance in kilometers. Maximum 50 km, default 3 km. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Generate Lorem Ipsum Text

**Slug:** `API_NINJAS_GENERATE_LOREM_IPSUM`

Tool to generate Lorem Ipsum placeholder text. Use when you need dummy text for design mockups, testing, or content placeholders.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `paragraphs` | integer | No | Number of paragraphs of Lorem Ipsum text to generate. Must be a positive integer. Defaults to 1 if not specified. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Generate Secure Password

**Slug:** `API_NINJAS_GENERATE_PASSWORD`

Tool to generate secure random passwords with configurable length and character types. Use when you need to create strong passwords with specific requirements for uppercase, lowercase, numbers, and special characters.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `length` | integer | No | Password length in characters. Default is 16. |
| `numbers` | boolean | No | Include numbers (0-9) in the password. |
| `special` | boolean | No | Include special characters (!@#$%^&*() etc.) in the password. |
| `lowercase` | boolean | No | Include lowercase letters (a-z) in the password. |
| `uppercase` | boolean | No | Include uppercase letters (A-Z) in the password. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Generate QR Code

**Slug:** `API_NINJAS_GENERATE_QR_CODE`

Tool to generate QR code images for encoding data. Use when you need to create scannable QR codes for URLs, text, or other data. Returns the QR code as a PNG or SVG image file.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data to encode in the QR code. Can be any text, URL, or other string content. |
| `format` | string ("png" | "svg") | No | Output format for the QR code image. Choose 'png' for raster image or 'svg' for vector graphics. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Generate Random User Profiles

**Slug:** `API_NINJAS_GENERATE_RANDOM_USER`

Tool to generate fake random user profiles with realistic data. Returns user profiles with names, addresses, contact info, job details, and technical data. Use when you need realistic test data, demo users, or placeholder profiles for development and testing purposes.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `seed` | string | No | Seed value for reproducible random data generation. Using the same seed value will always produce the same set of random users, which is useful for testing or creating consistent demo data. |
| `count` | integer | No | Number of random user profiles to generate. Must be between 1 and 30. Default: 10 |
| `fields` | string | No | Comma-separated list of specific fields to include in the response. Only these fields will be returned. Example: 'first_name,last_name,email,phone'. Available fields include: id, username, password, email, uuid, locale, name, first_name, last_name, full_name, prefix, suffix, phone, cell, company_email, street_address, city, state, postal_code, country, address, latitude, longitude, timezone, dob, age, gender, job, company, ssn, credit_card, credit_card_provider, iban, ipv4, ipv6, mac_address, user_agent, url, domain, md5, sha1, sha256, picture, avatar. |
| `gender` | string ("male" | "female" | "nonbinary" | "any") | No | Gender filter for random user generation |
| `locale` | string | No | Locale for generating localized data such as names, addresses, and phone numbers. Use standard locale codes like 'en_US' (English - United States), 'de_DE' (German - Germany), 'fr_FR' (French - France), 'es_ES' (Spanish - Spain), etc. Default: 'en_US' |
| `exclude` | string | No | Comma-separated list of fields to exclude from the response. All fields except these will be returned. Example: 'ssn,credit_card,password' to exclude sensitive data. Cannot be used together with 'fields' parameter. |
| `max_age` | integer | No | Maximum age for generated users. Must be between 0 and 1000. Default: 100 |
| `min_age` | integer | No | Minimum age for generated users. Must be between 0 and 1000. Default: 0 |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Generate Sudoku Puzzle

**Slug:** `API_NINJAS_GENERATE_SUDOKU`

Tool to generate a new Sudoku puzzle with a specified difficulty level. Use when you need to create Sudoku puzzles for games or educational purposes. Returns both the puzzle grid (with empty cells) and the complete solution.

#### Input Parameters

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

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Generate Text Embeddings

**Slug:** `API_NINJAS_GENERATE_TEXT_EMBEDDINGS`

Tool to encode text into vector embeddings using NLP models. Use when you need to generate semantic vectors for text comparison, search, or recommendation systems.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `text` | string | Yes | Text to generate embeddings for. Maximum 5,000 characters. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Generate User Agent String

**Slug:** `API_NINJAS_GENERATE_USER_AGENT`

Tool to generate realistic random user agent strings with optional filters for brand, model, OS, and browser. Use when you need authentic-looking user agent strings for web scraping, testing, or browser simulation.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `os` | string | No | Operating system to filter by (e.g., 'Windows', 'iOS', 'Android', 'macOS', 'Linux'). If not specified, any OS may be used. |
| `brand` | string | No | Device manufacturer/brand to filter by (e.g., 'Apple', 'Samsung', 'Google', 'LG'). If not specified, any brand may be used. |
| `model` | string | No | Device model name to filter by (e.g., 'iPhone', 'Galaxy', 'Pixel'). If not specified, any model may be used. |
| `browser` | string | No | Browser application to filter by (e.g., 'Chrome', 'Firefox', 'Safari', 'Edge'). If not specified, any browser may be used. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Random Life Advice

**Slug:** `API_NINJAS_GET_ADVICE`

Tool to get a random piece of life advice from the API Ninjas Advice endpoint. Use when you need motivational or thought-provoking advice.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Aircraft Information

**Slug:** `API_NINJAS_GET_AIRCRAFT`

Tool to retrieve aircraft information by manufacturer and model including specifications and performance data. Use when you need technical details about specific aircraft models or want to search aircraft by performance criteria.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `model` | string | No | Aircraft model name (e.g., 'G550', '747', 'Citation'). |
| `max_range` | integer | No | Maximum range in nautical miles. Filter aircraft with range less than or equal to this value. |
| `max_speed` | integer | No | Maximum speed in knots. Filter aircraft with speed less than or equal to this value. |
| `min_range` | integer | No | Minimum range in nautical miles. Filter aircraft with range greater than or equal to this value. |
| `min_speed` | integer | No | Minimum speed in knots. Filter aircraft with speed greater than or equal to this value. |
| `manufacturer` | string | No | Aircraft manufacturer name (e.g., 'Gulfstream', 'Boeing', 'Cessna'). |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Airline Information

**Slug:** `API_NINJAS_GET_AIRLINES`

Tool to retrieve airline information by name, IATA code, or ICAO code. Use when you need details about airlines including fleet size, base location, and branding assets.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `iata` | string | No | 2-letter IATA airline code (e.g., 'LH' for Lufthansa, 'SQ' for Singapore Airlines). |
| `icao` | string | No | 3-letter ICAO airline code (e.g., 'DLH' for Lufthansa, 'SIA' for Singapore Airlines). |
| `name` | string | No | Airline name to search for (e.g., 'Lufthansa', 'Singapore Airlines'). Partial matches are supported. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Airport Information

**Slug:** `API_NINJAS_GET_AIRPORTS`

Tool to search for airport information by IATA code, ICAO code, name, city, country, or region. Use when you need to find airport details, coordinates, or codes. Returns up to 10 matching airports.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `city` | string | No | City name to search for airports (e.g., 'New York', 'London', 'Paris'). Returns all airports in the specified city. |
| `iata` | string | No | 3-letter IATA airport code (e.g., 'JFK', 'LHR', 'CDG'). Use this to search for a specific airport by its international code. |
| `icao` | string | No | 4-letter ICAO airport code (e.g., 'KJFK', 'EGLL', 'LFPG'). Use this to search for a specific airport by its ICAO designation. |
| `name` | string | No | Airport name to search for (e.g., 'John F Kennedy International Airport', 'Heathrow'). Partial matches are supported. |
| `region` | string | No | Region or state to search for airports (e.g., 'California', 'Texas', 'England'). Returns all airports in the specified region. |
| `country` | string | No | Country code or name to search for airports (e.g., 'US', 'United States', 'GB', 'United Kingdom'). Returns all airports in the specified country. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Air Quality Data

**Slug:** `API_NINJAS_GET_AIR_QUALITY`

Tool to retrieve air quality index and pollutant data for a location. Use when you need current air quality information for environmental monitoring or health assessments. Query by city name or GPS coordinates.

#### Input Parameters

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

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Animal Information

**Slug:** `API_NINJAS_GET_ANIMALS`

Tool to retrieve detailed scientific information about animal species including taxonomy, habitat, diet, and physical characteristics. Use when you need comprehensive facts about specific animals.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | Yes | Common name of the animal to search for. Returns up to 10 matching results. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Baby Names

**Slug:** `API_NINJAS_GET_BABY_NAMES`

Tool to get baby name suggestions by gender. Returns 10 baby name suggestions that can be filtered by gender (boy, girl, or neutral) and popularity. Use when you need baby name ideas or recommendations.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `gender` | string ("boy" | "girl" | "neutral") | No | Gender filter for baby names |
| `popular_only` | boolean | No | Whether to only return popular names (top 10% of names). Set to true to get only popular names, false to include less common names. Defaults to true. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Random Bucket List Idea

**Slug:** `API_NINJAS_GET_BUCKETLIST`

Tool to retrieve a random bucket list idea or activity. Use when you need inspiration for bucket list items or life goals.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Car Specifications

**Slug:** `API_NINJAS_GET_CARS`

Tool to get car specifications including make, model, fuel type, MPG, transmission, and engine details. Use when you need detailed vehicle data filtered by manufacturer, year, fuel efficiency, or other attributes. Note: This endpoint is deprecated; consider using newer car API endpoints if available.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `make` | string | No | Car manufacturer/make (e.g., 'toyota', 'honda', 'ford'). |
| `year` | integer | No | Model year (e.g., 2020, 2015, 1993). |
| `drive` | string | No | Drive type. Valid values: 'fwd' (front-wheel drive), 'rwd' (rear-wheel drive), 'awd' (all-wheel drive), '4wd' (four-wheel drive). |
| `limit` | integer | No | Number of results to return. Maximum is typically 30. |
| `model` | string | No | Car model name (e.g., 'camry', 'civic', 'mustang'). |
| `cylinders` | integer | No | Number of cylinders in the engine (e.g., 4, 6, 8). |
| `fuel_type` | string | No | Fuel type. Valid values: 'gas', 'diesel', 'electricity'. |
| `max_hwy_mpg` | integer | No | Maximum highway miles per gallon (MPG). |
| `min_hwy_mpg` | integer | No | Minimum highway miles per gallon (MPG). |
| `max_city_mpg` | integer | No | Maximum city miles per gallon (MPG). |
| `min_city_mpg` | integer | No | Minimum city miles per gallon (MPG). |
| `transmission` | string | No | Transmission type. Valid values: 'manual', 'automatic' (or 'a' for automatic, 'm' for manual). |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Cat Breed Information

**Slug:** `API_NINJAS_GET_CATS`

Tool to retrieve information on cat breeds matching specified parameters. Use when you need to search for cat breeds by characteristics such as name, weight, life expectancy, shedding level, playfulness, grooming needs, or friendliness with family and other pets.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | No | Cat breed name to search for (e.g., 'persian', 'siamese'). Partial matches are supported. |
| `grooming` | integer | No | Grooming needs on a scale of 1-5, where 1 requires minimal grooming and 5 requires extensive grooming. |
| `shedding` | integer | No | Shedding level on a scale of 1-5, where 1 is minimal shedding and 5 is heavy shedding. |
| `max_weight` | integer | No | Maximum weight in pounds. Must be greater than min_weight if both are specified. |
| `min_weight` | integer | No | Minimum weight in pounds. Must be less than max_weight if both are specified. |
| `playfulness` | integer | No | Playfulness level on a scale of 1-5, where 1 is less playful and 5 is very playful. |
| `family_friendly` | integer | No | Family friendliness level on a scale of 1-5, where 1 is less family-friendly and 5 is very family-friendly. |
| `max_life_expectancy` | integer | No | Maximum life expectancy in years. Must be greater than min_life_expectancy if both are specified. |
| `min_life_expectancy` | integer | No | Minimum life expectancy in years. Must be less than max_life_expectancy if both are specified. |
| `other_pets_friendly` | integer | No | Pet friendliness level on a scale of 1-5, where 1 is less friendly with other pets and 5 is very friendly with other pets. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Celebrity Information

**Slug:** `API_NINJAS_GET_CELEBRITY`

Tool to search for celebrity information by name or other criteria. Returns details including net worth, height, birthday, nationality, and occupation. Use when you need to find information about famous people, filter celebrities by attributes like net worth or nationality, or gather biographical data.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | No | Name of the celebrity you wish to search. This field is case-insensitive. |
| `offset` | integer | No | Number of results to offset for pagination. |
| `max_height` | number | No | Maximum height of celebrities in meters. |
| `min_height` | number | No | Minimum height of celebrities in meters. |
| `nationality` | string | No | Nationality of celebrities. Must be an ISO 3166 Alpha-2 country code (e.g., US, GB, FR). |
| `max_net_worth` | integer | No | Maximum net worth of celebrities in US dollars. |
| `min_net_worth` | integer | No | Minimum net worth of celebrities in US dollars. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Chuck Norris Joke

**Slug:** `API_NINJAS_GET_CHUCK_NORRIS_JOKE`

Tool to retrieve a random Chuck Norris joke from the API Ninjas database. Use when you need humorous Chuck Norris content.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get City Information

**Slug:** `API_NINJAS_GET_CITY`

Tool to retrieve city information by name, country, coordinates, or population filters. Use when you need geographic data about cities including coordinates, population, and capital status. At least one search parameter is required.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | No | City name to search for (e.g., 'London', 'New York'). |
| `limit` | integer | No | Number of results to return per request (range: 1-30). Premium feature only. |
| `offset` | integer | No | Pagination offset to skip the first N results. |
| `country` | string | No | ISO-3166 alpha-2 country code to filter cities (e.g., 'US', 'GB', 'JP'). |
| `max_lat` | number | No | Maximum latitude coordinate for geographic filtering (range: -90 to 90). |
| `max_lon` | number | No | Maximum longitude coordinate for geographic filtering (range: -180 to 180). |
| `min_lat` | number | No | Minimum latitude coordinate for geographic filtering (range: -90 to 90). |
| `min_lon` | number | No | Minimum longitude coordinate for geographic filtering (range: -180 to 180). |
| `max_population` | integer | No | Maximum population count for filtering cities. |
| `min_population` | integer | No | Minimum population count for filtering cities. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Cocktail Recipes

**Slug:** `API_NINJAS_GET_COCKTAIL`

Tool to search for cocktail recipes by name or ingredients. Returns up to 10 cocktail recipes with ingredients and preparation instructions. Use when you need cocktail recipes, drink mixing instructions, or want to find drinks by specific ingredients.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | No | Cocktail name to search for. Supports partial matches (e.g., 'marg' matches 'Margarita'). Case-insensitive. |
| `ingredients` | string | No | Comma-separated list of ingredients to search for. Uses AND logic (returns cocktails containing all specified ingredients). Case-insensitive. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Company Logo

**Slug:** `API_NINJAS_GET_COMPANY_LOGO`

Tool to retrieve company logo images by company name or ticker symbol. Use when you need to display or download company logos.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | No | Company name that supports partial matching (case-insensitive). Either name or ticker is required. |
| `ticker` | string | No | Company ticker symbol for publicly traded companies. Either name or ticker is required. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get and Increment Counter

**Slug:** `API_NINJAS_GET_COUNTER`

Tool to get and optionally increment a persistent counter. Use when you need to track counts or maintain state across API calls.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | ID to specify the counter. Use a new id to create a new counter. |
| `hit` | boolean | No | Increments counter by 1 when set to true. If false or not provided, counter is not incremented. |
| `value` | integer | No | Sets counter to specific value. Use 0 to reset the counter. If provided, this overrides the 'hit' parameter. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Country Flag SVG

**Slug:** `API_NINJAS_GET_COUNTRY_FLAG`

Tool to retrieve country flag images in SVG format. Use when you need flag URLs for display or download.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `country` | string | Yes | Country name (e.g., 'United States') or ISO 3166-1 alpha-2 country code (e.g., 'US') |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Country Information

**Slug:** `API_NINJAS_GET_COUNTRY_INFO`

Tool to retrieve detailed country information by name, ISO code, or filtering by economic and demographic criteria. Use when you need comprehensive data about countries including population, GDP, surface area, unemployment, fertility rates, and other key statistics. Supports filtering by min/max ranges for various metrics.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | No | Plain English name, 2-letter ISO-3166 alpha-2 (e.g., 'US'), or 3-letter ISO-3166 alpha-3 (e.g., 'USA') code of country. |
| `limit` | integer | No | How many results to return. Must be between 1 and 30. Default is 5. |
| `max_gdp` | number | No | Maximum gross domestic product (GDP) of country, in US Dollars. |
| `min_gdp` | number | No | Minimum gross domestic product (GDP) of country, in US Dollars. |
| `max_fertility` | number | No | Maximum fertility rate in %. |
| `min_fertility` | number | No | Minimum fertility rate in %. |
| `max_gdp_growth` | number | No | Maximum GDP growth rate in %. |
| `max_population` | integer | No | Maximum population of country. |
| `min_gdp_growth` | number | No | Minimum GDP growth rate in %. |
| `min_population` | integer | No | Minimum population of country. |
| `max_surface_area` | number | No | Maximum surface area of country in km2. |
| `max_unemployment` | number | No | Maximum unemployment rate in %. |
| `min_surface_area` | number | No | Minimum surface area of country in km2. |
| `min_unemployment` | number | No | Minimum unemployment rate in %. |
| `max_infant_mortality` | number | No | Maximum infant mortality rate in %. |
| `min_infant_mortality` | number | No | Minimum infant mortality rate in %. |
| `max_urban_population_rate` | number | No | Maximum urban population rate in %. |
| `min_urban_population_rate` | number | No | Minimum urban population rate in %. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get County Information

**Slug:** `API_NINJAS_GET_COUNTY`

Tool to retrieve US county information by name, ZIP code, or state. Use when you need geographic, demographic, or administrative data about US counties. Returns county name, FIPS code, location coordinates, timezone, population, and median age.

#### Input Parameters

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

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Random Dad Jokes

**Slug:** `API_NINJAS_GET_DAD_JOKE`

Tool to retrieve random dad jokes from API Ninjas. Returns one or more dad jokes suitable for light humor. Use when you need clean, family-friendly jokes.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | How many jokes to return. Must be between 1 and 100. Default is 1. Note: Values greater than 1 require a premium API Ninjas subscription. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Day in History Events

**Slug:** `API_NINJAS_GET_DAY_IN_HISTORY`

Tool to get historical events for a specific date. Use when you need to retrieve events that occurred on a particular day in history. Returns events for today's date if no parameters are provided.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `day` | integer | No | The day of the month for the historical events to retrieve. Must be between 1 and 31. If specified, month must also be provided. Premium subscription required to specify custom dates. |
| `limit` | integer | No | The maximum number of results to return. Must be between 1 and 30. Default is 1. |
| `month` | integer | No | The month of the historical events to retrieve. Must be between 1 and 12. If specified, day must also be provided. Premium subscription required to specify custom dates. |
| `offset` | integer | No | The number of results to skip. Must be zero or a positive integer. Used for pagination. Default is 0. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Dictionary Definition

**Slug:** `API_NINJAS_GET_DICTIONARY_DEFINITION`

Tool to retrieve dictionary definition for an English word. Use when you need the meaning or definition of a word.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `word` | string | Yes | Word to look up in the dictionary. Must be a valid English word. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Dog Breed Information

**Slug:** `API_NINJAS_GET_DOGS`

Tool to get information on dog breeds matching specified parameters. Use when you need breed characteristics like temperament, size, life expectancy, or other traits.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | No | Dog breed name to search for (e.g., 'husky', 'labrador'). |
| `energy` | integer | No | Energy level (1-5, where 1 is lowest and 5 is highest). |
| `barking` | integer | No | Barking level (1-5, where 1 is lowest and 5 is highest). |
| `shedding` | integer | No | Shedding level (1-5, where 1 is lowest and 5 is highest). |
| `max_height` | integer | No | Maximum height in inches. |
| `max_weight` | integer | No | Maximum weight in pounds. |
| `min_height` | integer | No | Minimum height in inches. |
| `min_weight` | integer | No | Minimum weight in pounds. |
| `trainability` | integer | No | Trainability level (1-5, where 1 is lowest and 5 is highest). |
| `protectiveness` | integer | No | Protectiveness level (1-5, where 1 is lowest and 5 is highest). |
| `max_life_expectancy` | integer | No | Maximum life expectancy in years. |
| `min_life_expectancy` | integer | No | Minimum life expectancy in years. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Earnings

**Slug:** `API_NINJAS_GET_EARNINGS`

Tool to retrieve comprehensive earnings report data for publicly traded companies. Returns financial statements including income statement, balance sheet, and cash flow data sourced from SEC filings (10-Q for Q1-Q3, 10-K for Q4). Use when you need detailed quarterly financial metrics.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `cik` | string | No | Central Index Key (CIK) to identify the company. Either ticker or cik must be provided. |
| `year` | integer | No | Fiscal year (e.g., 2025). Must be between 2000 and 2100. If omitted, returns most recent earnings data. |
| `period` | string ("q1" | "q2" | "q3" | "q4") | No | Fiscal quarter period options. |
| `ticker` | string | No | Company ticker symbol (e.g., 'AAPL', 'ADBE'). Either ticker or cik must be provided. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Electric Vehicle Info

**Slug:** `API_NINJAS_GET_ELECTRIC_VEHICLE_INFO`

Get electric vehicle information by make, model, year range, or electric range. Returns details including battery capacity, charging power, dimensions, and performance specs. At least one filter parameter (make, model, min_year, max_year, min_range, or max_range) is required - limit and offset alone are not sufficient.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `make` | string | No | Vehicle manufacturer (e.g., 'tesla', 'nissan', 'chevrolet'). Case-insensitive. |
| `limit` | integer | No | How many results to return. Must be between 1 and 10. Default is 1. |
| `model` | string | No | Vehicle model (e.g., 'model3', 'leaf', 'bolt'). Case-insensitive. |
| `offset` | integer | No | Number of results to skip for pagination. Default is 0. |
| `max_year` | integer | No | Maximum vehicle model year (e.g., 2023). Filter results to vehicles up to this year. |
| `min_year` | integer | No | Minimum vehicle model year (e.g., 2020). Filter results to vehicles from this year onwards. |
| `max_range` | integer | No | Maximum electric range in kilometers (e.g., 600). Filter results to vehicles with at most this range. |
| `min_range` | integer | No | Minimum electric range in kilometers (e.g., 250). Filter results to vehicles with at least this range. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Emoji Information

**Slug:** `API_NINJAS_GET_EMOJI`

Tool to retrieve emoji information and images from the API Ninjas Emoji database. Use when you need emoji metadata, Unicode codes, or emoji images based on name, code, category, or subcategory. At least one search parameter (name, code, group, or subgroup) must be provided. Returns up to 30 results per request; use offset for pagination.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `code` | string | No | Unicode character code for the emoji (e.g., 'U+1F642'). Must be uppercase with U+ prefix. |
| `name` | string | No | Descriptive name of emoji to search for (e.g., 'smile', 'heart'). |
| `group` | string | No | Main category to filter emojis. Valid categories: smileys_emotion, people_body, component, animals_nature, food_drink, travel_places, activities, objects, symbols, flags. |
| `offset` | integer | No | Number of results to offset for pagination. Use this to retrieve results beyond the first 30. Default is 0. |
| `subgroup` | string | No | Sub-category to filter emojis within a group. The subgroup must be valid for the selected group. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Exchange Rate

**Slug:** `API_NINJAS_GET_EXCHANGE_RATE`

Get the current exchange rate for a currency pair. Returns the conversion rate from the first currency to the second currency. Use this to check current foreign exchange rates between any two currencies.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `pair` | string | Yes | Currency pair in format CURRENCY1_CURRENCY2 (e.g., 'GBP_AUD', 'USD_EUR', 'JPY_USD'). Use underscore to separate the two currency codes. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Exercises

**Slug:** `API_NINJAS_GET_EXERCISES`

Tool to get exercise information by muscle group, type, or difficulty level. Returns up to 10 exercises that match the specified criteria. Use when you need to find exercises for specific muscle groups, workout types, or difficulty levels.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | No | Name of the exercise to search for. Searches for exercises matching this name. |
| `type` | string ("cardio" | "olympic_weightlifting" | "plyometrics" | "powerlifting" | "strength" | "stretching" | "strongman") | No | Exercise type categories |
| `muscle` | string | No | Target muscle group to filter by. Common values include: abdominals, abductors, adductors, biceps, calves, chest, forearms, glutes, hamstrings, lats, lower_back, middle_back, neck, quadriceps, traps, triceps. |
| `difficulty` | string ("beginner" | "intermediate" | "expert") | No | Exercise difficulty levels |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Fact of the Day

**Slug:** `API_NINJAS_GET_FACT_OF_THE_DAY`

Tool to retrieve the fact of the day from API Ninjas. Returns the same fact for all users on a given day, with facts changing daily. Use when you need a daily interesting fact to display or share.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Random Facts

**Slug:** `API_NINJAS_GET_FACTS`

Tool to retrieve random interesting facts from API Ninjas. Returns facts about science, literature, philosophy, and other topics. Use when you need interesting factual information to display or share.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Number of facts to return. Must be between 1 and 100. Default is 1. Note: Requesting more than 1 fact requires a premium API Ninjas subscription. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get GDP Data

**Slug:** `API_NINJAS_GET_GDP`

Tool to get GDP data for a country. Use when you need GDP statistics including growth rate, nominal GDP, GDP per capita, and purchasing power parity data.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `year` | integer | No | Year for which to retrieve GDP data. At least one of country or year must be set. |
| `country` | string | No | Country name (case-insensitive) or 2-letter ISO-3166 alpha-2 code (e.g., 'Canada' or 'CA'). At least one of country or year must be set. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Convert City to Coordinates

**Slug:** `API_NINJAS_GET_GEOCODING`

Tool to convert city names to geographic coordinates (forward geocoding). Returns latitude, longitude, and country code for specified city. Use when you need to find the coordinates of a location by its name.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `city` | string | Yes | City name to geocode. Required parameter for converting a city location to latitude and longitude coordinates. |
| `state` | string | No | Optional US state name or abbreviation to narrow down the search. Only applicable for cities in the United States (e.g., 'California' or 'CA'). |
| `country` | string | No | Optional 2-letter ISO 3166 alpha-2 country code to narrow down the search (e.g., 'GB' for United Kingdom, 'US' for United States). Useful when multiple cities share the same name. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Helicopter Information

**Slug:** `API_NINJAS_GET_HELICOPTER`

Tool to get helicopter information by manufacturer, model, and specifications. Use when you need detailed technical specifications for helicopters including speed, range, dimensions, and load capacity. At least one search parameter (manufacturer, model, or specification filter) must be provided.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Number of results to return. Must be between 1 and 30. Defaults to 1 if not specified. |
| `model` | string | No | Helicopter model name (e.g., '206L-3', 'UH-60'). |
| `max_range` | number | No | Maximum range in nautical miles. |
| `max_speed` | number | No | Maximum air speed ceiling in knots. |
| `min_range` | number | No | Minimum range in nautical miles. |
| `min_speed` | number | No | Minimum maximum air speed in knots. |
| `max_height` | number | No | Maximum height in feet. |
| `max_length` | number | No | Maximum length in feet. |
| `min_height` | number | No | Minimum height in feet. |
| `min_length` | number | No | Minimum length in feet. |
| `manufacturer` | string | No | Company that designed and built the helicopter (e.g., 'Bell', 'Airbus', 'Sikorsky'). |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Historical Events

**Slug:** `API_NINJAS_GET_HISTORICAL_EVENTS`

Tool to retrieve historical events by date or keywords. Use when you need information about events that happened on a specific date or related to specific topics.

#### Input Parameters

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

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Historical Figures

**Slug:** `API_NINJAS_GET_HISTORICAL_FIGURES`

Tool to search for historical figures by name. Returns biographical information including birth/death dates, titles, awards, offices held, and family details. Use when you need information about famous people from history.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | No | Name of the person to search. Supports partial matching (e.g., 'julius' will match Julius Caesar). Case-insensitive. |
| `offset` | integer | No | Number of results to offset for pagination. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Random Hobby Suggestions

**Slug:** `API_NINJAS_GET_HOBBIES`

Tool to get random hobby suggestions from API Ninjas. Use when you need inspiration for new hobbies or activities, optionally filtered by category.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `category` | string ("general" | "sports_and_outdoors" | "education" | "collection" | "competition" | "observation") | No | Hobby category options |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Holidays

**Slug:** `API_NINJAS_GET_HOLIDAYS`

Tool to retrieve holidays for a specific country and year. Use when you need information about public holidays, observances, or national holidays for planning or scheduling purposes. Supports over 230 countries worldwide.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `type` | string | No | Holiday type filter to narrow results (e.g., 'public_holiday', 'observance', 'national_holiday', 'religious'). If not specified, returns all holiday types. |
| `year` | integer | No | Calendar year to retrieve holidays for (e.g., 2024, 2025). Note: This parameter requires premium subscription. If not provided, defaults to current year. |
| `country` | string | Yes | 2-letter ISO 3166-1 alpha-2 country code (e.g., 'US' for United States, 'GB' for United Kingdom, 'CA' for Canada). |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Daily Horoscope

**Slug:** `API_NINJAS_GET_HOROSCOPE`

Tool to get daily horoscope for a zodiac sign. Returns the horoscope text for the specified zodiac sign and date. Use when you need astrological predictions or daily horoscope information for any of the 12 zodiac signs.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `date` | string | No | Historical horoscope retrieval in YYYY-MM-DD format (premium feature). Must be current date or earlier. Defaults to today's date if omitted. |
| `zodiac` | string ("aries" | "taurus" | "gemini" | "cancer" | "leo" | "virgo" | "libra" | "scorpio" | "sagittarius" | "capricorn" | "aquarius" | "pisces") | Yes | The astrological sign to retrieve horoscope data for. Must be one of the 12 zodiac signs. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Hospital Information

**Slug:** `API_NINJAS_GET_HOSPITALS`

Tool to retrieve hospital information by name, location, or geographic coordinates. Use when you need to find hospitals in a specific area or search for a particular hospital by name.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `city` | string | No | City where the hospital is located (e.g., 'New York', 'Los Angeles'). |
| `name` | string | No | Hospital name to search for (e.g., 'General Hospital', 'Memorial'). Partial matches are supported. |
| `limit` | integer | No | Number of results to return per request (maximum 100, free users limited to 5). |
| `state` | string | No | State where the hospital is located (e.g., 'NY', 'CA', 'Texas'). |
| `county` | string | No | County where the hospital is located (e.g., 'New York County', 'Los Angeles County'). |
| `offset` | integer | No | Pagination offset to skip the first N results. |
| `zipcode` | string | No | Hospital ZIP code (e.g., '10001', '90001'). |
| `max_latitude` | number | No | Maximum latitude coordinate for geographic filtering (range: -90 to 90). |
| `min_latitude` | number | No | Minimum latitude coordinate for geographic filtering (range: -90 to 90). |
| `max_longitude` | number | No | Maximum longitude coordinate for geographic filtering (range: -180 to 180). |
| `min_longitude` | number | No | Minimum longitude coordinate for geographic filtering (range: -180 to 180). |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Income Tax

**Slug:** `API_NINJAS_GET_INCOME_TAX`

Get current and historical income tax bracket rates for a country by year. Returns federal tax brackets organized by filing status (e.g., single, married, head_of_household for US) or as a single bracket list for countries without filing statuses. State/provincial data may require a premium subscription. Use this tool when you need to: - Look up tax brackets and rates for a specific country and tax year - Compare tax rates across different filing statuses - Get historical tax bracket information Supported countries include US (United States) and CA (Canada).

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `year` | integer | Yes | Tax year to retrieve data for (e.g., 2024, 2023). Historical data is available for past years. |
| `country` | string | Yes | 2-letter ISO 3166-1 alpha-2 country code in uppercase. Supported countries include US and CA. Use 'US' for United States, 'CA' for Canada. |
| `federal_only` | boolean | No | If true, returns only federal tax information without state/provincial details. Set to true to exclude state/province data from the response. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Insider Transactions

**Slug:** `API_NINJAS_GET_INSIDER_TRANSACTIONS`

Tool to get insider trading transactions for publicly traded companies. Returns SEC-filed insider trading data including purchases, sales, and awards by company executives, directors, and major shareholders. Use when you need to track insider activity, analyze insider sentiment, or research specific transactions by ticker, insider name, or transaction details.

#### Input Parameters

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

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get IP Geolocation

**Slug:** `API_NINJAS_GET_IP_LOOKUP`

Tool to retrieve geolocation information for an IP address. Returns country, region, city, coordinates, ISP, and timezone data. Use when you need to identify the geographic location or ISP associated with an IPv4 or IPv6 address.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `address` | string | Yes | IPv4 or IPv6 address to look up. Must be in IPv4 format A.B.C.D (e.g., 8.8.8.8) or IPv6 format X:X:X:X:X:X:X:X (e.g., 2001:0db8:85a3:0000:0000:8a2e:0370:7334). |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Joke of the Day

**Slug:** `API_NINJAS_GET_JOKE_OF_THE_DAY`

Tool to retrieve the joke of the day from API Ninjas. Returns the same joke for all users on a given day, with jokes changing daily. Use when you need a daily joke to display or share.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Random Jokes

**Slug:** `API_NINJAS_GET_JOKES`

Tool to retrieve random jokes from API Ninjas. Returns one or more jokes suitable for entertainment. Use when you need general humor content.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | How many jokes to return. Must be between 1 and 30. Default is 1. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Motorcycle Specifications

**Slug:** `API_NINJAS_GET_MOTORCYCLES`

Tool to get detailed motorcycle specifications by make, model, and year. Use when you need technical data about specific motorcycle models including engine specs, dimensions, transmission, suspension, and performance data.

#### Input Parameters

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

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Mutual Fund Info

**Slug:** `API_NINJAS_GET_MUTUAL_FUND`

Tool to get mutual fund information by ticker. Returns the fund's name, ISIN, CUSIP, and country. Note: price, expense_ratio, aum, num_holdings, and holdings require a premium API subscription and will return null for free-tier users.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `ticker` | string | Yes | Mutual Fund ticker symbol. Case-insensitive. Examples: 'VFIAX' (Vanguard 500 Index Fund), 'FXAIX' (Fidelity 500 Index Fund), 'FZROX' (Fidelity ZERO Total Market Index Fund). |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get MX Records

**Slug:** `API_NINJAS_GET_MX_RECORDS`

Tool to retrieve MX (Mail Exchange) records for a specified domain. Use when you need to identify mail servers responsible for accepting email for a domain.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `domain` | string | Yes | A valid domain name to query MX records for (e.g., example.com). |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Planet Information

**Slug:** `API_NINJAS_GET_PLANETS`

Tool to retrieve detailed information about planets and exoplanets including mass, radius, orbital period, temperature, and host star data. Use when you need astronomical data about planets in the known universe. At least one parameter (other than offset) must be set.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | No | The name of the planet to search for. |
| `offset` | integer | No | Offset results for pagination. Returns at most 30 results per request. |
| `max_mass` | number | No | Maximum mass of the planet in Jupiters (1 Jupiter = 1.898 × 10²⁷ kg). |
| `min_mass` | number | No | Minimum mass of the planet in Jupiters (1 Jupiter = 1.898 × 10²⁷ kg). |
| `max_period` | number | No | Maximum orbital period of the planet in Earth days. |
| `max_radius` | number | No | Maximum average radius of the planet in Jupiters (1 Jupiter = 69911 km). |
| `min_period` | number | No | Minimum orbital period of the planet in Earth days. |
| `min_radius` | number | No | Minimum average radius of the planet in Jupiters (1 Jupiter = 69911 km). |
| `max_temperature` | number | No | Maximum average surface temperature in Kelvin. |
| `min_temperature` | number | No | Minimum average surface temperature in Kelvin. |
| `max_distance_light_year` | number | No | Maximum distance from Earth in light years. |
| `min_distance_light_year` | number | No | Minimum distance from Earth in light years. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Population Data

**Slug:** `API_NINJAS_GET_POPULATION`

Tool to get population data for a country. Use when you need historical and forecasted population statistics including yearly changes, migration, demographics, and urban population metrics.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `offset` | integer | No | Offset results for pagination. |
| `country` | string | No | Country name (case-insensitive) or 2-letter ISO-3166 alpha-2 code (e.g., 'Japan' or 'JP'). At least one of country, min_population, or max_population must be set. |
| `max_population` | integer | No | Maximum population of country. At least one of country, min_population, or max_population must be set. |
| `min_population` | integer | No | Minimum population of country. At least one of country, min_population, or max_population must be set. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Postal Code Location Info

**Slug:** `API_NINJAS_GET_POSTAL_CODE`

Tool to retrieve location information for Canadian postal codes. Returns city, province, coordinates, area code, and timezone data. Use when you need to find location details for a postal code or search by city/province.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `city` | string | No | Full city name (case-sensitive) to search for location information. Premium tier required. At least one of postal_code, city, or province must be provided. |
| `province` | string | No | 2-letter Canadian province abbreviation (e.g., 'ON' for Ontario, 'BC' for British Columbia). Premium tier required. At least one of postal_code, city, or province must be provided. |
| `postal_code` | string | No | Canadian postal code (6 or 7 characters with optional space, e.g., 'K1A0B1' or 'K1A 0B1'). At least one of postal_code, city, or province must be provided. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Property Tax Rates

**Slug:** `API_NINJAS_GET_PROPERTY_TAX`

Tool to get property tax rates by city, county, or ZIP code. Use when you need effective property tax rate statistics for a specific location.

#### Input Parameters

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

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Public Holidays

**Slug:** `API_NINJAS_GET_PUBLIC_HOLIDAYS`

Tool to retrieve official public holidays for a specific country and year. Use when you need information about federal and regional public holidays for planning, scheduling, or calendar-related tasks. Supports calendar years from 1980 to 2050.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `year` | integer | No | Calendar year to retrieve public holidays for. Must be between 1980 and 2050 (inclusive). Defaults to current year if not specified. |
| `country` | string | Yes | 2-letter ISO country code or full country name (e.g., 'US', 'United States', 'GB', 'United Kingdom'). Determines which country's public holidays to retrieve. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Quote of the Day

**Slug:** `API_NINJAS_GET_QUOTE_OF_THE_DAY`

Tool to retrieve the quote of the day from API Ninjas. Returns the same quote for all users on a given day, with quotes changing daily. Use when you need an inspirational or thought-provoking daily quote to display or share.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Random Quotes

**Slug:** `API_NINJAS_GET_QUOTES`

Tool to get random quotes from famous people, filtered by category or author. Use when you need inspirational quotes, philosophical wisdom, or quotes for content creation.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Number of quotes to return. Must be between 1 and 10. Default is 1 if not specified. |
| `author` | string | No | Author name to filter quotes. Supports partial matching and is case-insensitive (e.g., 'einstein' matches 'Albert Einstein'). |
| `categories` | string | No | Comma-separated list of quote categories to filter by (e.g., 'success,wisdom'). Available categories include: wisdom, philosophy, life, truth, inspirational, relationships, love, faith, humor, success, courage, happiness, art, writing, fear, nature, time, freedom, death, leadership. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Random Image

**Slug:** `API_NINJAS_GET_RANDOM_IMAGE`

Tool to get a random image by category from API Ninjas. Use when you need random image content for display or download.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `category` | string | No | Image category filter (e.g., wildlife, nature, city). Premium subscription required for category filtering. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Random Quotes

**Slug:** `API_NINJAS_GET_RANDOM_QUOTES`

Tool to retrieve random quotes from API Ninjas. Filter by categories, author, or work title. Use when you need inspirational quotes, wisdom, or literary references for content or motivation.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `work` | string | No | Filter by work/book title using partial string matching. Matches quotes from works whose titles contain this string. |
| `limit` | integer | No | Number of random results returned (1-100 range). Default is 1. Note: This is a premium-only feature and will return an error for non-premium accounts. |
| `author` | string | No | Filter by author name using partial string matching. Matches quotes from authors whose names contain this string. |
| `categories` | string | No | Comma-separated list of category names to include. Results match all specified categories. Available categories: wisdom, philosophy, life, truth, inspirational, relationships, love, faith, humor, success, courage, happiness, art, writing, fear, nature, time, freedom, death, leadership. |
| `exclude_categories` | string | No | Comma-separated list of categories to exclude. Results won't match any listed categories. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Random Word

**Slug:** `API_NINJAS_GET_RANDOM_WORD`

Tool to get a random English word from the API Ninjas Random Word endpoint. Use when you need random words for games, education, or creative projects. Optionally filter by word type (noun, verb, adjective, adverb).

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `type` | string | No | Filter by word type. Options: noun, verb, adjective, adverb. Leave empty for any type. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Recipe

**Slug:** `API_NINJAS_GET_RECIPE`

Tool to search for recipes by title or ingredients from a database of over 200,000 recipes. Returns up to 10 recipes with ingredients, instructions, servings, and optional nutrition data. Use when you need recipe ideas, cooking instructions, or want to find recipes by specific ingredients.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `title` | string | No | Recipe title to search for. Supports partial matches (e.g., 'pasta' matches 'Pasta Carbonara'). Case-insensitive. |
| `number` | integer | No | Number of recipe results to return. Must be between 1 and 10 (inclusive). Defaults to 1 if not specified. |
| `ingredients` | string | No | Comma-separated list of ingredients to search for. Returns recipes containing the specified ingredients. Case-insensitive. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Convert Coordinates to Location

**Slug:** `API_NINJAS_GET_REVERSE_GEOCODING`

Tool to convert geographic coordinates to location information (reverse geocoding). Returns location name, country code, and state/region for specified coordinates. Use when you need to find address or place information from latitude and longitude.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `lat` | number | Yes | Latitude coordinate in decimal degrees (range: -90 to 90). Required for reverse geocoding. |
| `lon` | number | Yes | Longitude coordinate in decimal degrees (range: -180 to 180). Required for reverse geocoding. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Rhyming Words

**Slug:** `API_NINJAS_GET_RHYMES`

Tool to get words that rhyme with a given word. Use when you need to find rhyming words for creative writing, poetry, or songwriting.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `word` | string | Yes | The word to find rhymes for. Must be a valid English word. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Random Riddles

**Slug:** `API_NINJAS_GET_RIDDLES`

Tool to retrieve random riddles with answers from API Ninjas. Returns one or more riddles suitable for entertainment and brain teasers. Use when you need riddles for games, quizzes, or entertainment purposes.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Number of riddles to return. Must be between 1 and 20. Default is 1. Note: Requesting more than 1 riddle is a Premium only feature. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Sales Tax Rates

**Slug:** `API_NINJAS_GET_SALES_TAX`

Tool to get sales tax rates by ZIP code or city and state. Use when you need current sales tax rate information for a specific US location. Either provide zip_code alone OR city+state together.

#### Input Parameters

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

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get SEC Filing

**Slug:** `API_NINJAS_GET_SEC_FILING`

Tool to retrieve SEC filing information for publicly traded companies. Returns a list of SEC filings including the filing date, form type, and direct URL to the filing document. Use when you need to access company regulatory filings like 10-K annual reports, 10-Q quarterly reports, 8-K current reports, or other SEC documents.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Number of results to return, from 1 to 100. By default, up to 2 results are returned. Use to control response size. |
| `filing` | string | No | SEC filing form type to filter by (e.g., '10-K' for annual reports, '10-Q' for quarterly reports, '8-K' for current reports, 'S-1' for IPO registration, 'DEF14A' for proxy statements). |
| `ticker` | string | No | Ticker symbol of the company to search (e.g., 'AAPL' for Apple, 'MSFT' for Microsoft). Use to filter filings by company stock symbol. |
| `end_date` | string | No | End date to search filings until. Must be in YYYY-MM-DD format (e.g., '2023-12-31'). Use with start_date to define a date range. |
| `start_date` | string | No | Start date to search filings from. Must be in YYYY-MM-DD format (e.g., '2023-04-01'). Use with end_date to define a date range. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get S&P 500 Constituents

**Slug:** `API_NINJAS_GET_SP500_CONSTITUENTS`

Tool to retrieve current S&P 500 index constituents with filtering by ticker, name, sector, or date added. Use when you need information about companies in the S&P 500 index. Returns company details including ticker symbols, names, sectors, CIK numbers, sub-industries, headquarters locations, and dates added to the index.

#### Input Parameters

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

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Star Information

**Slug:** `API_NINJAS_GET_STARS`

Tool to retrieve detailed information about stars including name, constellation, coordinates, magnitude, distance, and spectral classification. Use when you need astronomical data about stars in the known universe. At least one parameter (other than offset) must be provided.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | No | The name of the star to search for. Note that many star names contain Greek characters. |
| `offset` | integer | No | Offset results for pagination. Returns at most 30 results per request. |
| `constellation` | string | No | The constellation that the star belongs to. |
| `spectral_class` | string | No | The spectral classification of the star (e.g., O, B, A, F, G, K, M). |
| `max_absolute_magnitude` | number | No | Maximum absolute magnitude (intrinsic brightness of the star). |
| `max_apparent_magnitude` | number | No | Maximum apparent magnitude (brightness as seen from Earth). Lower values indicate brighter stars. |
| `min_absolute_magnitude` | number | No | Minimum absolute magnitude (intrinsic brightness of the star). |
| `min_apparent_magnitude` | number | No | Minimum apparent magnitude (brightness as seen from Earth). Lower values indicate brighter stars. |
| `max_distance_light_year` | number | No | Maximum distance from Earth in light years. |
| `min_distance_light_year` | number | No | Minimum distance from Earth in light years. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Stock Exchange Information

**Slug:** `API_NINJAS_GET_STOCK_EXCHANGE`

Tool to retrieve stock exchange information by Market Identifier Code (MIC), name, city, or country. Use when you need details about stock exchanges including market data, location, and operational hours.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `mic` | string | No | Market Identifier Code (MIC) to search for a specific stock exchange (e.g., 'XNYS' for New York Stock Exchange, 'XLON' for London Stock Exchange). |
| `city` | string | No | City where the stock exchange is located (e.g., 'New York', 'London', 'Tokyo'). |
| `name` | string | No | Stock exchange name to search for (e.g., 'New York Stock Exchange', 'NASDAQ'). Partial matches are supported. |
| `country` | string | No | 2-letter ISO country code (ISO-3166-1 alpha-2) to filter exchanges by country (e.g., 'US', 'GB', 'JP'). |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Stock Price

**Slug:** `API_NINJAS_GET_STOCK_PRICE`

Tool to get current stock price data for any publicly traded company or index. Use when you need real-time (premium) or 15-minute delayed (free) stock prices, trading volume, and market data by ticker symbol.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `ticker` | string | Yes | Stock or index ticker symbol (e.g., 'AAPL' for Apple, 'GOOGL' for Google, '^DJI' for Dow Jones Industrial Average). Use standard ticker symbols as recognized by major exchanges. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get SWIFT Code

**Slug:** `API_NINJAS_GET_SWIFT_CODE`

Tool to get bank information from SWIFT code or search by bank name, city, or country. Use when you need to look up bank details using a SWIFT/BIC code or search for banks by various criteria. At least one parameter must be provided.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `bank` | string | No | The name of the bank to look up. This parameter supports partial matching (premium only) |
| `city` | string | No | Name of the municipality where the bank operates |
| `swift` | string | No | The SWIFT Code identifier for a specific bank to retrieve |
| `offset` | integer | No | The number of results to offset for pagination. Default is 0 (premium subscriptions only) |
| `country` | string | No | ISO 3166 2-letter country code designation |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Thesaurus

**Slug:** `API_NINJAS_GET_THESAURUS`

Tool to get synonyms and antonyms for an English word. Use when you need to find alternative words with similar or opposite meanings.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `word` | string | Yes | Word to find synonyms and antonyms for. Must be a valid English word. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Ticker

**Slug:** `API_NINJAS_GET_TICKER`

Tool to retrieve comprehensive company profile information for publicly traded companies by stock ticker symbol. Returns executive details, financial metrics, identifiers (CIK, CUSIP, ISIN), exchange, contact information, stock price, market cap, and latest earnings data. Use when you need detailed company information for a specific ticker.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `ticker` | string | Yes | Stock ticker symbol (e.g., 'AAPL', 'MSFT', 'GOOGL') |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Timezone Information

**Slug:** `API_NINJAS_GET_TIMEZONE`

Tool to get timezone information for a location including UTC offset, local time, and timezone name. Use when you need timezone details for geographic locations or IANA timezone names. FREE tier supports timezone parameter; city, state, country, lat, and lon parameters require premium subscription.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `lat` | number | No | Latitude coordinate in decimal degrees (range: -90 to 90). PREMIUM ONLY - requires premium API subscription. Must be used with 'lon' parameter. |
| `lon` | number | No | Longitude coordinate in decimal degrees (range: -180 to 180). PREMIUM ONLY - requires premium API subscription. Must be used with 'lat' parameter. |
| `city` | string | No | City name to get timezone information. PREMIUM ONLY - requires premium API subscription. |
| `state` | string | No | US state name or abbreviation (only for US cities). PREMIUM ONLY - requires premium API subscription. |
| `country` | string | No | Country code (ISO 3166 alpha-2) or country name. PREMIUM ONLY - requires premium API subscription. |
| `timezone` | string | No | IANA timezone name (e.g., 'America/New_York', 'Europe/London', 'Asia/Tokyo'). Available in FREE tier. Use this to get timezone details by direct timezone name lookup. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Trivia Questions

**Slug:** `API_NINJAS_GET_TRIVIA`

Tool to retrieve trivia questions by category from API Ninjas. Returns trivia questions with answers from various categories like music, sports, science, and more. Use when you need trivia questions for games, quizzes, or entertainment purposes.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Number of trivia questions to return. Must be between 1 and 30. Default is 1. Note: Requesting more than 1 question is a premium feature. |
| `category` | string ("artliterature" | "language" | "sciencenature" | "general" | "fooddrink" | "peopleplaces" | "geography" | "historyholidays" | "entertainment" | "toysgames" | "music" | "mathematics" | "religionmythology" | "sportsleisure") | No | Valid trivia categories for API Ninjas trivia endpoint. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Trivia of the Day

**Slug:** `API_NINJAS_GET_TRIVIA_OF_THE_DAY`

Tool to retrieve the trivia question of the day from API Ninjas. Returns the same trivia question for all users on a given day, with questions changing daily. Use when you need a daily trivia question to display or share.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Unemployment Rate

**Slug:** `API_NINJAS_GET_UNEMPLOYMENT`

Tool to get unemployment rate data for countries. Use when you need historical or current unemployment statistics by country or year.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `year` | integer | No | Year for which to retrieve unemployment data. At least one of country or year must be provided. |
| `country` | string | No | Country name (case-insensitive) or 2-letter ISO-3166 alpha-2 code. Examples: 'Canada' or 'CA', 'United States' or 'US'. At least one of country or year must be provided. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get University Information

**Slug:** `API_NINJAS_GET_UNIVERSITY`

Tool to retrieve university information by name or country. Use when you need details about universities in the USA or Canada including location, contact info, enrollment, tuition, and degree programs offered. At least one search parameter (name or country) is required.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | No | Name of the university to search for. Can be a partial match (e.g., 'Harvard', 'MIT', 'Stanford'). |
| `limit` | integer | No | Number of results to return (range: 1-30 for premium, max 5 for free tier). |
| `offset` | integer | No | Pagination offset to skip the first N results. Premium feature. |
| `country` | string | No | Country where university is located. Must be 'USA' or 'Canada'. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get URL Location Info

**Slug:** `API_NINJAS_GET_URL_LOOKUP`

Tool to get location information for a URL domain. Returns geolocation data including country, region, city, coordinates, ISP, and timezone. Use when you need to identify the geographic location or hosting provider of a URL.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `url` | string | Yes | Valid URL to check. It supports schemes (e.g., http://example.com) as well as schemeless formats (e.g., example.com). |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Current Weather

**Slug:** `API_NINJAS_GET_WEATHER`

Tool to retrieve current weather data for a location. Use when you need real-time weather information including temperature, humidity, wind conditions, and sunrise/sunset times. Query by city name or GPS coordinates.

#### Input Parameters

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

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Weather Forecast

**Slug:** `API_NINJAS_GET_WEATHER_FORECAST`

Tool to retrieve 5-day weather forecast in 3-hour intervals for a location. Use when you need future weather predictions including temperature, humidity, wind, and sunrise/sunset times. Query by GPS coordinates or city name.

#### Input Parameters

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

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get WHOIS Information

**Slug:** `API_NINJAS_GET_WHOIS`

Tool to get WHOIS domain registration information including registrar, creation date, and expiration date. Use when you need details about domain registration.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `domain` | string | Yes | Domain name to look up WHOIS information for (e.g., example.com). Top-level domains other than .com require a premium subscription. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Working Days

**Slug:** `API_NINJAS_GET_WORKING_DAYS`

Tool to get working days for a specific country and time period. Returns the count and list of working days, accounting for weekends and public holidays. Use when you need to calculate business days, plan schedules, or determine operational days for a country.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `year` | integer | No | Calendar year between 1980 and 2050 (inclusive). Defaults to current year if not specified. |
| `month` | integer | No | Month number (1-12). If specified, returns working days for that specific month only. |
| `country` | string | Yes | Country code (2-letter ISO 3166-1 alpha-2 code, e.g., 'US' for United States, 'GB' for United Kingdom). |
| `weekend` | string | No | Comma-separated list of weekend days (mon,tue,wed,thu,fri,sat,sun). Overrides default weekend days for the country. |
| `public_holidays` | boolean | No | Whether to include public holidays as non-working days. Defaults to true if not specified. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get World Time

**Slug:** `API_NINJAS_GET_WORLDTIME`

Tool to get current date and time for a location with detailed date/time components. Returns timezone, datetime, date, year, month, day, hour, minute, second, and day of the week. Use when you need detailed time information for a specific location or timezone.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `lat` | number | No | Latitude coordinate in decimal degrees (range: -90 to 90). PREMIUM ONLY - requires premium API subscription. Must be used with 'lon' parameter. |
| `lon` | number | No | Longitude coordinate in decimal degrees (range: -180 to 180). PREMIUM ONLY - requires premium API subscription. Must be used with 'lat' parameter. |
| `city` | string | No | City name to get current time. PREMIUM ONLY - requires premium API subscription. Can be combined with state and country for more precise results. |
| `timezone` | string | No | IANA timezone identifier (e.g., 'America/New_York', 'Europe/London', 'Asia/Tokyo'). Available in FREE tier. Use this to get current time by timezone name. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get US Zipcode Location Info

**Slug:** `API_NINJAS_GET_ZIPCODE`

Tool to retrieve location information for US zip codes. Returns city, state, county, coordinates, timezone, and area codes. Use when you need to find location details for a zip code or search by city/state.

#### Input Parameters

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

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### IBAN Lookup

**Slug:** `API_NINJAS_IBAN_LOOKUP`

Tool to look up and validate an International Bank Account Number (IBAN). Use when you have an IBAN and need to retrieve its components (country, bank code, account number, etc.) and its validity.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `iban` | string | Yes | International Bank Account Number to look up |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Income Tax Calculator

**Slug:** `API_NINJAS_INCOME_TAX_CALCULATOR`

Tool to calculate income taxes for US and Canada. Use when you need detailed breakdown of federal, state/provincial, and FICA taxes. Country and region codes must be correct.

#### Input Parameters

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

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Inflation Data

**Slug:** `API_NINJAS_INFLATION`

Tool to get current inflation data for a country. Use when you need latest CPI or HICP monthly and annual inflation rates.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `type` | string ("CPI" | "HICP") | No | Inflation indicator type. 'CPI' = Consumer Price Index (standard national measure). 'HICP' = Harmonized Index of Consumer Prices (EU standardized measure for cross-country comparison). Defaults to 'CPI' if not specified. |
| `country` | string | No | Name of country (case-insensitive). If omitted, returns data for all available countries. Free tier includes: Austria, Belgium, Bulgaria, Canada, Chile, Estonia, Germany, Hungary, Iceland, Ireland, Luxembourg, Norway, Portugal, Slovakia, Sweden, Switzerland, The Netherlands. Some countries (e.g., United States) require premium subscription. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Interest Rate

**Slug:** `API_NINJAS_INTEREST_RATE`

Tool to get current interest rates for central banks and benchmarks. Use when you need to fetch the latest interest rate for a specific country or all available countries.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `country` | string | No | Country name to filter by. Use underscore for multi-word names (e.g., 'United_States'). If omitted, returns rates for all available countries. Supported countries include: United_States, Australia, United_Kingdom, Chile, China, Czech_Republic, Denmark, Japan, Mexico, New_Zealand, Norway, Poland, Russia, Saudi_Arabia, South_Africa, South_Korea, Sweden, Switzerland, Türkiye. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Stock Tickers

**Slug:** `API_NINJAS_LIST_STOCK_TICKERS`

Tool to retrieve a paginated list of all available stock ticker symbols and company names. Use when you need to browse available stocks or find ticker symbols for specific companies. Returns company tickers and names with pagination support.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | Yes | Number of results to return. Must be between 1 and 1000. |
| `offset` | integer | Yes | Number of results to offset for pagination. Must be provided (use 0 for first page). |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### VIN Lookup

**Slug:** `API_NINJAS_LOOKUP_VIN`

Tool to decode Vehicle Identification Number (VIN) and retrieve vehicle information. Returns make, model, year, manufacturing country, and VIN components. Use when you need to identify vehicle specifications from a 17-character VIN.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `vin` | string | Yes | 17-character Vehicle Identification Number to decode |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Market Cap

**Slug:** `API_NINJAS_MARKET_CAP`

Tool to get real-time market cap data for a company. Use when you need up-to-date market capitalization by specifying the stock ticker. Example: "What is the market cap of NVDA?"

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `ticker` | string | Yes | Stock ticker symbol, e.g., 'NVDA' |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Mortgage Rate

**Slug:** `API_NINJAS_MORTGAGE_RATE`

Tool to get current and historical mortgage rates. Use when you need weekly fixed-rate mortgage data, optionally for specific dates or date ranges.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `date` | string | No | Individual date to query in YYYY-MM-DD format. Premium-only; returns the week matching this date. |
| `max_date` | string | No | Maximum date in YYYY-MM-DD format for range query (must be used with min_date). Premium-only. |
| `min_date` | string | No | Minimum date in YYYY-MM-DD format for range query (must be used with max_date). Premium-only. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Extract Nutrition Information

**Slug:** `API_NINJAS_NUTRITION`

Tool to extract nutrition information from text query. Use when you need to parse food-related text (e.g., recipes, menus) to calculate corresponding nutrition data.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `query` | string | Yes | Text to extract nutrition information from. Specify quantities if needed (e.g., '1lb brisket and fries'). |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Scrape Website Content

**Slug:** `API_NINJAS_SCRAPE_WEBSITE`

Tool to scrape HTML content from a URL using the API Ninjas Webscraper endpoint. Use when you need to retrieve website content programmatically without dealing with browser automation.

#### Input Parameters

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

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Solve Sudoku Puzzle

**Slug:** `API_NINJAS_SOLVE_SUDOKU`

Tool to solve a Sudoku puzzle using the API Ninjas Sudoku Solver. Takes a partially filled puzzle grid and returns the complete solution if one exists. Use when you need to solve standard or custom-sized Sudoku puzzles (2x2, 3x3, or 4x4 box dimensions).

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `width` | integer | Yes | Width of each box in the Sudoku grid. Must be between 2 and 4. For standard 9x9 Sudoku, use width=3. |
| `height` | integer | Yes | Height of each box in the Sudoku grid. Must be between 2 and 4. For standard 9x9 Sudoku, use height=3. |
| `puzzle` | string | Yes | 2D JSON array representing the Sudoku puzzle. Use 0 for empty cells. Must be passed as JSON string (e.g., '[[0,0,0,2,6,0,7,0,1],[6,8,0,0,7,0,0,9,0],...]'). |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Validate Email

**Slug:** `API_NINJAS_VALIDATE_EMAIL`

Tool to validate email address format and check deliverability. Returns validity status, domain info, MX records, disposability check, and email role categorization. Use when you need to verify if an email address is valid and deliverable before sending communications.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `email` | string | Yes | Email address to validate and check deliverability. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Validate EU VAT

**Slug:** `API_NINJAS_VALIDATE_EU_VAT`

Tool to retrieve and validate EU VAT (Value Added Tax) rates by country code. Use when you need current or historical VAT rates for EU member states, with optional filtering by VAT type, date range, or specific categories.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `type` | string ("standard" | "reduced" | "super_reduced" | "exempted" | "parking") | No | Enumeration of VAT rate classifications. |
| `limit` | integer | No | Number of results to return. Must be between 1 and 30. Default is 5. Premium accounts only. |
| `offset` | integer | No | Number of results to skip for pagination. Default is 0. Use with limit to paginate through results. Premium accounts only. |
| `country` | string | Yes | Two-letter ISO 3166-1 alpha-2 country code for EU nations (e.g., 'FR' for France, 'DE' for Germany, 'NL' for Netherlands). |
| `max_date` | string | No | Filter results to only include VAT rates effective before this date. Must be in YYYY-MM-DD format (e.g., '2024-12-31'). |
| `min_date` | string | No | Filter results to only include VAT rates effective after this date. Must be in YYYY-MM-DD format (e.g., '2020-01-01'). |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Validate Phone Number

**Slug:** `API_NINJAS_VALIDATE_PHONE`

Tool to validate and format phone numbers. Returns validity status, country code, carrier information, and normalized E.164 format. Use when you need to verify phone number validity or retrieve phone metadata.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `number` | string | Yes | Phone number to validate, including country code. Should be in international format with country code prefix (e.g., +12065550100). The API accepts various formats and will normalize to E.164 standard. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Validate Routing Number

**Slug:** `API_NINJAS_VALIDATE_ROUTING_NUMBER`

Tool to validate and retrieve bank information from a routing number. Use when you need to verify a 9-digit routing number and get associated bank details including name, location, and contact information.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `routing_number` | string | Yes | A 9-digit bank routing number to validate and look up |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |