API Ninjas

{
  "type": "object",
  "required": [],
  "properties": {
    "zip": {
      "type": "string",
      "description": "The ZIP Code to look up."
    },
    "city": {
      "type": "string",
      "description": "Full name of the city to search (case-sensitive). Premium subscribers only."
    },
    "state": {
      "type": "string",
      "description": "2-letter abbreviation of the state (case-insensitive). Premium subscribers only."
    }
  }
}

{
  "type": "object",
  "required": [
    "from",
    "to"
  ],
  "properties": {
    "to": {
      "type": "string",
      "description": "Destination airport - IATA (3 chars) or ICAO (4 chars) code."
    },
    "from": {
      "type": "string",
      "description": "Origin airport - IATA (3 chars) or ICAO (4 chars) code."
    },
    "units": {
      "enum": [
        "km",
        "mi",
        "nm"
      ],
      "type": "string",
      "default": "km",
      "description": "Distance units. Default is km."
    }
  }
}

{
  "type": "object",
  "required": [
    "q"
  ],
  "properties": {
    "q": {
      "type": "string",
      "minLength": 2,
      "description": "Query string. Must be at least 2 characters."
    },
    "size": {
      "enum": [
        "large",
        "medium",
        "small"
      ],
      "type": "string",
      "description": "Restrict results to a size."
    },
    "limit": {
      "type": "integer",
      "default": 3,
      "maximum": 3,
      "minimum": 1,
      "description": "Maximum number of results to return. Must be between 1 and 3. Default is 3."
    },
    "country": {
      "type": "string",
      "description": "Restrict results to a country. Must be a 2-character ISO country code."
    }
  }
}

{
  "type": "object",
  "required": [
    "text"
  ],
  "properties": {
    "text": {
      "type": "string",
      "maxLength": 2000,
      "description": "Query text for sentiment analysis. Maximum 2000 characters."
    }
  }
}

{
  "type": "object",
  "required": [
    "bin"
  ],
  "properties": {
    "bin": {
      "type": "string",
      "description": "The Bank Identification Number (BIN) to look up. This is typically the first 6-8 digits of a credit card number."
    }
  }
}

{
  "type": "object",
  "required": [
    "amount"
  ],
  "properties": {
    "city": {
      "type": "string",
      "description": "City name."
    },
    "state": {
      "type": "string",
      "description": "State name."
    },
    "amount": {
      "type": "number",
      "format": "float",
      "description": "Purchase amount to calculate tax on."
    },
    "zip_code": {
      "type": "string",
      "description": "Valid US ZIP code."
    },
    "street_address": {
      "type": "string",
      "description": "Street address (e.g. 9641 Sunset Blvd). Used together with city and state for the most accurate lookup."
    }
  }
}

{
  "type": "object",
  "required": [
    "email"
  ],
  "properties": {
    "email": {
      "type": "string",
      "format": "email",
      "description": "The email address to check."
    }
  }
}

{
  "type": "object",
  "required": [
    "description"
  ],
  "properties": {
    "year": {
      "enum": [
        "2022"
      ],
      "type": "string",
      "default": "2022",
      "description": "NAICS revision. Currently 2022 only; NAICS 2027 is not published by the Census Bureau until January 2027."
    },
    "description": {
      "type": "string",
      "description": "Free-text description of the business or establishment to classify. Limited to 2000 characters."
    },
    "min_confidence": {
      "type": "number",
      "maximum": 1,
      "minimum": 0,
      "description": "Suppress results below this confidence."
    },
    "include_alternatives": {
      "type": "boolean",
      "default": true,
      "description": "Include rejected candidate codes and the rule that rejected each."
    }
  }
}

{
  "type": "object",
  "required": [
    "lat",
    "lon"
  ],
  "properties": {
    "lat": {
      "type": "number",
      "format": "double",
      "maximum": 90,
      "minimum": -90,
      "description": "Latitude of the search center, in decimal degrees."
    },
    "lon": {
      "type": "number",
      "format": "double",
      "maximum": 180,
      "minimum": -180,
      "description": "Longitude of the search center, in decimal degrees."
    },
    "size": {
      "enum": [
        "large",
        "medium",
        "small"
      ],
      "type": "string",
      "description": "Restrict to airport size."
    },
    "limit": {
      "type": "integer",
      "default": 10,
      "maximum": 50,
      "minimum": 1,
      "description": "Maximum number of results to return. Must be between 1 and 50. Default is 10."
    },
    "units": {
      "enum": [
        "km",
        "mi"
      ],
      "type": "string",
      "default": "km",
      "description": "Distance units. Default is km."
    },
    "radius": {
      "type": "number",
      "format": "double",
      "default": 50,
      "maximum": 500,
      "minimum": 1,
      "description": "Search radius in kilometres. Default is 50, maximum is 500."
    },
    "has_iata": {
      "enum": [
        "true",
        "false"
      ],
      "type": "string",
      "description": "Filter by whether the airport has an IATA code."
    },
    "min_runway_length": {
      "type": "integer",
      "description": "Minimum runway length in feet."
    }
  }
}

{
  "type": "object",
  "required": [
    "text_1",
    "text_2"
  ],
  "properties": {
    "text_1": {
      "type": "string",
      "maxLength": 5000,
      "description": "First input text. Maximum 5000 characters."
    },
    "text_2": {
      "type": "string",
      "maxLength": 5000,
      "description": "Second input text. Maximum 5000 characters."
    }
  }
}

{
  "type": "object",
  "required": [],
  "properties": {
    "code": {
      "type": "string",
      "description": "Auto-detected IATA (3 chars) or ICAO (4 chars) code. Exactly one of iata, icao, or code must be provided."
    },
    "iata": {
      "type": "string",
      "description": "3-character IATA airport code. Exactly one of iata, icao, or code must be provided."
    },
    "icao": {
      "type": "string",
      "description": "4-character ICAO airport code. Exactly one of iata, icao, or code must be provided."
    }
  }
}

{
  "type": "object",
  "required": [
    "have",
    "want",
    "amount"
  ],
  "properties": {
    "have": {
      "type": "string",
      "description": "Currency you currently hold. Must be 3-character currency code (e.g. USD)."
    },
    "want": {
      "type": "string",
      "description": "Currency you want to convert to. Must be 3-character currency code (e.g. USD)."
    },
    "amount": {
      "type": "number",
      "description": "Amount of currency to convert."
    }
  }
}

{
  "type": "object",
  "required": [
    "amount",
    "unit"
  ],
  "properties": {
    "unit": {
      "type": "string",
      "description": "The source unit to convert from. Spaces should be replaced with underscores."
    },
    "amount": {
      "type": "number",
      "description": "The numerical value to convert."
    }
  }
}

{
  "type": "object",
  "required": [
    "image"
  ],
  "properties": {
    "image": {
      "type": "string",
      "format": "binary",
      "description": "Image file to be analyzed"
    }
  }
}

{
  "type": "object",
  "required": [
    "text"
  ],
  "properties": {
    "text": {
      "type": "string",
      "maxLength": 1000,
      "description": "Input text (10 words or more recommended). Maximum 1000 characters."
    }
  }
}

{
  "type": "object",
  "required": [
    "image"
  ],
  "properties": {
    "image": {
      "type": "string",
      "format": "binary",
      "description": "Image file. Must be either JPEG or PNG format and smaller than 2000 by 2000."
    }
  }
}

{
  "type": "object",
  "required": [
    "text"
  ],
  "properties": {
    "text": {
      "type": "string",
      "maxLength": 5000,
      "description": "Query text to embed. Maximum 5000 characters."
    }
  }
}

{
  "type": "object",
  "required": [
    "image"
  ],
  "properties": {
    "image": {
      "type": "string",
      "format": "binary",
      "description": "Image file to extract text from. Must be either JPEG or PNG format."
    }
  }
}

{
  "type": "object",
  "required": [
    "text"
  ],
  "properties": {
    "text": {
      "type": "string",
      "maxLength": 1000,
      "description": "Input text. Maximum 1000 characters."
    }
  }
}

{
  "type": "object",
  "required": [],
  "properties": {
    "bank": {
      "type": "string",
      "description": "The name of the bank to look up. This parameter supports partial matching (e.g., Silicon Valley will match Silicon Valley Bank). Premium only."
    },
    "city": {
      "type": "string",
      "description": "Name of the city in which the bank is located."
    },
    "swift": {
      "type": "string",
      "description": "The SWIFT Code of the bank to look up."
    },
    "offset": {
      "type": "integer",
      "default": 0,
      "description": "The number of results to offset for pagination. Default is 0. Annual premium subscriptions only."
    },
    "country": {
      "type": "string",
      "description": "ISO 3166 2-letter country code of the bank's country."
    },
    "routing_number": {
      "type": "string",
      "description": "9-digit US ABA routing number. Returns the SWIFT/BIC codes of the US bank identified by the routing number. Available for Business and Professional subscribers only."
    }
  }
}

{
  "type": "object",
  "required": [
    "text"
  ],
  "properties": {
    "text": {
      "type": "string",
      "description": "Text to encode in the barcode."
    },
    "type": {
      "enum": [
        "code39",
        "code128",
        "ean",
        "ean13",
        "ean8",
        "gs1",
        "gtin",
        "isbn",
        "isbn10",
        "isbn13",
        "issn",
        "jan",
        "pzn",
        "upc",
        "upca"
      ],
      "type": "string",
      "default": "upc",
      "description": "Type of barcode to generate."
    },
    "format": {
      "enum": [
        "png",
        "svg"
      ],
      "type": "string",
      "default": "png",
      "description": "Image format to return."
    },
    "include_text": {
      "type": "boolean",
      "default": true,
      "description": "Whether to include the text below the barcode."
    }
  }
}

{
  "type": "object",
  "required": [],
  "properties": {
    "random": {
      "type": "boolean",
      "default": true,
      "description": "Whether to randomly generate paragraphs. Must be either true or false. If unset, a default value of true will be used."
    },
    "max_length": {
      "type": "integer",
      "default": 1000,
      "description": "Maximum character length."
    },
    "paragraphs": {
      "type": "integer",
      "default": 1,
      "description": "Number of paragraphs to generate. If unset, a default value of 1 will be used."
    },
    "start_with_lorem_ipsum": {
      "type": "boolean",
      "default": true,
      "description": "Whether to begin the text with the words 'Lorem ipsum'. Must be either true or false. If unset, a default value of true will be used."
    }
  }
}

{
  "type": "object",
  "required": [],
  "properties": {
    "length": {
      "type": "integer",
      "default": 16,
      "description": "Length of password in characters. If not set, a default value of 16 is used."
    },
    "exclude_numbers": {
      "type": "boolean",
      "default": false,
      "description": "Whether to exclude numbers from the password. Must be either true or false. If not set, a default value of false will be used."
    },
    "exclude_special_chars": {
      "type": "boolean",
      "default": false,
      "description": "Whether to exclude special characters(!@#$%^&*()) from the password. Must be either true or false. If not set, a default value of false will be used."
    }
  }
}

{
  "type": "object",
  "required": [
    "data",
    "format"
  ],
  "properties": {
    "data": {
      "type": "string",
      "description": "Data to encode in the QR code."
    },
    "size": {
      "type": "integer",
      "default": 250,
      "description": "Size of the QR code image to generate. The output will be a square image with (size x size) dimensions. The default size is 250."
    },
    "format": {
      "enum": [
        "png",
        "jpg",
        "jpeg",
        "eps",
        "svg"
      ],
      "type": "string",
      "description": "Image format to return. Must be one of the following: png, jpg, jpeg, eps, svg."
    },
    "bg_color": {
      "type": "string",
      "default": "ffffff",
      "pattern": "^[0-9a-fA-F]{6}$",
      "description": "Background color of the QR code. Must be a 6-digit hex color (e.g. 00ff00 for green). Default is ffffff (white)."
    },
    "fg_color": {
      "type": "string",
      "default": "000000",
      "pattern": "^[0-9a-fA-F]{6}$",
      "description": "Foreground color of the QR code. Must be a 6-digit hex color (e.g. 00ff00 for green). Default is 000000 (black)."
    }
  }
}

{
  "type": "object",
  "required": [],
  "properties": {
    "seed": {
      "type": "string",
      "description": "Seed value for reproducible puzzle generation."
    },
    "width": {
      "type": "integer",
      "default": 3,
      "maximum": 4,
      "minimum": 2,
      "description": "Width of each box in the Sudoku grid. Default is 3. Must be between 2 and 4."
    },
    "height": {
      "type": "integer",
      "default": 3,
      "maximum": 4,
      "minimum": 2,
      "description": "Height of each box in the Sudoku grid. Default is 3. Must be between 2 and 4."
    },
    "difficulty": {
      "enum": [
        "easy",
        "medium",
        "hard"
      ],
      "type": "string",
      "default": "medium",
      "description": "Difficulty level of the puzzle. Possible values: easy, medium, hard. Default is medium."
    }
  }
}

{
  "type": "object",
  "required": [],
  "properties": {
    "os": {
      "type": "string",
      "description": "Operating system (e.g. Windows, iOS, Android)"
    },
    "brand": {
      "type": "string",
      "description": "Device brand (e.g. Apple, Samsung)"
    },
    "model": {
      "type": "string",
      "description": "Device model (e.g. iPhone, Galaxy)"
    },
    "browser": {
      "type": "string",
      "description": "Browser name (e.g. Chrome, Firefox, Safari)"
    }
  }
}

{
  "type": "object",
  "required": [],
  "properties": {}
}

{
  "type": "object",
  "required": [],
  "properties": {
    "lat": {
      "type": "string",
      "description": "Latitude of desired location."
    },
    "lon": {
      "type": "string",
      "description": "Longitude of desired location."
    },
    "city": {
      "type": "string",
      "description": "City name. Premium only."
    },
    "state": {
      "type": "string",
      "description": "US state (for United States cities only). Premium only."
    },
    "country": {
      "type": "string",
      "description": "Country name. Premium only."
    }
  }
}

{
  "type": "object",
  "required": [],
  "properties": {
    "iata": {
      "type": "string",
      "description": "International Air Transport Association (IATA) 2-character airline code. At least one of icao, iata, or name must be set."
    },
    "icao": {
      "type": "string",
      "description": "International Civil Aviation Organization (ICAO) 3-character airline code. At least one of icao, iata, or name must be set."
    },
    "name": {
      "type": "string",
      "description": "Airline name. This parameter supports partial matching (e.g. United will match United Airlines). At least one of icao, iata, or name must be set."
    }
  }
}

{
  "type": "object",
  "required": [],
  "properties": {
    "offset": {
      "type": "integer",
      "default": 0,
      "description": "Number of results to offset for pagination. Default is 0. Premium only."
    }
  }
}

{
  "type": "object",
  "required": [],
  "properties": {}
}

{
  "type": "object",
  "required": [],
  "properties": {}
}

{
  "type": "object",
  "required": [],
  "properties": {}
}

{
  "type": "object",
  "required": [],
  "properties": {}
}

{
  "type": "object",
  "required": [
    "muscle"
  ],
  "properties": {
    "limit": {
      "type": "integer",
      "default": 10,
      "maximum": 100,
      "description": "Maximum number of results to return. Default is 10, maximum is 100."
    },
    "muscle": {
      "enum": [
        "abdominals",
        "abductors",
        "adductors",
        "biceps",
        "calves",
        "chest",
        "forearms",
        "glutes",
        "hamstrings",
        "lats",
        "lower_back",
        "middle_back",
        "neck",
        "quadriceps",
        "traps",
        "triceps"
      ],
      "type": "string",
      "description": "Muscle group targeted by the exercise."
    },
    "offset": {
      "type": "integer",
      "default": 0,
      "description": "Number of results to offset for pagination. Default is 0."
    }
  }
}

{
  "type": "object",
  "required": [],
  "properties": {}
}

{
  "type": "object",
  "required": [
    "api_key"
  ],
  "properties": {
    "api_key": {
      "type": "string",
      "description": "Your API Key. This is passed as a query parameter instead of in the header for this endpoint."
    }
  }
}

{
  "type": "object",
  "required": [
    "name"
  ],
  "properties": {
    "name": {
      "type": "string",
      "description": "Common name of animal to search. This parameter supports partial matches."
    }
  }
}

{
  "type": "object",
  "required": [],
  "properties": {
    "gender": {
      "enum": [
        "boy",
        "girl",
        "neutral"
      ],
      "type": "string",
      "description": "Baby name gender. Must be one of the following: boy, girl, neutral"
    },
    "popular_only": {
      "type": "boolean",
      "default": true,
      "description": "Whether to only return popular (top 10%) of names. Must be either true or false. If unset, default is true."
    }
  }
}

{
  "type": "object",
  "required": [],
  "properties": {
    "cik": {
      "type": "string",
      "description": "Company Central Index Key (e.g., 796343). Either ticker or cik must be provided."
    },
    "year": {
      "type": "integer",
      "description": "Fiscal year (e.g., 2025). Must be a valid year after 2000. Historical data before the previous year requires a premium subscription. If set, period must also be set."
    },
    "period": {
      "enum": [
        "q1",
        "q2",
        "q3",
        "q4",
        "fy"
      ],
      "type": "string",
      "description": "Fiscal period. Must be one of: q1, q2, q3, q4, or fy (full year). If set, year must also be set."
    },
    "ticker": {
      "type": "string",
      "description": "Company ticker symbol (e.g., ADBE). Either ticker or cik must be provided."
    }
  }
}

{
  "type": "object",
  "required": [],
  "properties": {
    "cik": {
      "type": "string",
      "description": "Company Central Index Key (e.g., 796343). Either ticker or cik must be provided."
    },
    "ticker": {
      "type": "string",
      "description": "Company ticker symbol (e.g., ADBE). Either ticker or cik must be provided."
    }
  }
}

{
  "type": "object",
  "required": [
    "country"
  ],
  "properties": {
    "year": {
      "type": "integer",
      "maximum": 2050,
      "minimum": 1980,
      "description": "Calendar year between 1980 and 2050 (inclusive). Defaults to the current year. Free plans can omit it or pass the current year; other years are for premium subscribers only. Most countries cover 1980-2050; a year outside a country's range returns a 400 error listing the available years."
    },
    "country": {
      "type": "string",
      "description": "Country as a 2-letter ISO 3166-1 alpha-2 code (preferred, e.g. `US`), a 3-letter alpha-3 code (e.g. `USA`) or an English country name (e.g. `United States`). Not case-sensitive. Names must match exactly; common short names such as `UK`, `USA`, `UAE` and `South Korea` also work. An unrecognized country, or one without bank holiday data, returns a 400 error."
    }
  }
}

{
  "type": "object",
  "required": [
    "routing_number"
  ],
  "properties": {
    "routing_number": {
      "type": "string",
      "description": "The 9-digit routing number of the bank to look up."
    }
  }
}

{
  "type": "object",
  "required": [],
  "properties": {}
}

{
  "type": "object",
  "required": [],
  "properties": {
    "end": {
      "type": "integer",
      "description": "End timestamp in Unix format (in seconds)."
    },
    "limit": {
      "type": "integer",
      "default": 100,
      "maximum": 1000,
      "description": "Maximum number of data points to return."
    },
    "start": {
      "type": "integer",
      "description": "Start timestamp in Unix format (in seconds)."
    },
    "interval": {
      "enum": [
        "1m",
        "5m",
        "15m",
        "30m",
        "1h",
        "4h",
        "1d"
      ],
      "type": "string",
      "default": "5m",
      "description": "Time interval between data points."
    }
  }
}

{
  "type": "object",
  "required": [
    "bsb"
  ],
  "properties": {
    "bsb": {
      "type": "string",
      "description": "The 6-digit Australian BSB number, with or without a hyphen (e.g. 062-000 or 062000)."
    }
  }
}

{
  "type": "object",
  "required": [],
  "properties": {}
}

{
  "type": "object",
  "required": [],
  "properties": {
    "routing_number": {
      "type": "string",
      "description": "The 9-digit Canadian routing number in EFT format (0AAATTTTT). At least one of routing_number, or both transit_number and institution_number together, must be set."
    },
    "transit_number": {
      "type": "string",
      "description": "The 5-digit branch transit number. Must be used together with institution_number."
    },
    "institution_number": {
      "type": "string",
      "description": "The 3-digit financial institution number. Must be used together with transit_number."
    }
  }
}

{
  "type": "object",
  "required": [],
  "properties": {
    "make": {
      "type": "string",
      "description": "Manufacturer, as a word. Case and punctuation are ignored, so bmw, BMW and Bmw all resolve."
    },
    "year": {
      "type": "integer",
      "description": "Only generations in production in this year."
    },
    "limit": {
      "type": "integer",
      "default": 30,
      "maximum": 100,
      "minimum": 1,
      "description": "How many results to return, between 1 and 100. Default 30. A value outside that range is rejected rather than silently clamped."
    },
    "model": {
      "type": "string",
      "description": "Model, as a word. '3 Series', '3-series' and '3series' all resolve."
    },
    "offset": {
      "type": "integer",
      "default": 0,
      "minimum": 0,
      "description": "Number of results to skip, for pagination. Default 0."
    },
    "has_cars": {
      "type": "boolean",
      "description": "Set true to omit generations that have no cars."
    },
    "chassis_code": {
      "type": "string",
      "description": "Filter to one chassis code, e.g. E91. Matches anything whose chassis_codes contains it."
    }
  }
}

{
  "type": "object",
  "required": [],
  "properties": {
    "year": {
      "type": "integer",
      "description": "Only manufacturers with a car in production in this year."
    },
    "limit": {
      "type": "integer",
      "default": 30,
      "maximum": 100,
      "minimum": 1,
      "description": "How many results to return, between 1 and 100. Default 30. A value outside that range is rejected rather than silently clamped."
    },
    "offset": {
      "type": "integer",
      "default": 0,
      "minimum": 0,
      "description": "Number of results to skip, for pagination. Default 0."
    },
    "search": {
      "type": "string",
      "description": "Case-insensitive substring match on the manufacturer name."
    }
  }
}

{
  "type": "object",
  "required": [],
  "properties": {
    "make": {
      "type": "string",
      "description": "Manufacturer, as a word. Case and punctuation are ignored, so bmw, BMW and Bmw all resolve."
    },
    "year": {
      "type": "integer",
      "description": "Only models with a car in production in this year."
    },
    "limit": {
      "type": "integer",
      "default": 30,
      "maximum": 100,
      "minimum": 1,
      "description": "How many results to return, between 1 and 100. Default 30. A value outside that range is rejected rather than silently clamped."
    },
    "offset": {
      "type": "integer",
      "default": 0,
      "minimum": 0,
      "description": "Number of results to skip, for pagination. Default 0."
    },
    "search": {
      "type": "string",
      "description": "Case-insensitive substring match on the model name."
    }
  }
}

{
  "type": "object",
  "required": [],
  "properties": {
    "cik": {
      "type": "string",
      "description": "Company Central Index Key (e.g., 796343). Either ticker or cik must be provided."
    },
    "year": {
      "type": "integer",
      "description": "Fiscal year (e.g., 2025). Must be a valid year after 2000. Historical data before the previous year requires a premium subscription. If set, period must also be set."
    },
    "period": {
      "enum": [
        "q1",
        "q2",
        "q3",
        "q4",
        "fy"
      ],
      "type": "string",
      "description": "Fiscal period. Must be one of: q1, q2, q3, q4, or fy (full year). If set, year must also be set."
    },
    "ticker": {
      "type": "string",
      "description": "Company ticker symbol (e.g., ADBE). Either ticker or cik must be provided."
    }
  }
}

{
  "type": "object",
  "required": [],
  "properties": {
    "cik": {
      "type": "string",
      "description": "Company Central Index Key (e.g., 796343). Either ticker or cik must be provided."
    },
    "ticker": {
      "type": "string",
      "description": "Company ticker symbol (e.g., ADBE). Either ticker or cik must be provided."
    }
  }
}

{
  "type": "object",
  "required": [],
  "properties": {
    "name": {
      "type": "string",
      "description": "Name of the celebrity you wish to search. This field is case-insensitive."
    },
    "offset": {
      "type": "integer",
      "description": "Number of results to offset for pagination. Premium only."
    },
    "max_height": {
      "type": "number",
      "format": "float",
      "description": "Maximum height of celebrities in meters (e.g. 1.80)."
    },
    "min_height": {
      "type": "number",
      "format": "float",
      "description": "Minimum height of celebrities in meters (e.g. 1.65)."
    },
    "nationality": {
      "type": "string",
      "description": "Nationality of celebrities. Must be an ISO 3166 Alpha-2 country code (e.g. US)."
    },
    "max_net_worth": {
      "type": "integer",
      "description": "Maximum net worth of celebrities."
    },
    "min_net_worth": {
      "type": "integer",
      "description": "Minimum net worth of celebrities."
    }
  }
}

{
  "type": "object",
  "required": [],
  "properties": {
    "safe": {
      "type": "boolean",
      "default": false,
      "description": "Premium subscribers only. Set safe=true to exclude jokes flagged as sexually explicit, crude, or containing profanity, slurs, or offensive content. Defaults to false, so results are unfiltered unless you opt in. Filtering is best-effort and not a guarantee. Any value other than true/false returns an error, as does using this parameter on a free account."
    }
  }
}

{
  "type": "object",
  "required": [],
  "properties": {
    "symbol": {
      "type": "string",
      "description": "Specific contract symbol to look up (e.g., GCK26)."
    },
    "symbol_root": {
      "type": "string",
      "description": "Commodity root to filter contracts (e.g., GC returns all contracts starting with GC like GCK26, GCM26, etc.)."
    }
  }
}

{
  "type": "object",
  "required": [],
  "properties": {}
}

{
  "type": "object",
  "required": [
    "name"
  ],
  "properties": {
    "name": {
      "type": "string",
      "example": "crude_oil",
      "description": "Commodity value. Same set as the `/commodityprice` `name` parameter."
    }
  }
}

{
  "type": "object",
  "required": [],
  "properties": {
    "category": {
      "enum": [
        "precious_metals",
        "base_metals",
        "energy",
        "grains",
        "softs",
        "livestock"
      ],
      "type": "string",
      "description": "Filter to a single product category."
    },
    "exchange": {
      "enum": [
        "CME",
        "NYMEX",
        "COMEX",
        "ICE"
      ],
      "type": "string",
      "description": "Filter to commodities listed on a single exchange."
    }
  }
}

{
  "type": "object",
  "required": [],
  "properties": {
    "name": {
      "enum": [
        "gold",
        "silver",
        "platinum",
        "palladium",
        "crude_oil",
        "brent_crude_oil",
        "natural_gas",
        "gasoline_rbob",
        "heating_oil"
      ],
      "type": "string",
      "description": "The commodity. crude_oil, brent_crude_oil, gasoline_rbob, and heating_oil also accept wti, brent, gasoline, and diesel."
    },
    "unit": {
      "type": "string",
      "example": "g",
      "description": "Target unit, in the same dimension as the commodity's native unit (mass for metals, volume for oil, gasoline and heating oil, energy for natural gas)."
    },
    "names": {
      "type": "string",
      "example": "gold,silver,natural_gas",
      "description": "Comma-separated list of commodities for a batch request. Available to Business, Professional, and Enterprise subscribers, or any annual plan."
    },
    "currency": {
      "type": "string",
      "example": "EUR",
      "description": "ISO 4217 currency code to convert prices into (e.g., EUR, GBP). Defaults to USD."
    }
  }
}

{
  "type": "object",
  "required": [
    "id"
  ],
  "properties": {
    "id": {
      "type": "string",
      "description": "ID to specify the counter. Use a new id to create a new counter."
    },
    "hit": {
      "type": "boolean",
      "description": "Whether to increase the count by 1. If used, must be set to true."
    },
    "value": {
      "type": "integer",
      "description": "Set the count to a specific integer value. Setting the value to 0 resets the counter."
    }
  }
}

{
  "type": "object",
  "required": [
    "country"
  ],
  "properties": {
    "country": {
      "type": "string",
      "description": "2-letter ISO-3166 alpha-2 country code (e.g. US, CA, FR). For countries in the United Kingdom, use GB for Great Britain, GB-ENG for England, GB-SCT for Scotland, GB-WLS for Wales, GB-NIR for Northern Ireland."
    }
  }
}

{
  "type": "object",
  "required": [],
  "properties": {
    "limit": {
      "type": "integer",
      "default": 1,
      "maximum": 30,
      "minimum": 1,
      "description": "Number of results to return. Must be between 1 and 30. Default is 1."
    },
    "state": {
      "type": "string",
      "description": "2-letter state code (case-insensitive)."
    },
    "county": {
      "type": "string",
      "description": "Full name of the county to search."
    },
    "offset": {
      "type": "integer",
      "default": 0,
      "description": "Number of results to offset for pagination. Default is 0."
    },
    "zipcode": {
      "type": "string",
      "description": "5-digit ZIP code to search."
    }
  }
}

{
  "type": "object",
  "required": [],
  "properties": {
    "date": {
      "type": "string",
      "format": "date",
      "description": "Date to retrieve single-day snapshot. Must be in the form of YYYY-MM-DD (e.g. 2022-01-01). Either date or country must be set."
    },
    "type": {
      "enum": [
        "cases",
        "deaths"
      ],
      "type": "string",
      "description": "Type of data to retrieve. Must be either cases or deaths. If not set, cases will be used by default."
    },
    "county": {
      "type": "string",
      "description": "County name for US states (case insensitive). For United States data only. Must be used in conjunction with country (United States) and region (e.g. California)."
    },
    "region": {
      "type": "string",
      "description": "Administrative region (also known as state or province in many countries) name (case insensitive). Must be used in conjunction with country. If not set, countries with data broken down by administrative regions will return separate data for each region."
    },
    "country": {
      "type": "string",
      "description": "Country name (case insensitive). Either date or country must be set."
    }
  }
}

{
  "type": "object",
  "required": [
    "symbol"
  ],
  "properties": {
    "symbol": {
      "type": "string",
      "description": "Cryptocurrency symbol, e.g. BTCUSD (US dollars), ETHUSDT (Tether), ETHBTC, or BTCEUR (fiat quotes, premium plans). To get the full list of available symbols, use the Crypto Symbols API."
    }
  }
}

{
  "type": "object",
  "required": [
    "symbol"
  ],
  "properties": {
    "end": {
      "type": "integer",
      "format": "int64",
      "description": "End timestamp in Unix seconds. Defaults to now."
    },
    "limit": {
      "type": "integer",
      "default": 100,
      "maximum": 1000,
      "minimum": 1,
      "description": "Maximum number of data points to return. Default 100, maximum 1000."
    },
    "start": {
      "type": "integer",
      "format": "int64",
      "description": "Start timestamp in Unix seconds. If omitted, the most recent `limit` data points are returned."
    },
    "symbol": {
      "type": "string",
      "description": "Cryptocurrency symbol, e.g. BTCUSD (US dollars), ETHUSDT (Tether) or ETHBTC. USD and crypto quotes only."
    },
    "interval": {
      "enum": [
        "1m",
        "5m",
        "15m",
        "30m",
        "1h",
        "4h",
        "1d"
      ],
      "type": "string",
      "default": "1h",
      "description": "Time interval between data points. Default is 1h."
    }
  }
}

{
  "type": "object",
  "required": [],
  "properties": {}
}

{
  "type": "object",
  "required": [
    "pair"
  ],
  "properties": {
    "pair": {
      "type": "string",
      "description": "Currency pair in ABC_DEF form (e.g. EUR_USD). Both must be supported fiat currency codes; ZWG, BTC, and XAG are not supported."
    },
    "method": {
      "enum": [
        "close_to_close",
        "ewma"
      ],
      "type": "string",
      "default": "close_to_close",
      "description": "Volatility method: close_to_close (default) or ewma."
    },
    "window": {
      "type": "integer",
      "default": 30,
      "description": "Lookback window for realized volatility, in trading days. Defaults to 30. Must be between 2 and 1000."
    },
    "day_count": {
      "enum": [
        252,
        365
      ],
      "type": "integer",
      "default": 252,
      "description": "Annualization factor: 252 trading days (default) or 365 calendar days."
    },
    "annualized": {
      "type": "boolean",
      "default": true,
      "description": "Whether to treat the annualized figure as the headline value. Defaults to true."
    }
  }
}

{
  "type": "object",
  "required": [
    "pair"
  ],
  "properties": {
    "pair": {
      "type": "string",
      "description": "Currency pair in ABC_DEF form (e.g. EUR_USD). Both must be supported fiat currency codes; ZWG, BTC, and XAG are not supported."
    },
    "lambda": {
      "type": "number",
      "default": 0.94,
      "description": "EWMA decay factor (only used when method=ewma). Defaults to 0.94. Must be between 0.80 and 0.99."
    },
    "method": {
      "enum": [
        "garch_11",
        "ewma"
      ],
      "type": "string",
      "default": "garch_11",
      "description": "Forecast method: garch_11 (default) or ewma. If a GARCH fit does not converge the response falls back to EWMA."
    },
    "horizon": {
      "type": "string",
      "default": "1,5,21,63",
      "description": "Comma-separated forecast horizons in trading days (e.g. 1,5,21,63). Defaults to 1,5,21,63."
    },
    "day_count": {
      "enum": [
        252,
        365
      ],
      "type": "integer",
      "default": 252,
      "description": "Annualization factor: 252 trading days (default) or 365 calendar days."
    }
  }
}

{
  "type": "object",
  "required": [],
  "properties": {
    "name": {
      "enum": [
        "gold",
        "soybean_oil",
        "wheat",
        "platinum",
        "micro_silver",
        "lean_hogs",
        "corn",
        "oat",
        "aluminum",
        "soybean_meal",
        "silver",
        "soybean",
        "lumber",
        "live_cattle",
        "sugar",
        "natural_gas",
        "crude_oil",
        "orange_juice",
        "coffee",
        "cotton",
        "copper",
        "micro_gold",
        "feeder_cattle",
        "rough_rice",
        "palladium",
        "cocoa",
        "brent_crude_oil",
        "gasoline_rbob",
        "heating_oil",
        "class_3_milk"
      ],
      "type": "string",
      "description": "Name of a single commodity. Mutually exclusive with `names`."
    },
    "unit": {
      "type": "string",
      "example": "kg",
      "description": "Target mass/volume/energy unit to convert the price into (e.g., kg, g, lb, metric_ton, liter). Bushel and board_feet are commodity-specific and cannot be cross-converted."
    },
    "names": {
      "type": "string",
      "example": "gold,silver,platinum",
      "description": "Comma-separated list of commodity values for a batch request (max 30). Mutually exclusive with `name`. Available to Business, Professional, and Enterprise subscribers, or any annual plan; other tiers should use the `name` parameter for single-commodity lookups."
    },
    "currency": {
      "type": "string",
      "example": "EUR",
      "description": "ISO 4217 currency code to convert the price into (e.g., EUR, GBP, INR). When provided, USX prices are first normalized to USD before conversion. Defaults to the native USD/USX quote."
    }
  }
}

{
  "type": "object",
  "required": [],
  "properties": {
    "unit": {
      "enum": [
        "troy_ounce",
        "g",
        "kg",
        "oz",
        "lb",
        "metric_ton",
        "short_ton",
        "hundredweight"
      ],
      "type": "string",
      "default": "troy_ounce",
      "description": "Target unit to convert the price into. Defaults to troy_ounce."
    },
    "currency": {
      "type": "string",
      "example": "EUR",
      "description": "ISO 4217 currency code to convert the price into (e.g., EUR, GBP, INR). Defaults to USD."
    }
  }
}

{
  "type": "object",
  "required": [],
  "properties": {
    "type": {
      "enum": [
        "CPI",
        "HICP"
      ],
      "type": "string",
      "description": "Inflation indicator type. Can be either CPI (Consumer Price Index) or HICP (Harmonized Index of Consumer Prices). If not provided, the CPI will be used by default."
    },
    "country": {
      "type": "string",
      "description": "2-letter country code (ISO-3166-1 alpha-2) or name of country (case-insensitive)."
    }
  }
}

{
  "type": "object",
  "required": [
    "rate"
  ],
  "properties": {
    "rate": {
      "type": "string",
      "description": "The specific interest rate identifier. Supports central bank rates (e.g. central_bank_us, central_bank_eu), benchmark rates (e.g. sofr, effr, euribor_3_months, sonia), and bank prime / base lending rates (prime_us, prime_ca, prime_jp, prime_za, lpr_cn_1y, lpr_cn_5y, br_my, blr_my, tpb_br)."
    }
  }
}

{
  "type": "object",
  "required": [],
  "properties": {
    "unit": {
      "enum": [
        "troy_ounce",
        "g",
        "kg",
        "oz",
        "lb",
        "metric_ton",
        "short_ton",
        "hundredweight"
      ],
      "type": "string",
      "description": "Target weight unit. Defaults to the metal's native unit (troy_ounce for precious metals, lb for copper, metric_ton for aluminum)."
    },
    "metal": {
      "enum": [
        "gold",
        "silver",
        "platinum",
        "palladium",
        "copper",
        "aluminum"
      ],
      "type": "string",
      "default": "gold",
      "description": "The metal to return. Defaults to gold. xau, xag, xpt, xpd, and aluminium are also accepted as aliases."
    },
    "metals": {
      "type": "string",
      "example": "gold,silver,platinum",
      "description": "Comma-separated list of metals for a batch request. Available to Business, Professional, and Enterprise subscribers, or any annual plan."
    },
    "currency": {
      "type": "string",
      "example": "EUR",
      "description": "ISO 4217 currency code to convert prices into (e.g., EUR, GBP, INR). Defaults to USD."
    }
  }
}

{
  "type": "object",
  "required": [],
  "properties": {
    "type": {
      "enum": [
        "wti",
        "brent",
        "natural_gas",
        "gasoline",
        "diesel"
      ],
      "type": "string",
      "default": "wti",
      "description": "The oil/energy benchmark to return. Defaults to wti. crude_oil, brent_crude_oil, gasoline_rbob, and heating_oil are also accepted as aliases."
    },
    "unit": {
      "enum": [
        "barrel",
        "gallon",
        "liter",
        "cubic_meter",
        "MMBtu",
        "MWh",
        "GJ",
        "therm"
      ],
      "type": "string",
      "description": "Target unit to convert the price into. Must match the benchmark's dimension: crude oil, gasoline, and diesel (volume) accept barrel, gallon, liter, or cubic_meter; natural_gas (energy) accepts MMBtu, MWh, GJ, or therm. Premium feature."
    },
    "types": {
      "type": "string",
      "example": "wti,brent,natural_gas",
      "description": "Comma-separated list of benchmarks for a batch request. Available to Business, Professional, and Enterprise subscribers, or any annual plan."
    },
    "currency": {
      "type": "string",
      "example": "EUR",
      "description": "ISO 4217 currency code to convert the price into (e.g., EUR, GBP, INR). Premium feature."
    }
  }
}

{
  "type": "object",
  "required": [
    "ticker"
  ],
  "properties": {
    "ticker": {
      "type": "string",
      "description": "Stock or index ticker symbol (e.g., AAPL or ^DJI)."
    }
  }
}

{
  "type": "object",
  "required": [],
  "properties": {
    "lat": {
      "type": "string",
      "description": "Latitude of desired location."
    },
    "lon": {
      "type": "string",
      "description": "Longitude of desired location."
    },
    "zip": {
      "type": "string",
      "description": "5 digit Zip code (United States only). Premium subscribers only."
    },
    "city": {
      "type": "string",
      "description": "City name. Premium subscribers only."
    },
    "state": {
      "type": "string",
      "description": "US state (for United States cities only). Premium subscribers only."
    },
    "country": {
      "type": "string",
      "description": "Country name. Premium subscribers only."
    }
  }
}

{
  "type": "object",
  "required": [
    "domain"
  ],
  "properties": {
    "domain": {
      "type": "string",
      "description": "Valid domain to check (e.g. example.com). For top-level domains other than .com, a premium subscription is required."
    }
  }
}

{
  "type": "object",
  "required": [],
  "properties": {
    "limit": {
      "type": "integer",
      "format": "int32",
      "default": 1,
      "maximum": 100,
      "minimum": 1,
      "description": "How many jokes to return. Must be between 1 and 100. Default is 1. Premium only."
    }
  }
}

{
  "type": "object",
  "required": [],
  "properties": {
    "day": {
      "type": "integer",
      "maximum": 31,
      "minimum": 1,
      "description": "The day of the month for the historical events to retrieve. Must be between 1 and 31. If specified, month must also be provided. If both are omitted, today's date is used. Premium only."
    },
    "limit": {
      "type": "integer",
      "default": 1,
      "maximum": 30,
      "minimum": 1,
      "description": "The maximum number of results to return. Must be between 1 and 30. Default is 1. Premium only."
    },
    "month": {
      "type": "integer",
      "maximum": 12,
      "minimum": 1,
      "description": "The month of the historical events to retrieve. Must be between 1 and 12. If specified, day must also be provided. If both are omitted, today's date is used. Premium only."
    },
    "offset": {
      "type": "integer",
      "default": 0,
      "minimum": 0,
      "description": "The number of results to skip. Must be zero or a positive integer. Default is 0. Premium only."
    }
  }
}

{
  "type": "object",
  "required": [
    "word"
  ],
  "properties": {
    "word": {
      "type": "string",
      "description": "Word to look up."
    }
  }
}

{
  "type": "object",
  "required": [
    "domain"
  ],
  "properties": {
    "domain": {
      "type": "string",
      "description": "Valid domain to check (e.g. example.com). For top-level domains other than .com, a premium subscription is required."
    }
  }
}

{
  "type": "object",
  "required": [],
  "properties": {
    "isin": {
      "type": "string",
      "description": "International Securities Identification Number of the ETF (e.g., IE00B5BMR087). An ISIN identifies the fund, which may trade on several exchanges: the most-traded listing fills the response and every listing is returned in `listings`. Either ticker or isin is required, not both."
    },
    "ticker": {
      "type": "string",
      "description": "ETF ticker symbol (e.g., QQQ, SPY, VTI), including any exchange suffix (e.g. EUNL.DE). Either ticker or isin is required, not both."
    }
  }
}

{
  "type": "object",
  "required": [
    "lat",
    "lon"
  ],
  "properties": {
    "lat": {
      "type": "number",
      "format": "double",
      "description": "Latitude coordinate."
    },
    "lon": {
      "type": "number",
      "format": "double",
      "description": "Longitude coordinate."
    },
    "level": {
      "enum": [
        1,
        2,
        3
      ],
      "type": "integer",
      "description": "Charging level (1, 2, or 3). By default, all levels are returned."
    },
    "limit": {
      "type": "integer",
      "default": 3,
      "maximum": 30,
      "minimum": 1,
      "description": "How many results to return. Must be between 1 and 30. Default is 3."
    },
    "offset": {
      "type": "integer",
      "default": 0,
      "description": "Number of results to skip. Used for pagination. Default is 0."
    },
    "distance": {
      "type": "integer",
      "default": 3,
      "maximum": 50,
      "minimum": 1,
      "description": "Search distance in kilometers. Default is 3 kilometers. Max value is 50 kilometers."
    }
  }
}

{
  "type": "object",
  "required": [],
  "properties": {}
}

{
  "type": "object",
  "required": [],
  "properties": {
    "cik": {
      "type": "string",
      "description": "Company Central Index Key (e.g. 320193). Either ticker or cik must be provided."
    },
    "limit": {
      "type": "integer",
      "default": 50,
      "maximum": 200,
      "minimum": 1,
      "description": "Maximum number of participants to return. Default 50; values above 200 are clamped to 200."
    },
    "offset": {
      "type": "integer",
      "default": 0,
      "minimum": 0,
      "description": "Number of results to skip for pagination. Default 0."
    },
    "ticker": {
      "type": "string",
      "description": "Company ticker symbol (e.g. AAPL). Either ticker or cik must be provided."
    },
    "sort_by": {
      "enum": [
        "appearance_count",
        "last_appearance_date",
        "name"
      ],
      "type": "string",
      "default": "appearance_count",
      "description": "Sort field."
    },
    "sort_dir": {
      "enum": [
        "asc",
        "desc"
      ],
      "type": "string",
      "description": "Sort direction. Defaults to desc, or asc when sort_by=name."
    },
    "speaker_type": {
      "enum": [
        "executive",
        "analyst"
      ],
      "type": "string",
      "description": "Restrict to the management roster (executive) or the covering analysts (analyst)."
    }
  }
}

{
  "type": "object",
  "required": [],
  "properties": {
    "cik": {
      "type": "string",
      "description": "Company Central Index Key (e.g., 320193). Either ticker or cik must be provided."
    },
    "year": {
      "type": "integer",
      "format": "int32",
      "minimum": 2000,
      "description": "Earnings year (e.g., 2025). Must be a valid year between 2000 and the current year. If provided, quarter must also be provided. Premium only."
    },
    "ticker": {
      "type": "string",
      "description": "Company ticker symbol (e.g., AAPL). Either ticker or cik must be provided."
    },
    "quarter": {
      "enum": [
        1,
        2,
        3,
        4
      ],
      "type": "integer",
      "format": "int32",
      "description": "Earnings quarter from Q1 to Q4. If provided, year must also be provided. Premium only."
    }
  }
}

{
  "type": "object",
  "required": [],
  "properties": {
    "year": {
      "type": "integer",
      "description": "Filter manufacturers by year (e.g., 2023)"
    }
  }
}

{
  "type": "object",
  "required": [
    "make"
  ],
  "properties": {
    "make": {
      "type": "string",
      "description": "Vehicle manufacturer (e.g., tesla)"
    },
    "year": {
      "type": "integer",
      "description": "Vehicle model year (e.g., 2023)"
    }
  }
}

{
  "type": "object",
  "required": [],
  "properties": {
    "code": {
      "type": "string",
      "description": "Unicode character code for the emoji."
    },
    "name": {
      "type": "string",
      "description": "Descriptive name of emoji."
    },
    "group": {
      "enum": [
        "smileys_emotion",
        "people_body",
        "component",
        "animals_nature",
        "food_drink",
        "travel_places",
        "activities",
        "objects",
        "symbols",
        "flags"
      ],
      "type": "string",
      "description": "Main category the emoji belongs to."
    },
    "offset": {
      "type": "integer",
      "format": "int32",
      "minimum": 0,
      "description": "Number of results to offset for pagination."
    },
    "subgroup": {
      "type": "string",
      "description": "Sub-category the emoji belongs to."
    }
  }
}

{
  "type": "object",
  "required": [],
  "properties": {}
}

{
  "type": "object",
  "required": [
    "pair"
  ],
  "properties": {
    "pair": {
      "type": "string",
      "description": "Currency pair to query. Must be in the form of currency1_currency2 (e.g. USD_EUR)"
    }
  }
}

{
  "type": "object",
  "required": [],
  "properties": {
    "cik": {
      "type": "string",
      "example": "320193",
      "description": "The company's SEC Central Index Key (CIK), with or without leading zeros (e.g., 320193 or 0000320193). An alternative to ticker."
    },
    "name": {
      "type": "string",
      "description": "Company name to search for (e.g., apple), used when a ticker or cik is not provided."
    },
    "year": {
      "type": "integer",
      "example": 2024,
      "description": "The 4-digit fiscal year to return. Each response covers a single year and defaults to the latest available year. Historical (non-latest) years require a paid (premium) plan; a year the company has no data for returns a no-data message."
    },
    "ticker": {
      "type": "string",
      "example": "AAPL",
      "description": "The stock ticker of the company (e.g., AAPL). Either ticker or name is required."
    }
  }
}

{
  "type": "object",
  "required": [],
  "properties": {
    "name": {
      "type": "string",
      "description": "Name of exercise. This value can be partial."
    },
    "type": {
      "enum": [
        "cardio",
        "olympic_weightlifting",
        "plyometrics",
        "powerlifting",
        "strength",
        "stretching",
        "strongman"
      ],
      "type": "string",
      "description": "Exercise type."
    },
    "muscle": {
      "enum": [
        "abdominals",
        "abductors",
        "adductors",
        "biceps",
        "calves",
        "chest",
        "forearms",
        "glutes",
        "hamstrings",
        "lats",
        "lower_back",
        "middle_back",
        "neck",
        "quadriceps",
        "traps",
        "triceps"
      ],
      "type": "string",
      "description": "Muscle group targeted by the exercise."
    },
    "offset": {
      "type": "integer",
      "default": 0,
      "description": "Number of results to offset for pagination. Default is 0."
    },
    "difficulty": {
      "enum": [
        "beginner",
        "intermediate",
        "expert"
      ],
      "type": "string",
      "description": "Difficulty level of the exercise."
    },
    "equipments": {
      "type": "string",
      "description": "Equipment required for the exercise. Multiple equipments can be specified using comma separation (e.g. dumbbell,flat bench). This value can be partial."
    }
  }
}

{
  "type": "object",
  "required": [],
  "properties": {}
}

{
  "type": "object",
  "required": [],
  "properties": {
    "safe": {
      "type": "boolean",
      "default": false,
      "description": "Premium subscribers only. Set safe=true to exclude facts flagged as sexually explicit, crude, or containing profanity, slurs, or offensive content. Defaults to false, so results are unfiltered unless you opt in. Any value other than true/false returns an error, as does using this parameter on a free account."
    },
    "limit": {
      "type": "integer",
      "default": 1,
      "maximum": 100,
      "minimum": 1,
      "description": "How many results to return. Must be between 1 and 100. Default is 1."
    }
  }
}

{
  "type": "object",
  "required": [
    "ticker"
  ],
  "properties": {
    "limit": {
      "type": "integer",
      "example": 30,
      "maximum": 250,
      "minimum": 1,
      "description": "Number of records to return, 1 to 250. Defaults to 30. The free tier is limited to the latest record."
    },
    "ticker": {
      "type": "string",
      "example": "GME",
      "description": "The stock or ETF ticker symbol (e.g., GME)."
    }
  }
}

{
  "type": "object",
  "required": [],
  "properties": {
    "year": {
      "type": "integer",
      "description": "Year for which to retrieve GDP data."
    },
    "country": {
      "type": "string",
      "description": "Country name (case-insensitive) or 2-letter ISO-3166 alpha-2 code of the country. E.g. Canada or CA."
    }
  }
}

{
  "type": "object",
  "required": [
    "city"
  ],
  "properties": {
    "city": {
      "type": "string",
      "description": "City name."
    },
    "state": {
      "type": "string",
      "description": "US state (for United States cities only)."
    },
    "country": {
      "type": "string",
      "description": "Country name, 2-letter ISO country code, or 3-letter ISO country code."
    },
    "zipcode": {
      "type": "string",
      "description": "5-digit zipcode (for United States cities only)."
    }
  }
}

{
  "type": "object",
  "required": [],
  "properties": {
    "unit": {
      "enum": [
        "troy_ounce",
        "g",
        "kg",
        "oz",
        "lb",
        "metric_ton",
        "short_ton",
        "hundredweight"
      ],
      "type": "string",
      "default": "troy_ounce",
      "description": "Target unit to convert the price into. Defaults to troy_ounce."
    },
    "currency": {
      "type": "string",
      "example": "EUR",
      "description": "ISO 4217 currency code to convert the price into (e.g., EUR, GBP, INR). Defaults to USD."
    }
  }
}

{
  "type": "object",
  "required": [
    "name"
  ],
  "properties": {
    "end": {
      "type": "integer",
      "description": "End timestamp in Unix format."
    },
    "name": {
      "type": "string",
      "description": "Name of commodity."
    },
    "start": {
      "type": "integer",
      "description": "Start timestamp in Unix format."
    },
    "period": {
      "enum": [
        "1m",
        "5m",
        "15m",
        "30m",
        "1h",
        "4h",
        "1d"
      ],
      "type": "string",
      "default": "1h",
      "description": "Time interval between data points."
    }
  }
}

{
  "type": "object",
  "required": [],
  "properties": {
    "day": {
      "type": "integer",
      "maximum": 31,
      "minimum": 1,
      "description": "Calendar day of the month."
    },
    "text": {
      "type": "string",
      "description": "Query text to search events by. Use keywords or short phrases for best match results."
    },
    "year": {
      "type": "integer",
      "description": "4-digit year (e.g. 1776). For BC/BCE years, use a negative integer (e.g. -351 for 351 BC)."
    },
    "month": {
      "type": "integer",
      "maximum": 12,
      "minimum": 1,
      "description": "Integer month (e.g. 3 for March)."
    },
    "offset": {
      "type": "integer",
      "description": "Number of results to offset pagination. Premium only."
    }
  }
}

{
  "type": "object",
  "required": [
    "pair"
  ],
  "properties": {
    "date": {
      "type": "string",
      "format": "date",
      "description": "Single date to query (YYYY-MM-DD). Either date or both start_date and end_date must be provided."
    },
    "pair": {
      "type": "string",
      "description": "Currency pair to query. Must be in the form of currency1_currency2 (e.g. USD_EUR)"
    },
    "end_date": {
      "type": "string",
      "format": "date",
      "description": "End date of a range query (YYYY-MM-DD). Date range cannot exceed 366 days."
    },
    "start_date": {
      "type": "string",
      "format": "date",
      "description": "Start date of a range query (YYYY-MM-DD). Must be used with end_date."
    }
  }
}

{
  "type": "object",
  "required": [],
  "properties": {
    "end": {
      "type": "integer",
      "description": "End timestamp in Unix format. If not provided, defaults to current time."
    },
    "start": {
      "type": "integer",
      "description": "Start timestamp in Unix format. If not provided, defaults to 24 hours ago."
    },
    "period": {
      "enum": [
        "1m",
        "5m",
        "15m",
        "30m",
        "1h",
        "4h",
        "1d"
      ],
      "type": "string",
      "default": "1h",
      "description": "Time interval between data points. Valid values are: 1m, 5m, 15m, 30m, 1h, 4h, 1d. Default is 1h."
    }
  }
}

{
  "type": "object",
  "required": [
    "country"
  ],
  "properties": {
    "type": {
      "enum": [
        "CPI",
        "HICP"
      ],
      "type": "string",
      "description": "Inflation indicator type. Can be either CPI (Consumer Price Index) or HICP (Harmonized Index of Consumer Prices). If not provided, the CPI will be used by default."
    },
    "country": {
      "type": "string",
      "description": "Either the 2-letter country code (ISO-3166-1 alpha-2) or the country name (case-insensitive)."
    },
    "end_time": {
      "type": "integer",
      "description": "End time for the data range, specified as a UNIX timestamp in seconds."
    },
    "start_time": {
      "type": "integer",
      "description": "Start time for the data range, specified as a UNIX timestamp in seconds."
    }
  }
}

{
  "type": "object",
  "required": [
    "type"
  ],
  "properties": {
    "type": {
      "enum": [
        "overnight",
        "1_month",
        "3_months",
        "6_months",
        "12_months"
      ],
      "type": "string",
      "description": "Tenor of the LIBOR rate. Must be one of: overnight, 1_month, 3_months, 6_months, 12_months"
    },
    "end_time": {
      "type": "integer",
      "description": "End time for the data range, specified as a UNIX timestamp in seconds."
    },
    "start_time": {
      "type": "integer",
      "description": "Start time for the data range, specified as a UNIX timestamp in seconds."
    }
  }
}

{
  "type": "object",
  "required": [],
  "properties": {
    "end": {
      "type": "integer",
      "description": "End timestamp in Unix format."
    },
    "type": {
      "enum": [
        "wti",
        "brent",
        "natural_gas",
        "gasoline",
        "diesel"
      ],
      "type": "string",
      "default": "wti",
      "description": "The oil/energy benchmark. Defaults to wti. crude_oil, brent_crude_oil, gasoline_rbob, and heating_oil are also accepted as aliases."
    },
    "start": {
      "type": "integer",
      "description": "Start timestamp in Unix format."
    },
    "period": {
      "enum": [
        "1m",
        "5m",
        "15m",
        "30m",
        "1h",
        "4h",
        "1d"
      ],
      "type": "string",
      "default": "1h",
      "description": "Time interval between data points."
    }
  }
}

{
  "type": "object",
  "required": [
    "ticker"
  ],
  "properties": {
    "end": {
      "type": "integer",
      "description": "End timestamp in Unix format. If not provided, defaults to current time."
    },
    "start": {
      "type": "integer",
      "description": "Start timestamp in Unix format. If not provided, defaults to approximately the most recent 900 data points for the chosen period. Requests reaching further back than 5 years require a Business, Professional, Enterprise, or annual subscription."
    },
    "period": {
      "enum": [
        "1m",
        "5m",
        "15m",
        "30m",
        "1h",
        "4h",
        "1d"
      ],
      "type": "string",
      "default": "1h",
      "description": "Time interval between data points from 1 minute to 1 day. Valid values are: 1m, 5m, 15m, 30m, 1h, 4h, 1d. Default is 1h."
    },
    "ticker": {
      "type": "string",
      "description": "Stock ticker symbol (e.g., AAPL)."
    }
  }
}

{
  "type": "object",
  "required": [],
  "properties": {
    "category": {
      "enum": [
        "general",
        "sports_and_outdoors",
        "education",
        "collection",
        "competition",
        "observation"
      ],
      "type": "string",
      "description": "Filter hobbies by category. Possible values are: general, sports_and_outdoors, education, collection, competition, observation."
    }
  }
}

{
  "type": "object",
  "required": [
    "country"
  ],
  "properties": {
    "type": {
      "enum": [
        "PUBLIC_HOLIDAY",
        "STATE_HOLIDAY",
        "LOCAL_HOLIDAY",
        "PROVINCE_TERRITORY_HOLIDAY",
        "DE_FACTO_HOLIDAY",
        "SUBSTITUTE_HOLIDAY",
        "BANK_HOLIDAY",
        "GOVERNMENT_HOLIDAY",
        "PRIVATE_SECTOR_HOLIDAY",
        "OPTIONAL_HOLIDAY",
        "RESTRICTED_TRADING_DAY",
        "CHRISTIAN_HOLIDAY",
        "ORTHODOX_HOLIDAY",
        "MUSLIM_HOLIDAY",
        "JEWISH_HOLIDAY",
        "HINDU_HOLIDAY",
        "OBSERVANCE",
        "UNITED_NATIONS_OBSERVANCE",
        "FLAG_DAY",
        "SILENT_DAY",
        "HALF_DAY",
        "WORKING_DAY",
        "SEASON",
        "CLOCK_CHANGE",
        "COVID_19_MEASURE",
        "SPORTING_EVENT"
      ],
      "type": "string",
      "description": "Return only one type of holiday. Not case-sensitive: `PUBLIC_HOLIDAY` and `public_holiday` are equivalent, and `major_holiday` is accepted as an alias of `public_holiday`. An unknown value returns a 400 error. Omit to return every type."
    },
    "year": {
      "type": "integer",
      "maximum": 2039,
      "minimum": 2005,
      "description": "Calendar year between 2005 and 2039 (inclusive). Defaults to the current year. Free plans can omit it or pass the current year; other years are for premium subscribers only."
    },
    "country": {
      "type": "string",
      "description": "Country as a 2-letter ISO 3166-1 alpha-2 code (preferred, e.g. `US`), a 3-letter alpha-3 code (e.g. `USA`) or an English country name (e.g. `United States`). Not case-sensitive. Names must match exactly; common short names such as `UK`, `USA`, `UAE` and `South Korea` also work. Territories have their own codes: for example, Curaçao is `CW` and Sint Maarten is `SX`, not `NL`. An unrecognized country, or one without data, returns a 400 error."
    }
  }
}

{
  "type": "object",
  "required": [
    "zodiac"
  ],
  "properties": {
    "date": {
      "type": "string",
      "format": "date",
      "description": "The date for the horoscope in YYYY-MM-DD format. The date must be either current or in the past. It cannot be in the future. If not provided, returns the horoscope for today's date. Premium only."
    },
    "zodiac": {
      "enum": [
        "aries",
        "taurus",
        "gemini",
        "cancer",
        "leo",
        "virgo",
        "libra",
        "scorpio",
        "sagittarius",
        "capricorn",
        "aquarius",
        "pisces"
      ],
      "type": "string",
      "description": "The zodiac sign to get a horoscope for. Valid values are: aries, taurus, gemini, cancer, leo, virgo, libra, scorpio, sagittarius, capricorn, aquarius, pisces."
    }
  }
}

{
  "type": "object",
  "required": [
    "iban"
  ],
  "properties": {
    "iban": {
      "type": "string",
      "description": "The IBAN to look up."
    }
  }
}

{
  "type": "object",
  "required": [
    "address"
  ],
  "properties": {
    "address": {
      "type": "string",
      "description": "IP Address to query. Must be in IPv4 format A.B.C.D (e.g., 73.9.149.180) or IPv6 format X:X:X:X:X:X:X:X (e.g., 2001:0db8:85a3:0000:0000:8a2e:0370:7334)."
    }
  }
}

{
  "type": "object",
  "required": [],
  "properties": {
    "cik": {
      "type": "string",
      "description": "Company Central Index Key (e.g., 796343). Either ticker or cik must be provided."
    },
    "year": {
      "type": "integer",
      "description": "Fiscal year (e.g., 2025). Must be a valid year after 2000. Historical data before the previous year requires a premium subscription. If set, period must also be set."
    },
    "period": {
      "enum": [
        "q1",
        "q2",
        "q3",
        "q4",
        "fy"
      ],
      "type": "string",
      "description": "Fiscal period. Must be one of: q1, q2, q3, q4, or fy (full year). If set, year must also be set."
    },
    "ticker": {
      "type": "string",
      "description": "Company ticker symbol (e.g., ADBE). Either ticker or cik must be provided."
    }
  }
}

{
  "type": "object",
  "required": [],
  "properties": {
    "cik": {
      "type": "string",
      "description": "Company Central Index Key (e.g., 796343). Either ticker or cik must be provided."
    },
    "ticker": {
      "type": "string",
      "description": "Company ticker symbol (e.g., ADBE). Either ticker or cik must be provided."
    }
  }
}

{
  "type": "object",
  "required": [
    "country",
    "year"
  ],
  "properties": {
    "year": {
      "type": "integer",
      "description": "The tax year for which to retrieve data"
    },
    "country": {
      "type": "string",
      "description": "2-letter country code (e.g., US, CA)"
    },
    "regions": {
      "type": "string",
      "description": "Comma-separated list of regions to filter the response. For United States, specify 2-letter state codes (e.g., AL, CA, NY) or federal for federal tax information only. For Canada, specify 2-letter provincial codes (e.g., ON, BC, QC) or federal for federal tax information only. Multiple regions can be specified (e.g., federal,AL,CA,NY). When specified, filters the response to only include tax information for those regions. If unset, the response will include all regions (federal and all states/provinces)."
    }
  }
}

{
  "type": "object",
  "required": [
    "name"
  ],
  "properties": {
    "name": {
      "type": "string",
      "description": "Name of the insider (exact match). Use /v1/insiderslist to look up insider names."
    },
    "company_cik": {
      "type": "string",
      "description": "Central Index Key (CIK) of the company to filter transactions (e.g., 789019)."
    },
    "company_ticker": {
      "type": "string",
      "description": "Company ticker symbol to filter transactions (e.g., AAPL, MSFT)."
    }
  }
}

{
  "type": "object",
  "required": [],
  "properties": {
    "cik": {
      "type": "string",
      "description": "Central Index Key (CIK) of the company."
    },
    "ticker": {
      "type": "string",
      "description": "Company ticker symbol (e.g., AAPL, MSFT)."
    }
  }
}

{
  "type": "object",
  "required": [],
  "properties": {
    "cik": {
      "type": "string",
      "description": "Returns that institution's filing history - one record per quarter."
    },
    "name": {
      "type": "string",
      "description": "Substring search of institution names; returns directory records."
    },
    "limit": {
      "type": "integer",
      "description": "Maximum results to return. Default 50, max 1000."
    },
    "offset": {
      "type": "integer",
      "description": "Number of results to skip for pagination."
    },
    "period": {
      "type": "string",
      "description": "Quarter-end date (YYYY-MM-DD); returns every institution that filed for that quarter."
    },
    "period_list": {
      "type": "boolean",
      "description": "true enumerates the available quarters with filing counts."
    }
  }
}

{
  "type": "object",
  "required": [],
  "properties": {
    "cik": {
      "type": "string",
      "description": "Rank the moves within a single institution instead of market-wide."
    },
    "limit": {
      "type": "integer",
      "description": "Number of ranked rows to return. Default 50, max 1000."
    },
    "period": {
      "type": "string",
      "description": "Quarter-end date (YYYY-MM-DD); defaults to the latest quarter."
    },
    "mover_type": {
      "enum": [
        "new_buys",
        "exits",
        "adds",
        "trims"
      ],
      "type": "string",
      "description": "new_buys (default), exits, adds, or trims."
    }
  }
}

{
  "type": "object",
  "required": [],
  "properties": {
    "limit": {
      "type": "integer",
      "format": "int32",
      "default": 1,
      "maximum": 100,
      "minimum": 1,
      "description": "How many jokes to return. Must be between 1 and 100. Default is 1."
    }
  }
}

{
  "type": "object",
  "required": [],
  "properties": {}
}

{
  "type": "object",
  "required": [],
  "properties": {
    "name": {
      "type": "string",
      "description": "Company name. Supports partial matching (e.g. 'Micro' will match 'Microsoft'). Case-insensitive."
    },
    "ticker": {
      "type": "string",
      "description": "Ticker symbol of a listed company, ETF or mutual fund. For listings outside the US, add the exchange suffix (e.g. 7203.T or SAP.DE)."
    }
  }
}

{
  "type": "object",
  "required": [
    "game"
  ],
  "properties": {
    "end": {
      "type": "string",
      "format": "date",
      "description": "Latest draw date to include (YYYY-MM-DD)."
    },
    "game": {
      "type": "string",
      "example": "powerball",
      "description": "Game slug."
    },
    "limit": {
      "type": "integer",
      "default": 100,
      "maximum": 1000,
      "minimum": 1,
      "description": "Number of draws to return (1-1000). Default 100."
    },
    "start": {
      "type": "string",
      "format": "date",
      "description": "Earliest draw date to include (YYYY-MM-DD)."
    },
    "offset": {
      "type": "integer",
      "default": 0,
      "minimum": 0,
      "description": "Number of draws to skip, for paging. Default 0."
    },
    "session": {
      "type": "string",
      "description": "Only draws from this session, for games with several draws a day."
    }
  }
}

{
  "type": "object",
  "required": [
    "domain"
  ],
  "properties": {
    "domain": {
      "type": "string",
      "description": "Valid domain to check (e.g. x.com). All top-level domains are supported."
    }
  }
}

{
  "type": "object",
  "required": [
    "ticker"
  ],
  "properties": {
    "ticker": {
      "type": "string",
      "description": "Stock ticker symbol (e.g., NVDA)."
    }
  }
}

{
  "type": "object",
  "required": [],
  "properties": {
    "date": {
      "type": "string",
      "format": "date",
      "description": "Individual date to query in YYYY-MM-DD format."
    },
    "max_date": {
      "type": "string",
      "format": "date",
      "description": "Maximum date range to query in YYYY-MM-DD format. Must be used with min_date."
    },
    "min_date": {
      "type": "string",
      "format": "date",
      "description": "Minimum date range to query in YYYY-MM-DD format. Must be used with max_date."
    }
  }
}

{
  "type": "object",
  "required": [],
  "properties": {
    "mc": {
      "type": "string",
      "description": "Docket number, with or without the MC/MX/FF prefix. Provide either dot or mc."
    },
    "dot": {
      "type": "integer",
      "description": "USDOT number. Provide either dot or mc."
    },
    "checks": {
      "type": "boolean",
      "description": "Business+ only. Include a per-check evaluation against C.H. Robinson's published carrier criteria."
    },
    "min_bipd": {
      "type": "integer",
      "default": 1000000,
      "description": "BI&PD threshold in dollars used by the criteria checks."
    },
    "min_cargo": {
      "type": "integer",
      "default": 100000,
      "description": "Cargo coverage threshold in dollars used by the criteria checks."
    }
  }
}

{
  "type": "object",
  "required": [],
  "properties": {
    "mc": {
      "type": "string",
      "description": "Docket number, with or without the MC/MX/FF prefix. Provide either dot or mc."
    },
    "dot": {
      "type": "integer",
      "description": "USDOT number. Provide either dot or mc."
    }
  }
}

{
  "type": "object",
  "required": [],
  "properties": {
    "mc": {
      "type": "string",
      "description": "Docket number, with or without the MC/MX/FF prefix. Provide either dot or mc."
    },
    "dot": {
      "type": "integer",
      "description": "USDOT number. Provide either dot or mc."
    }
  }
}

{
  "type": "object",
  "required": [],
  "properties": {
    "mc": {
      "type": "string",
      "description": "Docket number, with or without the MC/MX/FF prefix. Provide either dot or mc."
    },
    "dot": {
      "type": "integer",
      "description": "USDOT number. Provide either dot or mc."
    }
  }
}

{
  "type": "object",
  "required": [],
  "properties": {}
}

{
  "type": "object",
  "required": [
    "make"
  ],
  "properties": {
    "make": {
      "type": "string",
      "description": "Vehicle manufacturer (e.g. kawasaki)."
    }
  }
}

{
  "type": "object",
  "required": [],
  "properties": {
    "isin": {
      "type": "string",
      "description": "International Securities Identification Number of the Mutual Fund share class (e.g., US9229087104 or ES0138841038). Either ticker or isin is required, not both."
    },
    "ticker": {
      "type": "string",
      "description": "Mutual Fund ticker symbol (e.g., VFIAX, FXAIX, FZROX). Funds outside the US that have no ticker are looked up as COUNTRY:CODE (e.g., CL:8026-8-A, NZ:FND1143). Either ticker or isin is required, not both."
    }
  }
}

{
  "type": "object",
  "required": [],
  "properties": {
    "code": {
      "type": "string",
      "description": "NAICS code, 2 to 6 digits. Required unless title is provided."
    },
    "year": {
      "enum": [
        "2022"
      ],
      "type": "string",
      "default": "2022",
      "description": "NAICS revision. Currently 2022 only; NAICS 2027 is not published by the Census Bureau until January 2027."
    },
    "codes": {
      "type": "string",
      "description": "Comma-separated NAICS codes for batch lookup. Maximum 50 on Developer, 500 on Business and above."
    },
    "title": {
      "type": "string",
      "description": "Look up by official title. Supports partial matching."
    },
    "country": {
      "enum": [
        "US"
      ],
      "type": "string",
      "default": "US",
      "description": "Currently US only. NAICS Canada and SCIAN Mexico are not yet available."
    },
    "crosswalk_to": {
      "enum": [
        "2017"
      ],
      "type": "string",
      "description": "Also map the code to an earlier NAICS revision. Currently 2017 only. The Census concordance covers 6-digit national industries."
    }
  }
}

{
  "type": "object",
  "required": [],
  "properties": {
    "code": {
      "type": "string",
      "description": "NAICS code, 2 to 6 digits. Required unless title is provided."
    },
    "codes": {
      "type": "string",
      "description": "Comma-separated NAICS codes for batch lookup. Maximum 50 on Developer, 500 on Business and above."
    },
    "framework": {
      "enum": [
        "kyb",
        "card",
        "lending"
      ],
      "type": "string",
      "default": "kyb",
      "description": "Risk lens to apply."
    }
  }
}

{
  "type": "object",
  "required": [],
  "properties": {
    "code": {
      "type": "string",
      "description": "NAICS code, 2 to 6 digits. Required unless title is provided."
    },
    "codes": {
      "type": "string",
      "description": "Comma-separated NAICS codes for batch lookup. Maximum 50 on Developer, 500 on Business and above."
    },
    "revenue": {
      "type": "number",
      "description": "Annual receipts in USD. When supplied, the response includes a small-business eligibility verdict."
    },
    "employees": {
      "type": "integer",
      "description": "Employee count. Used when the size standard for the code is employee-based."
    }
  }
}

{
  "type": "object",
  "required": [
    "query"
  ],
  "properties": {
    "query": {
      "type": "string",
      "description": "Query text to extract nutrition information."
    }
  }
}

{
  "type": "object",
  "required": [],
  "properties": {
    "upc": {
      "type": "string",
      "description": "The UPC/EAN barcode of a product for an exact lookup. Returns a single product."
    },
    "name": {
      "type": "string",
      "description": "Product name to search for (e.g. chocolate chip cookies). Returns a ranked list of matching products."
    },
    "brand": {
      "type": "string",
      "description": "Brand name to search for (e.g. Oreo). Can be combined with name to narrow results."
    },
    "limit": {
      "type": "integer",
      "default": 10,
      "maximum": 50,
      "minimum": 1,
      "description": "Maximum number of results for a name or brand search. Default 10, maximum 50."
    },
    "offset": {
      "type": "integer",
      "default": 0,
      "minimum": 0,
      "description": "Number of results to skip when paging through a name or brand search. Default 0. Paging is limited to the first 1000 results."
    }
  }
}

{
  "type": "object",
  "required": [
    "query",
    "quantity"
  ],
  "properties": {
    "query": {
      "type": "string",
      "description": "A single string containing the food item to be queried."
    },
    "quantity": {
      "type": "string",
      "description": "A string indicating the quantity of the item in question. Supports various units of measurements (e.g., \"1 cup\", \"2 lbs\", \"100g\", \"2 tbsp\")."
    }
  }
}

{
  "type": "object",
  "required": [],
  "properties": {
    "type": {
      "enum": [
        "wti",
        "brent",
        "natural_gas",
        "gasoline",
        "diesel"
      ],
      "type": "string",
      "default": "wti",
      "description": "The benchmark to return. Defaults to wti. crude_oil, brent_crude_oil, gasoline_rbob, and heating_oil are also accepted as aliases."
    },
    "unit": {
      "enum": [
        "barrel",
        "gallon",
        "liter",
        "cubic_meter",
        "MMBtu",
        "MWh",
        "GJ",
        "therm"
      ],
      "type": "string",
      "description": "Target unit to convert the price into. Must match the benchmark's dimension: crude oil, gasoline, and diesel (volume) accept barrel, gallon, liter, or cubic_meter; natural_gas (energy) accepts MMBtu, MWh, GJ, or therm. Premium feature."
    },
    "types": {
      "type": "string",
      "example": "wti,brent,natural_gas",
      "description": "Comma-separated list of benchmarks for a batch request. Available to Business, Professional, and Enterprise subscribers, or any annual plan."
    },
    "currency": {
      "type": "string",
      "example": "EUR",
      "description": "ISO 4217 currency code to convert the price into (e.g., EUR, GBP, INR). Premium feature."
    }
  }
}

{
  "type": "object",
  "required": [],
  "properties": {
    "city": {
      "type": "string",
      "description": "Post office or locality name to search in reverse, as returned in the city field, e.g. Connaught Place. To list a whole city, use district. Premium only."
    },
    "state": {
      "type": "string",
      "description": "State or union territory to search in reverse, e.g. Maharashtra. Premium only."
    },
    "pincode": {
      "type": "string",
      "description": "The six-digit Indian PIN code (Postal Index Number) to look up."
    },
    "district": {
      "type": "string",
      "description": "District to search in reverse, e.g. Pune. Premium only."
    }
  }
}

{
  "type": "object",
  "required": [],
  "properties": {
    "offset": {
      "type": "integer",
      "description": "Offset results for pagination."
    },
    "country": {
      "type": "string",
      "description": "Country name (case-insensitive) or 2-letter ISO-3166 alpha-2 code of the country. E.g. Japan or JP."
    },
    "max_population": {
      "type": "integer",
      "description": "Maximum population of country."
    },
    "min_population": {
      "type": "integer",
      "description": "Minimum population of country."
    }
  }
}

{
  "type": "object",
  "required": [],
  "properties": {
    "city": {
      "type": "string",
      "description": "Full name of the city to search (case-sensitive). Premium only."
    },
    "province": {
      "type": "string",
      "description": "2-letter abbreviation of the province (e.g., ON, BC, QC). Premium only."
    },
    "postal_code": {
      "type": "string",
      "description": "The postal code to look up. Accepts Canadian postal codes in 6 characters (A1A1A1) or 7 characters with a space (A1A 1A1). The space will be automatically normalized if not provided."
    }
  }
}

{
  "type": "object",
  "required": [],
  "properties": {
    "zip": {
      "type": "string",
      "description": "The ZIP Code to look up property tax rates."
    },
    "city": {
      "type": "string",
      "description": "Full name of the city to search (case-sensitive)."
    },
    "state": {
      "type": "string",
      "description": "2-letter abbreviation of the state (case-insensitive)."
    },
    "county": {
      "type": "string",
      "description": "The name of the county for which property tax data is being requested."
    }
  }
}

{
  "type": "object",
  "required": [
    "country"
  ],
  "properties": {
    "year": {
      "type": "integer",
      "maximum": 2050,
      "minimum": 1980,
      "description": "Calendar year between 1980 and 2050 (inclusive). Defaults to the current year. Free plans can omit it or pass the current year; other years are for premium subscribers only. Most countries cover 1980-2050; a year outside a country's range returns a 400 error listing the available years."
    },
    "country": {
      "type": "string",
      "description": "Country as a 2-letter ISO 3166-1 alpha-2 code (preferred, e.g. `US`), a 3-letter alpha-3 code (e.g. `USA`) or an English country name (e.g. `United States`). Not case-sensitive. Names must match exactly; common short names such as `UK`, `USA`, `UAE` and `South Korea` also work. An unrecognized country, or one without public holiday data, returns a 400 error."
    }
  }
}

{
  "type": "object",
  "required": [],
  "properties": {
    "limit": {
      "type": "integer",
      "default": 100,
      "maximum": 500,
      "minimum": 1,
      "description": "Maximum number of authors to return. Must be between 1 and 500. Default is 100."
    },
    "offset": {
      "type": "integer",
      "default": 0,
      "minimum": 0,
      "description": "Number of authors to skip. Used for pagination. Default is 0."
    }
  }
}

{
  "type": "object",
  "required": [],
  "properties": {}
}

{
  "type": "object",
  "required": [],
  "properties": {
    "width": {
      "type": "integer",
      "default": 640,
      "maximum": 5000,
      "minimum": 1,
      "description": "Width of the image to generate. Must be between 1 and 5000. Default value is 640. Premium only."
    },
    "height": {
      "type": "integer",
      "default": 480,
      "maximum": 5000,
      "minimum": 1,
      "description": "Height of the image to generate. Must be between 1 and 5000. Default value is 480. Premium only."
    },
    "category": {
      "enum": [
        "nature",
        "city",
        "technology",
        "food",
        "still_life",
        "abstract",
        "wildlife"
      ],
      "type": "string",
      "description": "Image category. If set, must be one of the following: nature, city, technology, food, still_life, abstract, wildlife. Premium only."
    }
  }
}

{
  "type": "object",
  "required": [],
  "properties": {
    "type": {
      "enum": [
        "noun",
        "verb",
        "adjective",
        "adverb"
      ],
      "type": "string",
      "description": "Type of word. Possible values are: noun, verb, adjective, adverb."
    },
    "limit": {
      "type": "integer",
      "default": 1,
      "maximum": 30,
      "minimum": 1,
      "description": "How many results to return. Must be between 1 and 30. Default is 1."
    }
  }
}

{
  "type": "object",
  "required": [],
  "properties": {
    "limit": {
      "type": "integer",
      "default": 1,
      "maximum": 10,
      "minimum": 1,
      "description": "Number of results to return. Must be between 1 and 10. If not set, a default value of 1 will be used. Premium subscribers only."
    },
    "title": {
      "type": "string",
      "description": "Recipe title to search for."
    },
    "offset": {
      "type": "integer",
      "minimum": 0,
      "description": "Number of results to offset for pagination. Premium subscribers only."
    },
    "ingredients": {
      "type": "string",
      "description": "Comma-separated list of ingredients to search for. Premium subscribers only."
    }
  }
}

{
  "type": "object",
  "required": [
    "lat",
    "lon"
  ],
  "properties": {
    "lat": {
      "type": "number",
      "format": "double",
      "description": "Latitude coordinate."
    },
    "lon": {
      "type": "number",
      "format": "double",
      "description": "Longitude coordinate."
    }
  }
}

{
  "type": "object",
  "required": [
    "word"
  ],
  "properties": {
    "word": {
      "type": "string",
      "description": "Word to look up."
    }
  }
}

{
  "type": "object",
  "required": [],
  "properties": {
    "safe": {
      "type": "boolean",
      "default": false,
      "description": "Premium subscribers only. Set safe=true to exclude riddles flagged as sexually explicit, crude, or containing profanity, slurs, or offensive content. Defaults to false, so results are unfiltered unless you opt in. Filtering is best-effort and not a guarantee. Any value other than true/false returns an error, as does using this parameter on a free account."
    },
    "limit": {
      "type": "integer",
      "default": 1,
      "maximum": 20,
      "minimum": 1,
      "description": "Number of results to return. Must be between 1 and 20. Default is 1."
    }
  }
}

{
  "type": "object",
  "required": [],
  "properties": {
    "city": {
      "type": "string",
      "description": "City name."
    },
    "state": {
      "type": "string",
      "description": "State name."
    },
    "zip_code": {
      "type": "string",
      "description": "Valid US ZIP code."
    },
    "street_address": {
      "type": "string",
      "description": "Street address (e.g. 9641 Sunset Blvd). Used together with city and state for the most accurate lookup."
    }
  }
}

{
  "type": "object",
  "required": [
    "ticker"
  ],
  "properties": {
    "limit": {
      "type": "integer",
      "example": 12,
      "maximum": 200,
      "minimum": 1,
      "description": "Number of historical settlement dates to return, 1 to 200. Defaults to 12. The free tier is limited to the latest date."
    },
    "ticker": {
      "type": "string",
      "example": "GME",
      "description": "The stock or ETF ticker symbol (e.g., GME)."
    },
    "settlement_date": {
      "type": "string",
      "format": "date",
      "example": "2026-07-31",
      "description": "Return a specific settlement date in YYYY-MM-DD format. Short interest settles on the 15th and the last business day of each month."
    }
  }
}

{
  "type": "object",
  "required": [],
  "properties": {
    "year": {
      "type": "integer",
      "example": 2026,
      "description": "Restrict to one calendar year (2018 onward)."
    },
    "limit": {
      "type": "integer",
      "example": 24,
      "maximum": 120,
      "minimum": 1,
      "description": "Number of dates to return, 1 to 120. Defaults to 24 (one year)."
    },
    "upcoming": {
      "enum": [
        "true",
        "false"
      ],
      "type": "string",
      "description": "Set true to return only future, not-yet-published settlement dates in ascending order."
    }
  }
}

{
  "type": "object",
  "required": [
    "ticker"
  ],
  "properties": {
    "limit": {
      "type": "integer",
      "example": 30,
      "maximum": 250,
      "minimum": 1,
      "description": "Number of trading days to return, 1 to 250. Defaults to 30. The free tier is limited to the latest day."
    },
    "ticker": {
      "type": "string",
      "example": "GME",
      "description": "The stock or ETF ticker symbol (e.g., GME)."
    }
  }
}

{
  "type": "object",
  "required": [
    "sort_code"
  ],
  "properties": {
    "sort_code": {
      "type": "string",
      "description": "The 6-digit UK sort code, with or without hyphens (e.g. 20-00-00 or 200000)."
    }
  }
}

{
  "type": "object",
  "required": [],
  "properties": {
    "name": {
      "type": "string",
      "description": "Full or partial player name (case and accent insensitive)."
    },
    "team": {
      "type": "string",
      "example": "BOS",
      "description": "Team id, abbreviation or name: the team's current roster."
    },
    "limit": {
      "type": "integer",
      "description": "Results per page (1-500). Premium only. Default 50."
    },
    "league": {
      "enum": [
        "nfl",
        "nba",
        "nhl"
      ],
      "type": "string",
      "example": "nba",
      "description": "nfl, nba or nhl."
    },
    "offset": {
      "type": "integer",
      "description": "Results to skip, for paging."
    },
    "position": {
      "type": "string",
      "description": "Only this position, e.g. QB, G, C."
    },
    "player_id": {
      "type": "string",
      "description": "Return one player."
    }
  }
}

{
  "type": "object",
  "required": [
    "league"
  ],
  "properties": {
    "league": {
      "enum": [
        "nfl",
        "nba",
        "nhl"
      ],
      "type": "string",
      "example": "nhl",
      "description": "nfl, nba or nhl."
    },
    "season": {
      "type": "integer",
      "example": 2026,
      "description": "Season as the year it starts. Defaults to the current season."
    },
    "division": {
      "type": "string",
      "example": "Atlantic",
      "description": "Only this division, e.g. AFC East or Atlantic."
    },
    "conference": {
      "type": "string",
      "description": "Only this conference, e.g. AFC or Eastern."
    }
  }
}

{
  "type": "object",
  "required": [],
  "properties": {
    "mic": {
      "type": "string",
      "description": "Market Identifier Code (e.g., XNYS)."
    },
    "city": {
      "type": "string",
      "description": "City where the exchange is located."
    },
    "name": {
      "type": "string",
      "description": "Stock exchange name (supports partial matching)."
    },
    "country": {
      "type": "string",
      "description": "Country code in ISO2 format (e.g., US)."
    }
  }
}

{
  "type": "object",
  "required": [],
  "properties": {
    "mic": {
      "type": "string",
      "description": "Market Identifier Code (e.g., XNYS). Filters results to a specific exchange."
    },
    "name": {
      "type": "string",
      "description": "Stock exchange name (supports partial matching)."
    }
  }
}

{
  "type": "object",
  "required": [],
  "properties": {
    "mic": {
      "type": "string",
      "description": "Market Identifier Code (e.g., XNYS). If not set, returns data for all exchanges."
    },
    "date": {
      "type": "string",
      "format": "date",
      "description": "Date in yyyy-mm-dd format. Returns whether exchanges are open on that date and the trading hours. Must not be combined with timestamp."
    },
    "timestamp": {
      "type": "integer",
      "description": "Unix timestamp in seconds. Returns whether exchanges are open at that exact moment in time and the trading hours. Must not be combined with date."
    }
  }
}

{
  "type": "object",
  "required": [],
  "properties": {
    "date": {
      "type": "string",
      "format": "date",
      "description": "Filter to a single calendar day (UTC). Format YYYY-MM-DD. Mutually exclusive with start_date/end_date."
    },
    "offset": {
      "type": "integer",
      "default": 0,
      "maximum": 10000,
      "minimum": 0,
      "description": "Pagination offset. Each page has 50 results. Maximum 10000."
    },
    "ticker": {
      "type": "string",
      "description": "Single ticker (e.g., AAPL) or comma-separated tickers (e.g., AAPL,MSFT). If omitted, the most recent news across all publishers is returned."
    },
    "end_date": {
      "type": "string",
      "format": "date",
      "description": "Inclusive upper bound on published date (UTC). Format YYYY-MM-DD."
    },
    "start_date": {
      "type": "string",
      "format": "date",
      "description": "Inclusive lower bound on published date (UTC). Format YYYY-MM-DD."
    }
  }
}

{
  "type": "object",
  "required": [],
  "properties": {
    "limit": {
      "type": "integer",
      "default": 100,
      "maximum": 1000,
      "minimum": 1,
      "description": "Number of results to return. Must be between 1 and 1000. Default is 100."
    },
    "offset": {
      "type": "integer",
      "default": 0,
      "description": "Number of results to offset for pagination. Default is 0."
    }
  }
}

{
  "type": "object",
  "required": [
    "word"
  ],
  "properties": {
    "word": {
      "type": "string",
      "description": "Word to look up."
    }
  }
}

{
  "type": "object",
  "required": [
    "ticker"
  ],
  "properties": {
    "ticker": {
      "type": "string",
      "description": "Stock ticker symbol (e.g., AAPL)."
    }
  }
}

{
  "type": "object",
  "required": [],
  "properties": {
    "lat": {
      "type": "string",
      "description": "Latitude of desired location."
    },
    "lon": {
      "type": "string",
      "description": "Longitude of desired location."
    },
    "city": {
      "type": "string",
      "description": "City name."
    },
    "state": {
      "type": "string",
      "description": "US state (for United States cities only)."
    },
    "country": {
      "type": "string",
      "description": "Country name."
    },
    "timezone": {
      "type": "string",
      "description": "Timezone name."
    }
  }
}

{
  "type": "object",
  "required": [],
  "properties": {
    "date": {
      "type": "string",
      "description": "Business day (YYYY-MM-DD). Defaults to latest. Deep past dates are premium."
    },
    "type": {
      "enum": [
        "par",
        "real",
        "bill",
        "all"
      ],
      "type": "string",
      "default": "par",
      "description": "Curve type: par (default), real, bill, or all (combined; premium)."
    },
    "format": {
      "enum": [
        "json",
        "csv"
      ],
      "type": "string",
      "default": "json",
      "description": "json (default) or csv."
    }
  }
}

{
  "type": "object",
  "required": [],
  "properties": {
    "type": {
      "enum": [
        "par",
        "real",
        "bill"
      ],
      "type": "string",
      "default": "par",
      "description": "Curve type: par (default), real, or bill."
    },
    "format": {
      "enum": [
        "json",
        "csv"
      ],
      "type": "string",
      "default": "json",
      "description": "json (default) or csv."
    },
    "end_date": {
      "type": "string",
      "description": "End of range (YYYY-MM-DD)."
    },
    "maturity": {
      "type": "string",
      "description": "Single maturity code (e.g. year_10, week_13). Omit for full-curve history (premium)."
    },
    "start_date": {
      "type": "string",
      "description": "Start of range (YYYY-MM-DD)."
    }
  }
}

{
  "type": "object",
  "required": [],
  "properties": {
    "safe": {
      "type": "boolean",
      "default": false,
      "description": "Premium subscribers only. Set safe=true to exclude questions flagged as sexually explicit, crude, or containing profanity or slurs. Defaults to false, so results are unfiltered unless you opt in. Filtering is best-effort and not a guarantee. Any value other than true/false returns an error, as does using this parameter on a free account."
    },
    "limit": {
      "type": "integer",
      "default": 1,
      "maximum": 30,
      "minimum": 1,
      "description": "How many results to return. Must be between 1 and 30. Default is 1."
    },
    "category": {
      "enum": [
        "artliterature",
        "language",
        "sciencenature",
        "general",
        "fooddrink",
        "peopleplaces",
        "geography",
        "historyholidays",
        "entertainment",
        "toysgames",
        "music",
        "mathematics",
        "religionmythology",
        "sportsleisure"
      ],
      "type": "string",
      "description": "Category of trivia. The possible values are: artliterature, language, sciencenature, general, fooddrink, peopleplaces, geography, historyholidays, entertainment, toysgames, music, mathematics, religionmythology, sportsleisure."
    }
  }
}

{
  "type": "object",
  "required": [],
  "properties": {}
}

{
  "type": "object",
  "required": [],
  "properties": {
    "year": {
      "type": "integer",
      "description": "Year for which to retrieve unemployment data."
    },
    "country": {
      "type": "string",
      "description": "Country name (case-insensitive) or 2-letter ISO-3166 alpha-2 code of the country. E.g. 'Canada' or 'CA'."
    }
  }
}

{
  "type": "object",
  "required": [
    "url"
  ],
  "properties": {
    "url": {
      "type": "string",
      "description": "Valid URL to check. It supports schemes (e.g. http://example.com) as well as schemeless (e.g. example.com) formats."
    }
  }
}

{
  "type": "object",
  "required": [
    "country"
  ],
  "properties": {
    "type": {
      "enum": [
        "standard",
        "reduced",
        "super_reduced",
        "exempted",
        "parking"
      ],
      "type": "string",
      "description": "VAT rate type."
    },
    "limit": {
      "type": "integer",
      "default": 5,
      "maximum": 30,
      "minimum": 1,
      "description": "Number of results to return (1-30). Default is 5."
    },
    "offset": {
      "type": "integer",
      "default": 0,
      "description": "Number of results to offset for pagination. Default is 0."
    },
    "country": {
      "type": "string",
      "description": "Two-letter country code (ISO 3166-1 alpha-2)."
    },
    "max_date": {
      "type": "string",
      "format": "date",
      "description": "Filter results before this date (YYYY-MM-DD format)."
    },
    "min_date": {
      "type": "string",
      "format": "date",
      "description": "Filter results after this date (YYYY-MM-DD format)."
    }
  }
}

{
  "type": "object",
  "required": [],
  "properties": {
    "lat": {
      "type": "string",
      "description": "Latitude of desired location."
    },
    "lon": {
      "type": "string",
      "description": "Longitude of desired location."
    },
    "zip": {
      "type": "string",
      "description": "5 digit Zip code (United States only). Premium subscribers only."
    },
    "city": {
      "type": "string",
      "description": "City name. Premium subscribers only."
    },
    "state": {
      "type": "string",
      "description": "US state (for United States cities only). Premium subscribers only."
    },
    "country": {
      "type": "string",
      "description": "Country name. Premium subscribers only."
    }
  }
}

{
  "type": "object",
  "required": [],
  "properties": {}
}

{
  "type": "object",
  "required": [
    "url"
  ],
  "properties": {
    "url": {
      "type": "string",
      "description": "URL to retrieve information from."
    }
  }
}

{
  "type": "object",
  "required": [
    "domain"
  ],
  "properties": {
    "domain": {
      "type": "string",
      "description": "Valid domain to check (e.g. example.com). For top-level domains other than .com, a premium subscription is required."
    }
  }
}

{
  "type": "object",
  "required": [],
  "properties": {
    "lat": {
      "type": "string",
      "description": "Latitude of desired location. Premium subscribers only."
    },
    "lon": {
      "type": "string",
      "description": "Longitude of desired location. Premium subscribers only."
    },
    "city": {
      "type": "string",
      "description": "City name. Premium subscribers only."
    },
    "state": {
      "type": "string",
      "description": "US state (for United States cities only). Premium subscribers only."
    },
    "country": {
      "type": "string",
      "description": "Country name. Premium subscribers only."
    },
    "timezone": {
      "type": "string",
      "description": "Timezone name (e.g. Europe/London)."
    }
  }
}

{
  "type": "object",
  "required": [
    "date",
    "country"
  ],
  "properties": {
    "date": {
      "type": "string",
      "format": "date",
      "description": "Date in YYYY-MM-DD format (e.g. 2025-12-25). Dates in future calendar years are for premium subscribers only; Free plans can query past years and the current year."
    },
    "country": {
      "type": "string",
      "description": "Country as a 2-letter ISO 3166-1 alpha-2 code (preferred, e.g. `US`), a 3-letter alpha-3 code (e.g. `USA`) or an English country name (e.g. `United States`). Not case-sensitive. Names must match exactly; common short names such as `UK`, `USA`, `UAE` and `South Korea` also work. An unrecognized country, or one without bank holiday data, returns a 400 error."
    },
    "subdivision": {
      "type": "string",
      "description": "ISO 3166-2 code of a state, province or region (e.g. `GB-SCT`, or just its suffix). Regional holidays count only when you pass the region they apply to. An unknown code returns a 400 error."
    }
  }
}

{
  "type": "object",
  "required": [
    "date"
  ],
  "properties": {
    "date": {
      "type": "string",
      "format": "date",
      "description": "Date in YYYY-MM-DD format (e.g. 2025-12-25). Note: dates in future calendar years are for premium subscribers only."
    },
    "country": {
      "type": "string",
      "description": "Country name or ISO 3166-2 country code (preferred). If not specified, holidays from all countries are returned."
    }
  }
}

{
  "type": "object",
  "required": [
    "country",
    "date"
  ],
  "properties": {
    "date": {
      "type": "string",
      "format": "date",
      "description": "Date in YYYY-MM-DD format. Must be between 1980-01-01 and 2050-12-31 (inclusive). Dates in future calendar years are for premium subscribers only; Free plans can query past years and the current year."
    },
    "country": {
      "type": "string",
      "description": "Country as a 2-letter ISO 3166-1 alpha-2 code (preferred, e.g. `US`), a 3-letter alpha-3 code (e.g. `USA`) or an English country name (e.g. `United States`). Not case-sensitive. Names must match exactly; common short names such as `UK`, `USA`, `UAE` and `South Korea` also work. An unrecognized country, or one without public holiday data, returns a 400 error."
    },
    "subdivision": {
      "type": "string",
      "description": "ISO 3166-2 code of a state, province or region (e.g. `DE-BY`, or just its suffix). Regional holidays count only when you pass the region they apply to. An unknown code returns a 400 error."
    }
  }
}