{"openapi":"3.1.0","info":{"title":"Aristocles Data API","description":"\nFour Australian data APIs on one key — subscriptions, trade pricing, PBS drugs, and rental prices.\n\n---\n\n## Quick start\n\n**1. Get your API key** — register in one request:\n```\nPOST /v1/auth/register\n{\"email\": \"you@example.com\", \"name\": \"Your Name\"}\n```\nCopy the `api_key` from the response.\n\n**2. Authenticate** — add your key to every request as a header:\n```\nX-API-Key: ar_live_xxxxxxxxxxxx\n```\n\n**3. Run the discovery endpoint** — returns all available slugs, example calls, and your account limits:\n```\nGET /v1/discovery\n```\n\n**4. Make your first call:**\n```\nGET /v1/prices/netflix?country=AU\nGET /v1/trades/electrician/prices?state=NSW&country=AU\nGET /v1/pbs/metformin\nGET /v1/rental/VIC/Richmond\n```\n\n---\n\n## Four data domains\n\n| Domain | Base path | What it covers |\n|---|---|---|\n| **Subscription Pricing** | `/v1/prices`, `/v1/services` | 50+ SaaS & streaming services: Netflix, Spotify, Adobe, etc. |\n| **Contractor Trades** | `/v1/trades` | Plumbers, electricians, painters across AU, US, UK, CA, NZ |\n| **PBS Drug Pricing** | `/v1/pbs` | 14,000+ medications on Australia's Pharmaceutical Benefits Scheme |\n| **Rental Market** | `/v1/rental` | Median weekly rent by suburb and postcode across Australia |\n| **RBA Economic Data** | `/v1/rba` | Cash rate, AUD FX rates, CPI inflation, mortgage rates, credit aggregates |\n\n---\n\n## MCP Server\n\nAll four data domains are also available as MCP tools at:\n```\nhttps://api.aristocles.com.au/mcp/\n```\nConnect any MCP-compatible AI agent (Claude, GPT, Gemini) to get structured data without writing API calls.\n","version":"2.1.0"},"paths":{"/v1/discovery":{"get":{"tags":["Getting Started"],"summary":"Discovery Endpoint","description":"**Start here.** Returns your account info plus all available slugs and example calls.\n\nNo more guessing what to pass — this endpoint tells you everything you need to make your first request.","operationId":"discovery_endpoint_v1_discovery_get","parameters":[{"name":"X-API-Key","in":"header","required":true,"schema":{"type":"string","title":"X-Api-Key"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{},"example":{"data":{"account":{"tier":"free","daily_limit":100,"key_prefix":"ar_live_7a"},"quick_start":{"step_1":"GET /v1/discovery  ← you are here","step_2":"Pick a trade slug below, e.g. electrician","step_3":"GET /v1/trades/electrician/prices?state=NSW&country=AU","step_4":"Pick a service slug below, e.g. netflix","step_5":"GET /v1/prices/netflix?country=AU"},"trades":[{"slug":"electrician","name":"Electrician","service_count":4},{"slug":"plumber","name":"Plumber","service_count":4}],"categories":[{"slug":"streaming-video","name":"Streaming Video","service_count":15},{"slug":"music-streaming","name":"Music Streaming","service_count":6}],"popular_service_slugs":["netflix","spotify","adobe-creative-cloud","microsoft-365"],"country_codes":["AU","US","UK","CA","NZ"],"docs":"https://api.aristocles.com.au/docs"}}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/auth/register":{"post":{"tags":["auth"],"summary":"Register","operationId":"register_v1_auth_register_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RegisterRequest"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponse_RegisterResponse_"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/auth/keys":{"get":{"tags":["auth"],"summary":"List Keys","description":"List all API keys for the authenticated customer.","operationId":"list_keys_v1_auth_keys_get","parameters":[{"name":"X-API-Key","in":"header","required":true,"schema":{"type":"string","title":"X-Api-Key"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponse_list_ApiKeyOut__"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"post":{"tags":["auth"],"summary":"Create Key","description":"Create an additional API key.","operationId":"create_key_v1_auth_keys_post","parameters":[{"name":"X-API-Key","in":"header","required":true,"schema":{"type":"string","title":"X-Api-Key"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateKeyRequest"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponse_dict_"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/auth/keys/{prefix}":{"delete":{"tags":["auth"],"summary":"Revoke Key","description":"Revoke an API key by its prefix.","operationId":"revoke_key_v1_auth_keys__prefix__delete","parameters":[{"name":"prefix","in":"path","required":true,"schema":{"type":"string","title":"Prefix"}},{"name":"X-API-Key","in":"header","required":true,"schema":{"type":"string","title":"X-Api-Key"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/billing/checkout":{"post":{"tags":["billing"],"summary":"Create Checkout","description":"Create a Stripe Checkout session for a subscription upgrade.","operationId":"create_checkout_v1_billing_checkout_post","parameters":[{"name":"tier","in":"query","required":false,"schema":{"type":"string","description":"Subscription tier to upgrade to: pro or enterprise","default":"pro","title":"Tier"},"description":"Subscription tier to upgrade to: pro or enterprise"},{"name":"X-API-Key","in":"header","required":true,"schema":{"type":"string","title":"X-Api-Key"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponse_CheckoutResponse_"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/billing/portal":{"post":{"tags":["billing"],"summary":"Create Portal","description":"Create a Stripe billing portal session.","operationId":"create_portal_v1_billing_portal_post","parameters":[{"name":"X-API-Key","in":"header","required":true,"schema":{"type":"string","title":"X-Api-Key"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponse_PortalResponse_"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/billing/subscription":{"get":{"tags":["billing"],"summary":"Get Subscription","description":"Get current subscription info.","operationId":"get_subscription_v1_billing_subscription_get","parameters":[{"name":"X-API-Key","in":"header","required":true,"schema":{"type":"string","title":"X-Api-Key"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponse_SubscriptionOut_"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/billing/invoices":{"get":{"tags":["billing"],"summary":"Get Invoices","description":"Get recent invoices.","operationId":"get_invoices_v1_billing_invoices_get","parameters":[{"name":"X-API-Key","in":"header","required":true,"schema":{"type":"string","title":"X-Api-Key"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponse_list_InvoiceOut__"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/usage":{"get":{"tags":["usage"],"summary":"Usage Dashboard","description":"Get usage dashboard for the current API key.","operationId":"usage_dashboard_v1_usage_get","parameters":[{"name":"X-API-Key","in":"header","required":true,"schema":{"type":"string","title":"X-Api-Key"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponse_UsageDashboard_"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/services/by-country/{country_code}":{"get":{"tags":["services"],"summary":"Services By Country Endpoint","description":"All services available in a country with cheapest price, grouped by category.","operationId":"services_by_country_endpoint_v1_services_by_country__country_code__get","parameters":[{"name":"country_code","in":"path","required":true,"schema":{"type":"string","description":"ISO country code: AU, US, UK, CA, NZ","title":"Country Code"},"description":"ISO country code: AU, US, UK, CA, NZ","example":"AU"},{"name":"category","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Filter by category slug — get slugs from `GET /v1/categories`","title":"Category"},"description":"Filter by category slug — get slugs from `GET /v1/categories`","example":"streaming-video"},{"name":"X-API-Key","in":"header","required":true,"schema":{"type":"string","title":"X-Api-Key"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/services/calculator":{"get":{"tags":["services"],"summary":"Calculator Endpoint","description":"Calculate total monthly/yearly spend for a list of services.","operationId":"calculator_endpoint_v1_services_calculator_get","parameters":[{"name":"services","in":"query","required":true,"schema":{"type":"string","maxLength":1000,"description":"Comma-separated service slugs — get slugs from `GET /v1/services`","title":"Services"},"description":"Comma-separated service slugs — get slugs from `GET /v1/services`","example":"netflix,spotify,adobe-creative-cloud"},{"name":"country","in":"query","required":false,"schema":{"type":"string","maxLength":2,"description":"ISO country code, e.g. AU, US, GB","default":"AU","title":"Country"},"description":"ISO country code, e.g. AU, US, GB"},{"name":"X-API-Key","in":"header","required":true,"schema":{"type":"string","title":"X-Api-Key"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/services":{"get":{"tags":["services"],"summary":"List Services Endpoint","description":"List subscription services with optional filters.","operationId":"list_services_endpoint_v1_services_get","parameters":[{"name":"category","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Filter by category slug — get slugs from `GET /v1/categories`","title":"Category"},"description":"Filter by category slug — get slugs from `GET /v1/categories`","example":"streaming-video"},{"name":"country","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Filter by ISO country code: AU, US, UK, CA, NZ","title":"Country"},"description":"Filter by ISO country code: AU, US, UK, CA, NZ","example":"AU"},{"name":"search","in":"query","required":false,"schema":{"anyOf":[{"type":"string","maxLength":200},{"type":"null"}],"description":"Search by service name, e.g. netflix, spotify, adobe","title":"Search"},"description":"Search by service name, e.g. netflix, spotify, adobe"},{"name":"page","in":"query","required":false,"schema":{"type":"integer","minimum":1,"description":"Page number for pagination","default":1,"title":"Page"},"description":"Page number for pagination"},{"name":"per_page","in":"query","required":false,"schema":{"type":"integer","maximum":100,"minimum":1,"description":"Results per page (max 100)","default":20,"title":"Per Page"},"description":"Results per page (max 100)"},{"name":"X-API-Key","in":"header","required":true,"schema":{"type":"string","title":"X-Api-Key"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{},"example":{"data":{"items":[{"name":"Netflix","slug":"netflix","category_name":"Streaming Video","category_slug":"streaming-video","description":"Streaming platform with movies and TV shows","website_url":"https://netflix.com","cheapest_monthly_price":7.99,"cheapest_currency":"AUD"},{"name":"Spotify","slug":"spotify","category_name":"Music Streaming","category_slug":"music-streaming","description":"Music streaming service","website_url":"https://spotify.com","cheapest_monthly_price":11.99,"cheapest_currency":"AUD"}],"total":85,"page":1,"per_page":20,"pages":5}}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/services/{slug}":{"get":{"tags":["services"],"summary":"Get Service Endpoint","description":"Get full service detail by slug.","operationId":"get_service_endpoint_v1_services__slug__get","parameters":[{"name":"slug","in":"path","required":true,"schema":{"type":"string","description":"Service slug — get slugs from `GET /v1/services`","title":"Slug"},"description":"Service slug — get slugs from `GET /v1/services`","example":"netflix"},{"name":"X-API-Key","in":"header","required":true,"schema":{"type":"string","title":"X-Api-Key"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/prices/export":{"get":{"tags":["prices"],"summary":"Export Prices Endpoint","description":"Bulk export of all current pricing data. No pagination — full dataset.","operationId":"export_prices_endpoint_v1_prices_export_get","parameters":[{"name":"country","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Filter by ISO country code: AU, US, UK, CA, NZ","title":"Country"},"description":"Filter by ISO country code: AU, US, UK, CA, NZ","example":"AU"},{"name":"category","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Filter by category slug — get slugs from `GET /v1/categories`","title":"Category"},"description":"Filter by category slug — get slugs from `GET /v1/categories`","example":"streaming-video"},{"name":"X-API-Key","in":"header","required":true,"schema":{"type":"string","title":"X-Api-Key"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/prices/{service_slug}/timeseries":{"get":{"tags":["prices"],"summary":"Get Price Timeseries Endpoint","description":"Time-series formatted price history for graphing.","operationId":"get_price_timeseries_endpoint_v1_prices__service_slug__timeseries_get","parameters":[{"name":"service_slug","in":"path","required":true,"schema":{"type":"string","description":"Service slug — get slugs from `GET /v1/services`","title":"Service Slug"},"description":"Service slug — get slugs from `GET /v1/services`","example":"netflix"},{"name":"country","in":"query","required":false,"schema":{"type":"string","description":"ISO country code: AU, US, UK, CA, NZ","default":"AU","title":"Country"},"description":"ISO country code: AU, US, UK, CA, NZ"},{"name":"tier","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Plan tier: basic, standard, premium (returned in service detail)","title":"Tier"},"description":"Plan tier: basic, standard, premium (returned in service detail)","example":"standard"},{"name":"months","in":"query","required":false,"schema":{"type":"integer","maximum":60,"minimum":1,"description":"Number of months of history to return","default":12,"title":"Months"},"description":"Number of months of history to return"},{"name":"X-API-Key","in":"header","required":true,"schema":{"type":"string","title":"X-Api-Key"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/prices/{service_slug}":{"get":{"tags":["prices"],"summary":"Get Prices Endpoint","description":"Get current prices for a subscription service.","operationId":"get_prices_endpoint_v1_prices__service_slug__get","parameters":[{"name":"service_slug","in":"path","required":true,"schema":{"type":"string","description":"Service slug — get slugs from `GET /v1/services`","title":"Service Slug"},"description":"Service slug — get slugs from `GET /v1/services`","example":"netflix"},{"name":"country","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Filter by ISO country code: AU, US, UK, CA, NZ","title":"Country"},"description":"Filter by ISO country code: AU, US, UK, CA, NZ","example":"AU"},{"name":"tier","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Plan tier: basic, standard, premium (returned in service detail)","title":"Tier"},"description":"Plan tier: basic, standard, premium (returned in service detail)","example":"standard"},{"name":"X-API-Key","in":"header","required":true,"schema":{"type":"string","title":"X-Api-Key"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{},"example":{"data":[{"id":"3fa85f64-5717-4562-b3fc-2c963f66afa6","service_slug":"netflix","service_name":"Netflix","country_code":"AU","plan_name":"Standard with Ads","plan_tier":"basic","price_amount":7.99,"currency":"AUD","billing_period":"monthly","monthly_equivalent":7.99,"source":"netflix.com","is_current":true,"effective_date":"2024-01-01","last_verified":"2024-06-01T00:00:00Z"},{"id":"4fa85f64-5717-4562-b3fc-2c963f66afa7","service_slug":"netflix","service_name":"Netflix","country_code":"AU","plan_name":"Standard","plan_tier":"standard","price_amount":18.99,"currency":"AUD","billing_period":"monthly","monthly_equivalent":18.99,"source":"netflix.com","is_current":true,"effective_date":"2024-01-01","last_verified":"2024-06-01T00:00:00Z"}],"meta":{"timestamp":"2024-06-01T00:00:00Z","source":"aristocles-api","version":"1.0"}}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/prices/{service_slug}/history":{"get":{"tags":["prices"],"summary":"Get Price History Endpoint","description":"Get price history for a service over time.","operationId":"get_price_history_endpoint_v1_prices__service_slug__history_get","parameters":[{"name":"service_slug","in":"path","required":true,"schema":{"type":"string","description":"Service slug — get slugs from `GET /v1/services`","title":"Service Slug"},"description":"Service slug — get slugs from `GET /v1/services`","example":"netflix"},{"name":"country","in":"query","required":false,"schema":{"type":"string","description":"ISO country code: AU, US, UK, CA, NZ","default":"AU","title":"Country"},"description":"ISO country code: AU, US, UK, CA, NZ"},{"name":"tier","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Plan tier: basic, standard, premium (returned in service detail)","title":"Tier"},"description":"Plan tier: basic, standard, premium (returned in service detail)","example":"standard"},{"name":"months","in":"query","required":false,"schema":{"type":"integer","maximum":60,"minimum":1,"description":"Number of months of history to return","default":12,"title":"Months"},"description":"Number of months of history to return"},{"name":"X-API-Key","in":"header","required":true,"schema":{"type":"string","title":"X-Api-Key"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/categories":{"get":{"tags":["categories"],"summary":"List Categories Endpoint","description":"List all categories with service count.","operationId":"list_categories_endpoint_v1_categories_get","parameters":[{"name":"X-API-Key","in":"header","required":true,"schema":{"type":"string","title":"X-Api-Key"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/categories/{slug}":{"get":{"tags":["categories"],"summary":"Get Category Endpoint","description":"Get category detail with all services.","operationId":"get_category_endpoint_v1_categories__slug__get","parameters":[{"name":"slug","in":"path","required":true,"schema":{"type":"string","description":"Category slug, e.g. streaming-video, music, productivity, gaming, vpn-security","title":"Slug"},"description":"Category slug, e.g. streaming-video, music, productivity, gaming, vpn-security"},{"name":"X-API-Key","in":"header","required":true,"schema":{"type":"string","title":"X-Api-Key"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/alternatives/{service_slug}":{"get":{"tags":["alternatives"],"summary":"Get Alternatives Endpoint","description":"Find alternatives to a subscription service with price comparison.","operationId":"get_alternatives_endpoint_v1_alternatives__service_slug__get","parameters":[{"name":"service_slug","in":"path","required":true,"schema":{"type":"string","description":"Service slug — get slugs from `GET /v1/services`","title":"Service Slug"},"description":"Service slug — get slugs from `GET /v1/services`","example":"netflix"},{"name":"country","in":"query","required":false,"schema":{"type":"string","description":"ISO country code: AU, US, UK, CA, NZ","default":"AU","title":"Country"},"description":"ISO country code: AU, US, UK, CA, NZ"},{"name":"sort","in":"query","required":false,"schema":{"type":"string","description":"Sort order: price_asc, price_desc, or overlap (feature similarity)","default":"price_asc","title":"Sort"},"description":"Sort order: price_asc, price_desc, or overlap (feature similarity)"},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":20,"minimum":1,"description":"Max number of alternatives to return","default":5,"title":"Limit"},"description":"Max number of alternatives to return"},{"name":"X-API-Key","in":"header","required":true,"schema":{"type":"string","title":"X-Api-Key"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/trends/{category_slug}":{"get":{"tags":["trends"],"summary":"Get Trends Endpoint","description":"Get price trends for a spending category.","operationId":"get_trends_endpoint_v1_trends__category_slug__get","parameters":[{"name":"category_slug","in":"path","required":true,"schema":{"type":"string","description":"Category slug — get slugs from `GET /v1/categories`","title":"Category Slug"},"description":"Category slug — get slugs from `GET /v1/categories`","example":"streaming-video"},{"name":"country","in":"query","required":false,"schema":{"type":"string","description":"ISO country code: AU, US, UK, CA, NZ","default":"AU","title":"Country"},"description":"ISO country code: AU, US, UK, CA, NZ"},{"name":"months","in":"query","required":false,"schema":{"type":"integer","maximum":60,"minimum":1,"description":"Number of months of trend data to return","default":12,"title":"Months"},"description":"Number of months of trend data to return"},{"name":"X-API-Key","in":"header","required":true,"schema":{"type":"string","title":"X-Api-Key"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/trades/search":{"get":{"tags":["Contractor/Trade Pricing"],"summary":"Search Trades Endpoint","description":"Search across all trades and trade services by name.","operationId":"search_trades_endpoint_v1_trades_search_get","parameters":[{"name":"q","in":"query","required":true,"schema":{"type":"string","minLength":2,"maxLength":200,"description":"Search query for trades and services","title":"Q"},"description":"Search query for trades and services"},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":50,"minimum":1,"description":"Max results to return","default":10,"title":"Limit"},"description":"Max results to return"},{"name":"X-API-Key","in":"header","required":true,"schema":{"type":"string","title":"X-Api-Key"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/trades/compare":{"get":{"tags":["Contractor/Trade Pricing"],"summary":"Compare Trade Prices Endpoint","description":"Compare prices for a trade service across multiple states.","operationId":"compare_trade_prices_endpoint_v1_trades_compare_get","parameters":[{"name":"trade","in":"query","required":true,"schema":{"type":"string","description":"Trade slug — get slugs from `GET /v1/trades`","title":"Trade"},"description":"Trade slug — get slugs from `GET /v1/trades`","example":"electrician"},{"name":"service","in":"query","required":true,"schema":{"type":"string","description":"Trade service slug — get slugs from `GET /v1/trades/{slug}`","title":"Service"},"description":"Trade service slug — get slugs from `GET /v1/trades/{slug}`","example":"install-power-point"},{"name":"locations","in":"query","required":true,"schema":{"type":"string","description":"Comma-separated state/region codes","title":"Locations"},"description":"Comma-separated state/region codes","example":"NSW,VIC,QLD"},{"name":"country","in":"query","required":false,"schema":{"type":"string","description":"Country code: AU, US, UK, CA, NZ","default":"AU","title":"Country"},"description":"Country code: AU, US, UK, CA, NZ"},{"name":"X-API-Key","in":"header","required":true,"schema":{"type":"string","title":"X-Api-Key"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/trades/estimate":{"get":{"tags":["Contractor/Trade Pricing"],"summary":"Estimate Cost Endpoint","description":"Estimate total job cost for a trade service at a location.","operationId":"estimate_cost_endpoint_v1_trades_estimate_get","parameters":[{"name":"trade","in":"query","required":true,"schema":{"type":"string","description":"Trade slug — get slugs from `GET /v1/trades`","title":"Trade"},"description":"Trade slug — get slugs from `GET /v1/trades`","example":"electrician"},{"name":"service","in":"query","required":true,"schema":{"type":"string","description":"Trade service slug — get slugs from `GET /v1/trades/{slug}`","title":"Service"},"description":"Trade service slug — get slugs from `GET /v1/trades/{slug}`","example":"install-power-point"},{"name":"quantity","in":"query","required":false,"schema":{"type":"number","exclusiveMinimum":0,"description":"Quantity in the service's unit (hours, jobs, sqm — returned in results)","default":1.0,"title":"Quantity"},"description":"Quantity in the service's unit (hours, jobs, sqm — returned in results)","example":3.0},{"name":"postcode","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Postcode filter, e.g. 2000 (Sydney), 3000 (Melbourne), 90210 (LA)","title":"Postcode"},"description":"Postcode filter, e.g. 2000 (Sydney), 3000 (Melbourne), 90210 (LA)","example":"2000"},{"name":"suburb","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Suburb or city name, e.g. Surry Hills, Brooklyn","title":"Suburb"},"description":"Suburb or city name, e.g. Surry Hills, Brooklyn"},{"name":"state","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"State/region code: NSW, VIC, QLD, WA, SA (AU) — or CA, NY, TX (US)","title":"State"},"description":"State/region code: NSW, VIC, QLD, WA, SA (AU) — or CA, NY, TX (US)","example":"NSW"},{"name":"region","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Region name, e.g. Sydney Metro, Greater London","title":"Region"},"description":"Region name, e.g. Sydney Metro, Greater London"},{"name":"country","in":"query","required":false,"schema":{"type":"string","description":"Country code: AU, US, UK, CA, NZ","default":"AU","title":"Country"},"description":"Country code: AU, US, UK, CA, NZ"},{"name":"X-API-Key","in":"header","required":true,"schema":{"type":"string","title":"X-Api-Key"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{},"example":{"data":{"trade_name":"Electrician","service_name":"Install Power Point","location_description":"NSW (state-wide)","quantity":3.0,"unit":"per point","price_low_per_unit":80,"price_high_per_unit":150,"price_avg_per_unit":115,"estimated_low":240.0,"estimated_high":450.0,"estimated_avg":345.0,"currency":"AUD"},"meta":{"timestamp":"2024-06-01T00:00:00Z","source":"aristocles-api","version":"1.0"}}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/trades":{"get":{"tags":["Contractor/Trade Pricing"],"summary":"List Trades Endpoint","description":"List all available contractor trades with service counts.","operationId":"list_trades_endpoint_v1_trades_get","parameters":[{"name":"search","in":"query","required":false,"schema":{"anyOf":[{"type":"string","maxLength":200},{"type":"null"}],"description":"Filter trades by name","title":"Search"},"description":"Filter trades by name"},{"name":"page","in":"query","required":false,"schema":{"type":"integer","minimum":1,"description":"Page number","default":1,"title":"Page"},"description":"Page number"},{"name":"per_page","in":"query","required":false,"schema":{"type":"integer","maximum":100,"minimum":1,"description":"Results per page","default":20,"title":"Per Page"},"description":"Results per page"},{"name":"X-API-Key","in":"header","required":true,"schema":{"type":"string","title":"X-Api-Key"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{},"example":{"data":{"items":[{"slug":"carpenter","name":"Carpenter","service_count":3},{"slug":"electrician","name":"Electrician","service_count":4},{"slug":"plumber","name":"Plumber","service_count":4}],"total":10,"page":1,"per_page":20,"pages":1}}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/trades/{slug}/prices":{"get":{"tags":["Contractor/Trade Pricing"],"summary":"Get Trade Prices Endpoint","description":"Get current prices for all services under a trade, filterable by location and country.","operationId":"get_trade_prices_endpoint_v1_trades__slug__prices_get","parameters":[{"name":"slug","in":"path","required":true,"schema":{"type":"string","description":"Trade slug — get slugs from `GET /v1/trades`","title":"Slug"},"description":"Trade slug — get slugs from `GET /v1/trades`","example":"electrician"},{"name":"service","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Filter to one service slug — get slugs from `GET /v1/trades/{slug}`","title":"Service"},"description":"Filter to one service slug — get slugs from `GET /v1/trades/{slug}`","example":"install-power-point"},{"name":"postcode","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Postcode filter, e.g. 2000 (Sydney), 3000 (Melbourne)","title":"Postcode"},"description":"Postcode filter, e.g. 2000 (Sydney), 3000 (Melbourne)","example":"2000"},{"name":"suburb","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Suburb or city name, e.g. Surry Hills","title":"Suburb"},"description":"Suburb or city name, e.g. Surry Hills"},{"name":"state","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"State code: NSW, VIC, QLD, WA, SA, TAS, ACT, NT (AU)","title":"State"},"description":"State code: NSW, VIC, QLD, WA, SA, TAS, ACT, NT (AU)","example":"NSW"},{"name":"region","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Region name, e.g. Sydney Metro","title":"Region"},"description":"Region name, e.g. Sydney Metro"},{"name":"country","in":"query","required":false,"schema":{"type":"string","description":"Country code: AU, US, UK, CA, NZ","default":"AU","title":"Country"},"description":"Country code: AU, US, UK, CA, NZ"},{"name":"X-API-Key","in":"header","required":true,"schema":{"type":"string","title":"X-Api-Key"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{},"example":{"data":[{"trade_slug":"electrician","trade_name":"Electrician","service_slug":"install-power-point","service_name":"Install Power Point","state":"NSW","country_code":"AU","price_low":80,"price_high":150,"price_avg":115,"currency":"AUD","unit":"per point","source":"Service Seeking","is_current":true,"effective_date":"2024-06-01"}],"meta":{"timestamp":"2024-06-01T00:00:00Z","source":"aristocles-api","version":"1.0"}}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/trades/{slug}/cheapest-location":{"get":{"tags":["Contractor/Trade Pricing"],"summary":"Cheapest Location Endpoint","description":"Find the cheapest state/region for a given trade service in a country.","operationId":"cheapest_location_endpoint_v1_trades__slug__cheapest_location_get","parameters":[{"name":"slug","in":"path","required":true,"schema":{"type":"string","description":"Trade slug — get slugs from `GET /v1/trades`","title":"Slug"},"description":"Trade slug — get slugs from `GET /v1/trades`","example":"electrician"},{"name":"service","in":"query","required":true,"schema":{"type":"string","description":"Trade service slug — get slugs from `GET /v1/trades/{slug}`","title":"Service"},"description":"Trade service slug — get slugs from `GET /v1/trades/{slug}`","example":"hourly-rate"},{"name":"states","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Comma-separated state codes to compare (defaults to all states in country)","title":"States"},"description":"Comma-separated state codes to compare (defaults to all states in country)","example":"NSW,VIC,QLD"},{"name":"country","in":"query","required":false,"schema":{"type":"string","description":"Country code: AU, US, UK, CA, NZ","default":"AU","title":"Country"},"description":"Country code: AU, US, UK, CA, NZ"},{"name":"X-API-Key","in":"header","required":true,"schema":{"type":"string","title":"X-Api-Key"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/trades/{slug}/history":{"get":{"tags":["Contractor/Trade Pricing"],"summary":"Get Trade Price History Endpoint","description":"Historical price snapshots for a trade service, grouped by location.\n\nShows how prices have changed over time with percentage change between snapshots.\nData refreshes quarterly — use `is_current: true` to identify the latest snapshot.","operationId":"get_trade_price_history_endpoint_v1_trades__slug__history_get","parameters":[{"name":"slug","in":"path","required":true,"schema":{"type":"string","description":"Trade slug — get slugs from `GET /v1/trades`","title":"Slug"},"description":"Trade slug — get slugs from `GET /v1/trades`","example":"electrician"},{"name":"service","in":"query","required":true,"schema":{"type":"string","description":"Trade service slug — get slugs from `GET /v1/trades/{slug}`","title":"Service"},"description":"Trade service slug — get slugs from `GET /v1/trades/{slug}`","example":"hourly-rate"},{"name":"state","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Filter to a specific state, e.g. NSW, VIC","title":"State"},"description":"Filter to a specific state, e.g. NSW, VIC","example":"NSW"},{"name":"country","in":"query","required":false,"schema":{"type":"string","description":"Country code: AU, US, UK, CA, NZ","default":"AU","title":"Country"},"description":"Country code: AU, US, UK, CA, NZ"},{"name":"X-API-Key","in":"header","required":true,"schema":{"type":"string","title":"X-Api-Key"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/trades/{slug}":{"get":{"tags":["Contractor/Trade Pricing"],"summary":"Get Trade Endpoint","description":"Get trade detail with all its services.","operationId":"get_trade_endpoint_v1_trades__slug__get","parameters":[{"name":"slug","in":"path","required":true,"schema":{"type":"string","description":"Trade slug — get slugs from `GET /v1/trades`","title":"Slug"},"description":"Trade slug — get slugs from `GET /v1/trades`","example":"electrician"},{"name":"X-API-Key","in":"header","required":true,"schema":{"type":"string","title":"X-Api-Key"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/pbs/search":{"get":{"tags":["PBS Drug Pricing"],"summary":"Search PBS drugs","description":"Search PBS-listed drugs by generic or brand name.\n\nReturns PBS benefit price, patient copayment cost (general and concessional),\npack size, repeats, and therapeutic group for each matching listing.","operationId":"search_drugs_endpoint_v1_pbs_search_get","parameters":[{"name":"q","in":"query","required":true,"schema":{"type":"string","minLength":2,"maxLength":200,"description":"Drug or brand name to search","title":"Q"},"description":"Drug or brand name to search","example":"metformin"},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":100,"minimum":1,"description":"Max results","default":20,"title":"Limit"},"description":"Max results"},{"name":"X-API-Key","in":"header","required":true,"schema":{"type":"string","title":"X-Api-Key"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/pbs/copayments":{"get":{"tags":["PBS Drug Pricing"],"summary":"Get patient copayment thresholds","description":"Current PBS patient copayment thresholds.\n\nGeneral patients pay the lesser of the PBS benefit price or the general copayment cap.\nConcession card holders pay the concessional rate regardless of benefit price.\nSafety net thresholds trigger once annual spending exceeds the limit.","operationId":"copayments_endpoint_v1_pbs_copayments_get","parameters":[{"name":"X-API-Key","in":"header","required":true,"schema":{"type":"string","title":"X-Api-Key"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/pbs/categories":{"get":{"tags":["PBS Drug Pricing"],"summary":"List therapeutic groups","description":"List all PBS therapeutic groups with drug counts.","operationId":"list_categories_endpoint_v1_pbs_categories_get","parameters":[{"name":"X-API-Key","in":"header","required":true,"schema":{"type":"string","title":"X-Api-Key"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/pbs/categories/{therapeutic_group}":{"get":{"tags":["PBS Drug Pricing"],"summary":"Get drugs in a therapeutic group","description":"Get all PBS-listed drugs in a therapeutic group.","operationId":"category_drugs_endpoint_v1_pbs_categories__therapeutic_group__get","parameters":[{"name":"therapeutic_group","in":"path","required":true,"schema":{"type":"string","title":"Therapeutic Group"}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":200,"minimum":1,"description":"Max results","default":50,"title":"Limit"},"description":"Max results"},{"name":"X-API-Key","in":"header","required":true,"schema":{"type":"string","title":"X-Api-Key"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/pbs/{drug_name}":{"get":{"tags":["PBS Drug Pricing"],"summary":"Get drug pricing by name","description":"Get full PBS pricing detail for a drug — originator brand vs generics, all forms and pack sizes.\n\nPatient cost is calculated automatically:\n- General patients pay min(PBS benefit price, general copayment cap)\n- Concessional patients pay the concessional rate","operationId":"get_drug_endpoint_v1_pbs__drug_name__get","parameters":[{"name":"drug_name","in":"path","required":true,"schema":{"type":"string","title":"Drug Name"}},{"name":"X-API-Key","in":"header","required":true,"schema":{"type":"string","title":"X-Api-Key"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/rental":{"get":{"tags":["Rental Prices"],"summary":"Rental API coverage","description":"Coverage summary: which states, how many suburbs, and the latest data period.","operationId":"rental_metadata_v1_rental_get","parameters":[{"name":"X-API-Key","in":"header","required":true,"schema":{"type":"string","title":"X-Api-Key"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/rental/search":{"get":{"tags":["Rental Prices"],"summary":"Search suburbs by name","description":"Search suburbs by partial name across Australia. Returns the latest\nall-properties median rent for each match. Pass ``state`` to scope the\nsearch to one state, or omit it to search everywhere.","operationId":"search_suburbs_endpoint_v1_rental_search_get","parameters":[{"name":"q","in":"query","required":true,"schema":{"type":"string","minLength":2,"maxLength":100,"description":"Suburb name (partial match)","title":"Q"},"description":"Suburb name (partial match)","example":"Geelong"},{"name":"state","in":"query","required":false,"schema":{"anyOf":[{"type":"string","minLength":2,"maxLength":3},{"type":"null"}],"description":"Optional state code to scope the search (e.g. VIC). Omit to search all states.","title":"State"},"description":"Optional state code to scope the search (e.g. VIC). Omit to search all states.","example":"VIC"},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":50,"minimum":1,"default":20,"title":"Limit"}},{"name":"X-API-Key","in":"header","required":true,"schema":{"type":"string","title":"X-Api-Key"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/rental/cheapest":{"get":{"tags":["Rental Prices"],"summary":"Most affordable suburbs","description":"Most affordable suburbs for a given bedroom count and property type, ranked by current median weekly rent.","operationId":"cheapest_suburbs_endpoint_v1_rental_cheapest_get","parameters":[{"name":"state","in":"query","required":true,"schema":{"type":"string","minLength":2,"maxLength":3,"description":"State code","title":"State"},"description":"State code","example":"VIC"},{"name":"bedrooms","in":"query","required":true,"schema":{"type":"integer","maximum":6,"minimum":1,"description":"Number of bedrooms","title":"Bedrooms"},"description":"Number of bedrooms","example":2},{"name":"property_type","in":"query","required":false,"schema":{"type":"string","description":"flat or house","default":"flat","title":"Property Type"},"description":"flat or house","example":"flat"},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":50,"minimum":1,"default":20,"title":"Limit"}},{"name":"min_leases","in":"query","required":false,"schema":{"type":"integer","maximum":100,"minimum":1,"description":"Minimum number of leases for statistical reliability","default":5,"title":"Min Leases"},"description":"Minimum number of leases for statistical reliability"},{"name":"X-API-Key","in":"header","required":true,"schema":{"type":"string","title":"X-Api-Key"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/rental/compare":{"get":{"tags":["Rental Prices"],"summary":"Compare suburbs side by side","description":"Compare rental price history across up to 10 suburbs side by side.","operationId":"compare_suburbs_endpoint_v1_rental_compare_get","parameters":[{"name":"state","in":"query","required":true,"schema":{"type":"string","minLength":2,"maxLength":3,"title":"State"},"example":"VIC"},{"name":"suburbs","in":"query","required":true,"schema":{"type":"string","description":"Comma-separated suburb names","title":"Suburbs"},"description":"Comma-separated suburb names","example":"Richmond,South Yarra,Fitzroy"},{"name":"bedrooms","in":"query","required":false,"schema":{"anyOf":[{"type":"integer","maximum":6,"minimum":1},{"type":"null"}],"title":"Bedrooms"}},{"name":"property_type","in":"query","required":false,"schema":{"type":"string","description":"flat, house, or all","default":"all","title":"Property Type"},"description":"flat, house, or all"},{"name":"periods","in":"query","required":false,"schema":{"type":"integer","maximum":20,"minimum":1,"description":"Number of recent quarters to include","default":4,"title":"Periods"},"description":"Number of recent quarters to include"},{"name":"X-API-Key","in":"header","required":true,"schema":{"type":"string","title":"X-Api-Key"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/rental/trending":{"get":{"tags":["Rental Prices"],"summary":"Fastest rising and falling rents","description":"Suburbs with the biggest rent changes over the last year — either rising fastest or dropping most.","operationId":"trending_suburbs_endpoint_v1_rental_trending_get","parameters":[{"name":"state","in":"query","required":true,"schema":{"type":"string","minLength":2,"maxLength":3,"title":"State"},"example":"VIC"},{"name":"bedrooms","in":"query","required":false,"schema":{"anyOf":[{"type":"integer","maximum":6,"minimum":1},{"type":"null"}],"title":"Bedrooms"}},{"name":"property_type","in":"query","required":false,"schema":{"type":"string","description":"flat or house","default":"flat","title":"Property Type"},"description":"flat or house"},{"name":"direction","in":"query","required":false,"schema":{"type":"string","description":"up = fastest rising, down = biggest drops","default":"up","title":"Direction"},"description":"up = fastest rising, down = biggest drops"},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":50,"minimum":1,"default":20,"title":"Limit"}},{"name":"X-API-Key","in":"header","required":true,"schema":{"type":"string","title":"X-Api-Key"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/rental/lgas":{"get":{"tags":["Rental Prices"],"summary":"List LGA region groups","description":"List all LGA / region group names for a state.","operationId":"list_lgas_endpoint_v1_rental_lgas_get","parameters":[{"name":"state","in":"query","required":true,"schema":{"type":"string","minLength":2,"maxLength":3,"title":"State"},"example":"VIC"},{"name":"X-API-Key","in":"header","required":true,"schema":{"type":"string","title":"X-Api-Key"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/rental/postcode/{postcode}":{"get":{"tags":["Rental Prices"],"summary":"Get rental prices by postcode","description":"Rental history for all suburbs that map to a given postcode.\n\nExample: GET /v1/rental/postcode/3121   → Richmond, Burnley (VIC)\nExample: GET /v1/rental/postcode/3121?bedrooms=2&property_type=flat","operationId":"get_postcode_endpoint_v1_rental_postcode__postcode__get","parameters":[{"name":"postcode","in":"path","required":true,"schema":{"type":"string","title":"Postcode"}},{"name":"bedrooms","in":"query","required":false,"schema":{"anyOf":[{"type":"integer","maximum":6,"minimum":1},{"type":"null"}],"title":"Bedrooms"}},{"name":"property_type","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"flat, house, or all","title":"Property Type"},"description":"flat, house, or all"},{"name":"periods","in":"query","required":false,"schema":{"type":"integer","maximum":40,"minimum":1,"description":"Number of recent quarters","default":8,"title":"Periods"},"description":"Number of recent quarters"},{"name":"X-API-Key","in":"header","required":true,"schema":{"type":"string","title":"X-Api-Key"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/rental/{state}/{suburb}":{"get":{"tags":["Rental Prices"],"summary":"Get suburb rental history","description":"Full rental history for a suburb — all property types and bedroom counts,\nfor the most recent N quarters.\n\nExample: GET /v1/rental/VIC/Richmond","operationId":"get_suburb_endpoint_v1_rental__state___suburb__get","parameters":[{"name":"state","in":"path","required":true,"schema":{"type":"string","title":"State"}},{"name":"suburb","in":"path","required":true,"schema":{"type":"string","title":"Suburb"}},{"name":"bedrooms","in":"query","required":false,"schema":{"anyOf":[{"type":"integer","maximum":6,"minimum":1},{"type":"null"}],"title":"Bedrooms"}},{"name":"property_type","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"flat, house, or all","title":"Property Type"},"description":"flat, house, or all"},{"name":"periods","in":"query","required":false,"schema":{"type":"integer","maximum":40,"minimum":1,"description":"Number of recent quarters","default":8,"title":"Periods"},"description":"Number of recent quarters"},{"name":"X-API-Key","in":"header","required":true,"schema":{"type":"string","title":"X-Api-Key"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/rba":{"get":{"tags":["RBA Economic Data"],"summary":"RBA data coverage","description":"Coverage summary: categories, series counts, and latest data dates.","operationId":"rba_metadata_v1_rba_get","parameters":[{"name":"X-API-Key","in":"header","required":true,"schema":{"type":"string","title":"X-Api-Key"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/rba/series":{"get":{"tags":["RBA Economic Data"],"summary":"List all available series","description":"List all RBA data series with their latest value and date.","operationId":"list_series_endpoint_v1_rba_series_get","parameters":[{"name":"category","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Filter by category: interest_rates, exchange_rates, inflation, credit, mortgage_rates","title":"Category"},"description":"Filter by category: interest_rates, exchange_rates, inflation, credit, mortgage_rates"},{"name":"X-API-Key","in":"header","required":true,"schema":{"type":"string","title":"X-Api-Key"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/rba/cash-rate":{"get":{"tags":["RBA Economic Data"],"summary":"RBA cash rate","description":"RBA Cash Rate Target and effective overnight interbank rate.\n\nReturns the current rate and historical series. The cash rate is the key\nmonetary policy lever — it directly influences mortgage rates and the AUD.","operationId":"cash_rate_endpoint_v1_rba_cash_rate_get","parameters":[{"name":"periods","in":"query","required":false,"schema":{"type":"integer","maximum":200,"minimum":1,"description":"Number of observations to return","default":24,"title":"Periods"},"description":"Number of observations to return"},{"name":"X-API-Key","in":"header","required":true,"schema":{"type":"string","title":"X-Api-Key"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/rba/exchange-rates":{"get":{"tags":["RBA Economic Data"],"summary":"AUD exchange rates","description":"Latest AUD exchange rates against all tracked currencies.\n\nReturns the most recent rate for each currency pair. Daily data going back to 1983.\nFor full history of a specific pair, use GET /v1/rba/exchange-rates/{currency}.","operationId":"exchange_rates_endpoint_v1_rba_exchange_rates_get","parameters":[{"name":"periods","in":"query","required":false,"schema":{"type":"integer","maximum":500,"minimum":1,"description":"Number of observations","default":30,"title":"Periods"},"description":"Number of observations"},{"name":"X-API-Key","in":"header","required":true,"schema":{"type":"string","title":"X-Api-Key"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/rba/exchange-rates/{currency}":{"get":{"tags":["RBA Economic Data"],"summary":"AUD/XXX rate history","description":"Full daily history for a specific AUD currency pair.\n\nExample: GET /v1/rba/exchange-rates/USD → AUD/USD history\nSupported: USD, EUR, GBP, JPY, CNY, CAD, NZD, SGD, HKD, KRW, and more.","operationId":"exchange_rate_history_endpoint_v1_rba_exchange_rates__currency__get","parameters":[{"name":"currency","in":"path","required":true,"schema":{"type":"string","title":"Currency"}},{"name":"periods","in":"query","required":false,"schema":{"type":"integer","maximum":1000,"minimum":1,"description":"Number of daily observations","default":90,"title":"Periods"},"description":"Number of daily observations"},{"name":"X-API-Key","in":"header","required":true,"schema":{"type":"string","title":"X-Api-Key"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/rba/inflation":{"get":{"tags":["RBA Economic Data"],"summary":"Consumer Price Index (CPI)","description":"Australian CPI inflation series — headline, trimmed mean, and weighted median.\n\nQuarterly data back to 1948. Use for real-wage calculators, cost-of-living\nadjustments, and economic dashboards.","operationId":"inflation_endpoint_v1_rba_inflation_get","parameters":[{"name":"periods","in":"query","required":false,"schema":{"type":"integer","maximum":200,"minimum":1,"description":"Number of quarterly observations","default":20,"title":"Periods"},"description":"Number of quarterly observations"},{"name":"X-API-Key","in":"header","required":true,"schema":{"type":"string","title":"X-Api-Key"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/rba/mortgage-rates":{"get":{"tags":["RBA Economic Data"],"summary":"Housing lending rates","description":"RBA housing lending rate indicators — standard variable rate, fixed rates (1–3 year),\nand new loan rates.\n\nMonthly data. Use for mortgage calculators and rate comparison tools.","operationId":"mortgage_rates_endpoint_v1_rba_mortgage_rates_get","parameters":[{"name":"periods","in":"query","required":false,"schema":{"type":"integer","maximum":200,"minimum":1,"description":"Number of monthly observations","default":24,"title":"Periods"},"description":"Number of monthly observations"},{"name":"X-API-Key","in":"header","required":true,"schema":{"type":"string","title":"X-Api-Key"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/rba/credit":{"get":{"tags":["RBA Economic Data"],"summary":"Credit and lending aggregates","description":"Total credit outstanding by sector — housing, business, personal, and total.\n\nMonthly growth rates and levels. Use for macro dashboards and economic analysis.","operationId":"credit_endpoint_v1_rba_credit_get","parameters":[{"name":"periods","in":"query","required":false,"schema":{"type":"integer","maximum":200,"minimum":1,"description":"Number of monthly observations","default":24,"title":"Periods"},"description":"Number of monthly observations"},{"name":"X-API-Key","in":"header","required":true,"schema":{"type":"string","title":"X-Api-Key"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/rba/series/{series_code}":{"get":{"tags":["RBA Economic Data"],"summary":"Get any series by code","description":"Retrieve any RBA data series by its series code.\n\nUse GET /v1/rba/series to discover available codes.\n\nExample series codes:\n- `ARBAMPCNCRT` — Cash Rate Target\n- `FXRUSD` — AUD/USD daily rate\n- `GCPIAG` — Headline CPI\n- `FILRHLBVS` — Standard variable mortgage rate","operationId":"get_series_endpoint_v1_rba_series__series_code__get","parameters":[{"name":"series_code","in":"path","required":true,"schema":{"type":"string","title":"Series Code"}},{"name":"periods","in":"query","required":false,"schema":{"type":"integer","maximum":2000,"minimum":1,"description":"Number of observations (ignored if start_date set)","default":40,"title":"Periods"},"description":"Number of observations (ignored if start_date set)"},{"name":"start_date","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"date"},{"type":"null"}],"description":"Return all observations from this date (YYYY-MM-DD)","title":"Start Date"},"description":"Return all observations from this date (YYYY-MM-DD)"},{"name":"X-API-Key","in":"header","required":true,"schema":{"type":"string","title":"X-Api-Key"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/data/australian-postcodes-geolocation":{"get":{"tags":["Geospatial"],"summary":"List Australian Postcodes & Geolocation records","description":"List Australian Postcodes & Geolocation records with optional filters and pagination.\n\n**Source:** Based on data from Matthew Proctor and contributors (CC BY 4.0).\n\n**Fields returned:**\n- `postcode` (int) — The 4-digit Australian postcode.\n- `locality` (str) — The official suburb or locality name.\n- `state` (str) — The state or territory abbreviation (e.g., NSW, VIC).\n- `latitude` (float) — The GPS latitude coordinate of the locality's centre.\n- `longitude` (float) — The GPS longitude coordinate of the locality's centre.\n\n**Example:** `GET /v1/data/australian-postcodes-geolocation?limit=10&state=example`","operationId":"list_endpoint_v1_data_australian_postcodes_geolocation_get","parameters":[{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":100,"minimum":1,"description":"Max records to return (1-100).","default":25,"title":"Limit"},"description":"Max records to return (1-100)."},{"name":"offset","in":"query","required":false,"schema":{"type":"integer","minimum":0,"description":"Records to skip, for pagination.","default":0,"title":"Offset"},"description":"Records to skip, for pagination."},{"name":"state","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The state or territory abbreviation (e.g., NSW, VIC).","examples":["example"],"title":"State"},"description":"The state or territory abbreviation (e.g., NSW, VIC)."},{"name":"X-API-Key","in":"header","required":true,"schema":{"type":"string","title":"X-Api-Key"}}],"responses":{"200":{"description":"A page of Australian Postcodes & Geolocation records with pagination metadata.","content":{"application/json":{"schema":{},"example":{"data":{"items":[{"postcode":42,"locality":"example","state":"example","latitude":4.2,"longitude":4.2}],"total":1,"limit":25,"offset":0}}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/data/australian-postcodes-geolocation/search":{"get":{"tags":["Geospatial"],"summary":"Search Australian Postcodes & Geolocation by locality","description":"Search Australian Postcodes & Geolocation records by `locality` (partial, case-insensitive).\n\n**Example:** `GET /v1/data/australian-postcodes-geolocation/search?q=exa`","operationId":"search_endpoint_v1_data_australian_postcodes_geolocation_search_get","parameters":[{"name":"q","in":"query","required":true,"schema":{"type":"string","minLength":2,"maxLength":100,"description":"Case-insensitive partial match on locality.","examples":["exa"],"title":"Q"},"description":"Case-insensitive partial match on locality."},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":100,"minimum":1,"description":"Max records to return (1-100).","default":25,"title":"Limit"},"description":"Max records to return (1-100)."},{"name":"X-API-Key","in":"header","required":true,"schema":{"type":"string","title":"X-Api-Key"}}],"responses":{"200":{"description":"Matching Australian Postcodes & Geolocation records.","content":{"application/json":{"schema":{},"example":{"data":{"items":[{"postcode":42,"locality":"example","state":"example","latitude":4.2,"longitude":4.2}]}}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/data/australian-postcodes-geolocation/{key}":{"get":{"tags":["Geospatial"],"summary":"Get one Australian Postcodes & Geolocation record by postcode","description":"Fetch a single Australian Postcodes & Geolocation record by its `postcode`.\n\n**Example:** `GET /v1/data/australian-postcodes-geolocation/42`","operationId":"get_endpoint_v1_data_australian_postcodes_geolocation__key__get","parameters":[{"name":"key","in":"path","required":true,"schema":{"type":"string","description":"The postcode value to look up (case-insensitive).","examples":["42"],"title":"Key"},"description":"The postcode value to look up (case-insensitive)."},{"name":"X-API-Key","in":"header","required":true,"schema":{"type":"string","title":"X-Api-Key"}}],"responses":{"200":{"description":"A single Australian Postcodes & Geolocation record.","content":{"application/json":{"schema":{},"example":{"data":{"postcode":42,"locality":"example","state":"example","latitude":4.2,"longitude":4.2}}}}},"404":{"content":{"application/json":{"example":{"error":{"code":"NOT_FOUND","message":"No Australian Postcodes & Geolocation record for '...'."}}}},"description":"Not Found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/data/australian-public-holidays":{"get":{"tags":["Public Holidays"],"summary":"List Australian Public Holidays records","description":"List Australian Public Holidays records with optional filters and pagination.\n\n**Source:** Department of the Prime Minister and Cabinet (CC BY 4.0).\n\n**Fields returned:**\n- `holiday_date` (date) — The date of the public holiday in YYYY-MM-DD format.\n- `holiday_name` (str) — The official name of the public holiday.\n- `jurisdiction` (str) — The state or territory abbreviation (e.g., NSW, VIC, QLD).\n\n**Example:** `GET /v1/data/australian-public-holidays?limit=10&jurisdiction=example`","operationId":"list_endpoint_v1_data_australian_public_holidays_get","parameters":[{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":100,"minimum":1,"description":"Max records to return (1-100).","default":25,"title":"Limit"},"description":"Max records to return (1-100)."},{"name":"offset","in":"query","required":false,"schema":{"type":"integer","minimum":0,"description":"Records to skip, for pagination.","default":0,"title":"Offset"},"description":"Records to skip, for pagination."},{"name":"jurisdiction","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The state or territory abbreviation (e.g., NSW, VIC, QLD).","examples":["example"],"title":"Jurisdiction"},"description":"The state or territory abbreviation (e.g., NSW, VIC, QLD)."},{"name":"X-API-Key","in":"header","required":true,"schema":{"type":"string","title":"X-Api-Key"}}],"responses":{"200":{"description":"A page of Australian Public Holidays records with pagination metadata.","content":{"application/json":{"schema":{},"example":{"data":{"items":[{"holiday_date":"2026-01-01","holiday_name":"example","jurisdiction":"example"}],"total":1,"limit":25,"offset":0}}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/data/australian-public-holidays/search":{"get":{"tags":["Public Holidays"],"summary":"Search Australian Public Holidays by holiday_name","description":"Search Australian Public Holidays records by `holiday_name` (partial, case-insensitive).\n\n**Example:** `GET /v1/data/australian-public-holidays/search?q=exa`","operationId":"search_endpoint_v1_data_australian_public_holidays_search_get","parameters":[{"name":"q","in":"query","required":true,"schema":{"type":"string","minLength":2,"maxLength":100,"description":"Case-insensitive partial match on holiday_name.","examples":["exa"],"title":"Q"},"description":"Case-insensitive partial match on holiday_name."},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":100,"minimum":1,"description":"Max records to return (1-100).","default":25,"title":"Limit"},"description":"Max records to return (1-100)."},{"name":"X-API-Key","in":"header","required":true,"schema":{"type":"string","title":"X-Api-Key"}}],"responses":{"200":{"description":"Matching Australian Public Holidays records.","content":{"application/json":{"schema":{},"example":{"data":{"items":[{"holiday_date":"2026-01-01","holiday_name":"example","jurisdiction":"example"}]}}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/data/australian-public-holidays/{key}":{"get":{"tags":["Public Holidays"],"summary":"Get one Australian Public Holidays record by holiday_date","description":"Fetch a single Australian Public Holidays record by its `holiday_date`.\n\n**Example:** `GET /v1/data/australian-public-holidays/2026-01-01`","operationId":"get_endpoint_v1_data_australian_public_holidays__key__get","parameters":[{"name":"key","in":"path","required":true,"schema":{"type":"string","description":"The holiday_date value to look up (case-insensitive).","examples":["2026-01-01"],"title":"Key"},"description":"The holiday_date value to look up (case-insensitive)."},{"name":"X-API-Key","in":"header","required":true,"schema":{"type":"string","title":"X-Api-Key"}}],"responses":{"200":{"description":"A single Australian Public Holidays record.","content":{"application/json":{"schema":{},"example":{"data":{"holiday_date":"2026-01-01","holiday_name":"example","jurisdiction":"example"}}}}},"404":{"content":{"application/json":{"example":{"error":{"code":"NOT_FOUND","message":"No Australian Public Holidays record for '...'."}}}},"description":"Not Found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/data/confirmed-exoplanets-catalogue":{"get":{"tags":["Exoplanets"],"summary":"List Confirmed Exoplanets Catalogue records","description":"List Confirmed Exoplanets Catalogue records with optional filters and pagination.\n\n**Source:** This research has made use of the NASA Exoplanet Archive, which is operated by the California Institute of Technology, under contract with NASA. (Public domain (NASA data, free to use)).\n\n**Fields returned:**\n- `planet_name` (str) — Planet name\n- `host_star` (str) — Host star name\n- `discovery_year` (int) — Year of discovery\n- `discovery_method` (str) — Detection method, e.g. Transit\n- `discovery_facility` (str) — Observatory or mission that made the discovery\n- `orbital_period_days` (float) — Orbital period in days\n- `radius_earth` (float) — Planet radius in Earth radii\n- `mass_earth` (float) — Planet mass in Earth masses\n- `equilibrium_temp_k` (float) — Equilibrium temperature in Kelvin\n- `distance_parsecs` (float) — Distance from Earth in parsecs\n\n**Example:** `GET /v1/data/confirmed-exoplanets-catalogue?limit=10&discovery_year=42`","operationId":"list_endpoint_v1_data_confirmed_exoplanets_catalogue_get","parameters":[{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":100,"minimum":1,"description":"Max records to return (1-100).","default":25,"title":"Limit"},"description":"Max records to return (1-100)."},{"name":"offset","in":"query","required":false,"schema":{"type":"integer","minimum":0,"description":"Records to skip, for pagination.","default":0,"title":"Offset"},"description":"Records to skip, for pagination."},{"name":"discovery_year","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Year of discovery","examples":["42"],"title":"Discovery Year"},"description":"Year of discovery"},{"name":"discovery_method","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Detection method, e.g. Transit","examples":["example"],"title":"Discovery Method"},"description":"Detection method, e.g. Transit"},{"name":"discovery_facility","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Observatory or mission that made the discovery","examples":["example"],"title":"Discovery Facility"},"description":"Observatory or mission that made the discovery"},{"name":"host_star","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Host star name","examples":["example"],"title":"Host Star"},"description":"Host star name"},{"name":"X-API-Key","in":"header","required":true,"schema":{"type":"string","title":"X-Api-Key"}}],"responses":{"200":{"description":"A page of Confirmed Exoplanets Catalogue records with pagination metadata.","content":{"application/json":{"schema":{},"example":{"data":{"items":[{"planet_name":"example","host_star":"example","discovery_year":42,"discovery_method":"example","discovery_facility":"example","orbital_period_days":4.2,"radius_earth":4.2,"mass_earth":4.2,"equilibrium_temp_k":4.2,"distance_parsecs":4.2}],"total":1,"limit":25,"offset":0}}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/data/confirmed-exoplanets-catalogue/search":{"get":{"tags":["Exoplanets"],"summary":"Search Confirmed Exoplanets Catalogue by planet_name","description":"Search Confirmed Exoplanets Catalogue records by `planet_name` (partial, case-insensitive).\n\n**Example:** `GET /v1/data/confirmed-exoplanets-catalogue/search?q=exa`","operationId":"search_endpoint_v1_data_confirmed_exoplanets_catalogue_search_get","parameters":[{"name":"q","in":"query","required":true,"schema":{"type":"string","minLength":2,"maxLength":100,"description":"Case-insensitive partial match on planet_name.","examples":["exa"],"title":"Q"},"description":"Case-insensitive partial match on planet_name."},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":100,"minimum":1,"description":"Max records to return (1-100).","default":25,"title":"Limit"},"description":"Max records to return (1-100)."},{"name":"X-API-Key","in":"header","required":true,"schema":{"type":"string","title":"X-Api-Key"}}],"responses":{"200":{"description":"Matching Confirmed Exoplanets Catalogue records.","content":{"application/json":{"schema":{},"example":{"data":{"items":[{"planet_name":"example","host_star":"example","discovery_year":42,"discovery_method":"example","discovery_facility":"example","orbital_period_days":4.2,"radius_earth":4.2,"mass_earth":4.2,"equilibrium_temp_k":4.2,"distance_parsecs":4.2}]}}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/data/confirmed-exoplanets-catalogue/{key}":{"get":{"tags":["Exoplanets"],"summary":"Get one Confirmed Exoplanets Catalogue record by planet_name","description":"Fetch a single Confirmed Exoplanets Catalogue record by its `planet_name`.\n\n**Example:** `GET /v1/data/confirmed-exoplanets-catalogue/example`","operationId":"get_endpoint_v1_data_confirmed_exoplanets_catalogue__key__get","parameters":[{"name":"key","in":"path","required":true,"schema":{"type":"string","description":"The planet_name value to look up (case-insensitive).","examples":["example"],"title":"Key"},"description":"The planet_name value to look up (case-insensitive)."},{"name":"X-API-Key","in":"header","required":true,"schema":{"type":"string","title":"X-Api-Key"}}],"responses":{"200":{"description":"A single Confirmed Exoplanets Catalogue record.","content":{"application/json":{"schema":{},"example":{"data":{"planet_name":"example","host_star":"example","discovery_year":42,"discovery_method":"example","discovery_facility":"example","orbital_period_days":4.2,"radius_earth":4.2,"mass_earth":4.2,"equilibrium_temp_k":4.2,"distance_parsecs":4.2}}}}},"404":{"content":{"application/json":{"example":{"error":{"code":"NOT_FOUND","message":"No Confirmed Exoplanets Catalogue record for '...'."}}}},"description":"Not Found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/data/country-calling-codes":{"get":{"tags":["Utilities"],"summary":"List Country Calling Codes records","description":"List Country Calling Codes records with optional filters and pagination.\n\n**Source:** DataHub.io, country-codes (ODbL).\n\n**Fields returned:**\n- `country_name` (str) — The commonly used name of the country.\n- `iso2` (str) — The 2-letter ISO 3166-1 alpha-2 country code.\n- `iso3` (str) — The 3-letter ISO 3166-1 alpha-3 country code.\n- `calling_code` (str) — The international dialling prefix for the country (e.g., '61' for Australia).\n- `continent` (str) — The two-letter continent code (e.g., OC for Oceania).\n\n**Example:** `GET /v1/data/country-calling-codes?limit=10&continent=example`","operationId":"list_endpoint_v1_data_country_calling_codes_get","parameters":[{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":100,"minimum":1,"description":"Max records to return (1-100).","default":25,"title":"Limit"},"description":"Max records to return (1-100)."},{"name":"offset","in":"query","required":false,"schema":{"type":"integer","minimum":0,"description":"Records to skip, for pagination.","default":0,"title":"Offset"},"description":"Records to skip, for pagination."},{"name":"continent","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The two-letter continent code (e.g., OC for Oceania).","examples":["example"],"title":"Continent"},"description":"The two-letter continent code (e.g., OC for Oceania)."},{"name":"X-API-Key","in":"header","required":true,"schema":{"type":"string","title":"X-Api-Key"}}],"responses":{"200":{"description":"A page of Country Calling Codes records with pagination metadata.","content":{"application/json":{"schema":{},"example":{"data":{"items":[{"country_name":"example","iso2":"example","iso3":"example","calling_code":"example","continent":"example"}],"total":1,"limit":25,"offset":0}}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/data/country-calling-codes/search":{"get":{"tags":["Utilities"],"summary":"Search Country Calling Codes by country_name","description":"Search Country Calling Codes records by `country_name` (partial, case-insensitive).\n\n**Example:** `GET /v1/data/country-calling-codes/search?q=exa`","operationId":"search_endpoint_v1_data_country_calling_codes_search_get","parameters":[{"name":"q","in":"query","required":true,"schema":{"type":"string","minLength":2,"maxLength":100,"description":"Case-insensitive partial match on country_name.","examples":["exa"],"title":"Q"},"description":"Case-insensitive partial match on country_name."},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":100,"minimum":1,"description":"Max records to return (1-100).","default":25,"title":"Limit"},"description":"Max records to return (1-100)."},{"name":"X-API-Key","in":"header","required":true,"schema":{"type":"string","title":"X-Api-Key"}}],"responses":{"200":{"description":"Matching Country Calling Codes records.","content":{"application/json":{"schema":{},"example":{"data":{"items":[{"country_name":"example","iso2":"example","iso3":"example","calling_code":"example","continent":"example"}]}}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/data/country-calling-codes/{key}":{"get":{"tags":["Utilities"],"summary":"Get one Country Calling Codes record by iso2","description":"Fetch a single Country Calling Codes record by its `iso2`.\n\n**Example:** `GET /v1/data/country-calling-codes/example`","operationId":"get_endpoint_v1_data_country_calling_codes__key__get","parameters":[{"name":"key","in":"path","required":true,"schema":{"type":"string","description":"The iso2 value to look up (case-insensitive).","examples":["example"],"title":"Key"},"description":"The iso2 value to look up (case-insensitive)."},{"name":"X-API-Key","in":"header","required":true,"schema":{"type":"string","title":"X-Api-Key"}}],"responses":{"200":{"description":"A single Country Calling Codes record.","content":{"application/json":{"schema":{},"example":{"data":{"country_name":"example","iso2":"example","iso3":"example","calling_code":"example","continent":"example"}}}}},"404":{"content":{"application/json":{"example":{"error":{"code":"NOT_FOUND","message":"No Country Calling Codes record for '...'."}}}},"description":"Not Found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/data/emoji-directory":{"get":{"tags":["Emoji"],"summary":"List Emoji Directory records","description":"List Emoji Directory records with optional filters and pagination.\n\n**Source:** Emoji data from GitHub gemoji (MIT License) (MIT).\n\n**Fields returned:**\n- `emoji` (str) — The emoji character itself\n- `description` (str) — Plain-English name of the emoji\n- `category` (str) — Emoji category such as Smileys & Emotion or Food & Drink\n- `unicode_version` (str) — Unicode version that introduced the emoji\n- `ios_version` (str) — iOS version that first supported the emoji\n\n**Example:** `GET /v1/data/emoji-directory?limit=10&category=example`","operationId":"list_endpoint_v1_data_emoji_directory_get","parameters":[{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":100,"minimum":1,"description":"Max records to return (1-100).","default":25,"title":"Limit"},"description":"Max records to return (1-100)."},{"name":"offset","in":"query","required":false,"schema":{"type":"integer","minimum":0,"description":"Records to skip, for pagination.","default":0,"title":"Offset"},"description":"Records to skip, for pagination."},{"name":"category","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Emoji category such as Smileys & Emotion or Food & Drink","examples":["example"],"title":"Category"},"description":"Emoji category such as Smileys & Emotion or Food & Drink"},{"name":"unicode_version","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Unicode version that introduced the emoji","examples":["example"],"title":"Unicode Version"},"description":"Unicode version that introduced the emoji"},{"name":"X-API-Key","in":"header","required":true,"schema":{"type":"string","title":"X-Api-Key"}}],"responses":{"200":{"description":"A page of Emoji Directory records with pagination metadata.","content":{"application/json":{"schema":{},"example":{"data":{"items":[{"emoji":"example","description":"example","category":"example","unicode_version":"example","ios_version":"example"}],"total":1,"limit":25,"offset":0}}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/data/emoji-directory/search":{"get":{"tags":["Emoji"],"summary":"Search Emoji Directory by description","description":"Search Emoji Directory records by `description` (partial, case-insensitive).\n\n**Example:** `GET /v1/data/emoji-directory/search?q=exa`","operationId":"search_endpoint_v1_data_emoji_directory_search_get","parameters":[{"name":"q","in":"query","required":true,"schema":{"type":"string","minLength":2,"maxLength":100,"description":"Case-insensitive partial match on description.","examples":["exa"],"title":"Q"},"description":"Case-insensitive partial match on description."},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":100,"minimum":1,"description":"Max records to return (1-100).","default":25,"title":"Limit"},"description":"Max records to return (1-100)."},{"name":"X-API-Key","in":"header","required":true,"schema":{"type":"string","title":"X-Api-Key"}}],"responses":{"200":{"description":"Matching Emoji Directory records.","content":{"application/json":{"schema":{},"example":{"data":{"items":[{"emoji":"example","description":"example","category":"example","unicode_version":"example","ios_version":"example"}]}}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/data/emoji-directory/{key}":{"get":{"tags":["Emoji"],"summary":"Get one Emoji Directory record by emoji","description":"Fetch a single Emoji Directory record by its `emoji`.\n\n**Example:** `GET /v1/data/emoji-directory/example`","operationId":"get_endpoint_v1_data_emoji_directory__key__get","parameters":[{"name":"key","in":"path","required":true,"schema":{"type":"string","description":"The emoji value to look up (case-insensitive).","examples":["example"],"title":"Key"},"description":"The emoji value to look up (case-insensitive)."},{"name":"X-API-Key","in":"header","required":true,"schema":{"type":"string","title":"X-Api-Key"}}],"responses":{"200":{"description":"A single Emoji Directory record.","content":{"application/json":{"schema":{},"example":{"data":{"emoji":"example","description":"example","category":"example","unicode_version":"example","ios_version":"example"}}}}},"404":{"content":{"application/json":{"example":{"error":{"code":"NOT_FOUND","message":"No Emoji Directory record for '...'."}}}},"description":"Not Found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/data/global-airport-locations":{"get":{"tags":["Transportation"],"summary":"List Global Airport Locations records","description":"List Global Airport Locations records with optional filters and pagination.\n\n**Source:** Data provided by OurAirports (Public Domain).\n\n**Fields returned:**\n- `iata_code` (str) — 3-letter IATA airport code.\n- `name` (str) — Official name of the airport.\n- `airport_type` (str) — Type of airport (e.g., 'large_airport', 'heliport').\n- `latitude` (float) — The latitude of the airport.\n- `longitude` (float) — The longitude of the airport.\n- `elevation_ft` (int) — Elevation of the airport in feet.\n- `iso_country` (str) — ISO 3166-1 alpha-2 code of the country where the airport is located.\n- `iso_region` (str) — ISO 3166-2 code for the state or region.\n- `municipality` (str) — The city or town that the airport serves.\n\n**Example:** `GET /v1/data/global-airport-locations?limit=10&airport_type=example`","operationId":"list_endpoint_v1_data_global_airport_locations_get","parameters":[{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":100,"minimum":1,"description":"Max records to return (1-100).","default":25,"title":"Limit"},"description":"Max records to return (1-100)."},{"name":"offset","in":"query","required":false,"schema":{"type":"integer","minimum":0,"description":"Records to skip, for pagination.","default":0,"title":"Offset"},"description":"Records to skip, for pagination."},{"name":"airport_type","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Type of airport (e.g., 'large_airport', 'heliport').","examples":["example"],"title":"Airport Type"},"description":"Type of airport (e.g., 'large_airport', 'heliport')."},{"name":"iso_country","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"ISO 3166-1 alpha-2 code of the country where the airport is located.","examples":["example"],"title":"Iso Country"},"description":"ISO 3166-1 alpha-2 code of the country where the airport is located."},{"name":"iso_region","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"ISO 3166-2 code for the state or region.","examples":["example"],"title":"Iso Region"},"description":"ISO 3166-2 code for the state or region."},{"name":"X-API-Key","in":"header","required":true,"schema":{"type":"string","title":"X-Api-Key"}}],"responses":{"200":{"description":"A page of Global Airport Locations records with pagination metadata.","content":{"application/json":{"schema":{},"example":{"data":{"items":[{"iata_code":"example","name":"example","airport_type":"example","latitude":4.2,"longitude":4.2,"elevation_ft":42,"iso_country":"example","iso_region":"example","municipality":"example"}],"total":1,"limit":25,"offset":0}}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/data/global-airport-locations/search":{"get":{"tags":["Transportation"],"summary":"Search Global Airport Locations by name","description":"Search Global Airport Locations records by `name` (partial, case-insensitive).\n\n**Example:** `GET /v1/data/global-airport-locations/search?q=exa`","operationId":"search_endpoint_v1_data_global_airport_locations_search_get","parameters":[{"name":"q","in":"query","required":true,"schema":{"type":"string","minLength":2,"maxLength":100,"description":"Case-insensitive partial match on name.","examples":["exa"],"title":"Q"},"description":"Case-insensitive partial match on name."},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":100,"minimum":1,"description":"Max records to return (1-100).","default":25,"title":"Limit"},"description":"Max records to return (1-100)."},{"name":"X-API-Key","in":"header","required":true,"schema":{"type":"string","title":"X-Api-Key"}}],"responses":{"200":{"description":"Matching Global Airport Locations records.","content":{"application/json":{"schema":{},"example":{"data":{"items":[{"iata_code":"example","name":"example","airport_type":"example","latitude":4.2,"longitude":4.2,"elevation_ft":42,"iso_country":"example","iso_region":"example","municipality":"example"}]}}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/data/global-airport-locations/{key}":{"get":{"tags":["Transportation"],"summary":"Get one Global Airport Locations record by iata_code","description":"Fetch a single Global Airport Locations record by its `iata_code`.\n\n**Example:** `GET /v1/data/global-airport-locations/example`","operationId":"get_endpoint_v1_data_global_airport_locations__key__get","parameters":[{"name":"key","in":"path","required":true,"schema":{"type":"string","description":"The iata_code value to look up (case-insensitive).","examples":["example"],"title":"Key"},"description":"The iata_code value to look up (case-insensitive)."},{"name":"X-API-Key","in":"header","required":true,"schema":{"type":"string","title":"X-Api-Key"}}],"responses":{"200":{"description":"A single Global Airport Locations record.","content":{"application/json":{"schema":{},"example":{"data":{"iata_code":"example","name":"example","airport_type":"example","latitude":4.2,"longitude":4.2,"elevation_ft":42,"iso_country":"example","iso_region":"example","municipality":"example"}}}}},"404":{"content":{"application/json":{"example":{"error":{"code":"NOT_FOUND","message":"No Global Airport Locations record for '...'."}}}},"description":"Not Found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/data/global-cities-directory":{"get":{"tags":["Cities"],"summary":"List Global Cities Directory records","description":"List Global Cities Directory records with optional filters and pagination.\n\n**Source:** Data from GeoNames (geonames.org) via the datasets/world-cities project, licensed CC BY 4.0 (CC BY 4.0).\n\n**Fields returned:**\n- `geonameid` (int) — GeoNames unique identifier for the city\n- `name` (str) — City name\n- `country` (str) — Country name\n- `subcountry` (str) — State, province or region\n\n**Example:** `GET /v1/data/global-cities-directory?limit=10&country=example`","operationId":"list_endpoint_v1_data_global_cities_directory_get","parameters":[{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":100,"minimum":1,"description":"Max records to return (1-100).","default":25,"title":"Limit"},"description":"Max records to return (1-100)."},{"name":"offset","in":"query","required":false,"schema":{"type":"integer","minimum":0,"description":"Records to skip, for pagination.","default":0,"title":"Offset"},"description":"Records to skip, for pagination."},{"name":"country","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Country name","examples":["example"],"title":"Country"},"description":"Country name"},{"name":"subcountry","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"State, province or region","examples":["example"],"title":"Subcountry"},"description":"State, province or region"},{"name":"X-API-Key","in":"header","required":true,"schema":{"type":"string","title":"X-Api-Key"}}],"responses":{"200":{"description":"A page of Global Cities Directory records with pagination metadata.","content":{"application/json":{"schema":{},"example":{"data":{"items":[{"geonameid":42,"name":"example","country":"example","subcountry":"example"}],"total":1,"limit":25,"offset":0}}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/data/global-cities-directory/search":{"get":{"tags":["Cities"],"summary":"Search Global Cities Directory by name","description":"Search Global Cities Directory records by `name` (partial, case-insensitive).\n\n**Example:** `GET /v1/data/global-cities-directory/search?q=exa`","operationId":"search_endpoint_v1_data_global_cities_directory_search_get","parameters":[{"name":"q","in":"query","required":true,"schema":{"type":"string","minLength":2,"maxLength":100,"description":"Case-insensitive partial match on name.","examples":["exa"],"title":"Q"},"description":"Case-insensitive partial match on name."},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":100,"minimum":1,"description":"Max records to return (1-100).","default":25,"title":"Limit"},"description":"Max records to return (1-100)."},{"name":"X-API-Key","in":"header","required":true,"schema":{"type":"string","title":"X-Api-Key"}}],"responses":{"200":{"description":"Matching Global Cities Directory records.","content":{"application/json":{"schema":{},"example":{"data":{"items":[{"geonameid":42,"name":"example","country":"example","subcountry":"example"}]}}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/data/global-cities-directory/{key}":{"get":{"tags":["Cities"],"summary":"Get one Global Cities Directory record by geonameid","description":"Fetch a single Global Cities Directory record by its `geonameid`.\n\n**Example:** `GET /v1/data/global-cities-directory/42`","operationId":"get_endpoint_v1_data_global_cities_directory__key__get","parameters":[{"name":"key","in":"path","required":true,"schema":{"type":"string","description":"The geonameid value to look up (case-insensitive).","examples":["42"],"title":"Key"},"description":"The geonameid value to look up (case-insensitive)."},{"name":"X-API-Key","in":"header","required":true,"schema":{"type":"string","title":"X-Api-Key"}}],"responses":{"200":{"description":"A single Global Cities Directory record.","content":{"application/json":{"schema":{},"example":{"data":{"geonameid":42,"name":"example","country":"example","subcountry":"example"}}}}},"404":{"content":{"application/json":{"example":{"error":{"code":"NOT_FOUND","message":"No Global Cities Directory record for '...'."}}}},"description":"Not Found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/data/global-country-information":{"get":{"tags":["Geopolitical"],"summary":"List Global Country Information records","description":"List Global Country Information records with optional filters and pagination.\n\n**Source:** Data provided by Restcountries (ISC License).\n\n**Fields returned:**\n- `cca2` (str) — ISO 3166-1 alpha-2 country code.\n- `name_common` (str) — Commonly used name of the country.\n- `name_official` (str) — Official name of the country.\n- `region` (str) — Geographical region (e.g., Africa, Americas).\n- `subregion` (str) — Geographical subregion (e.g., Western Europe).\n- `population` (int) — Estimated population of the country.\n- `latitude` (float) — The latitude of the country's approximate geographic center.\n- `longitude` (float) — The longitude of the country's approximate geographic center.\n- `area_sqkm` (float) — Total area in square kilometers.\n\n**Example:** `GET /v1/data/global-country-information?limit=10&region=example`","operationId":"list_endpoint_v1_data_global_country_information_get","parameters":[{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":100,"minimum":1,"description":"Max records to return (1-100).","default":25,"title":"Limit"},"description":"Max records to return (1-100)."},{"name":"offset","in":"query","required":false,"schema":{"type":"integer","minimum":0,"description":"Records to skip, for pagination.","default":0,"title":"Offset"},"description":"Records to skip, for pagination."},{"name":"region","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Geographical region (e.g., Africa, Americas).","examples":["example"],"title":"Region"},"description":"Geographical region (e.g., Africa, Americas)."},{"name":"subregion","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Geographical subregion (e.g., Western Europe).","examples":["example"],"title":"Subregion"},"description":"Geographical subregion (e.g., Western Europe)."},{"name":"X-API-Key","in":"header","required":true,"schema":{"type":"string","title":"X-Api-Key"}}],"responses":{"200":{"description":"A page of Global Country Information records with pagination metadata.","content":{"application/json":{"schema":{},"example":{"data":{"items":[{"cca2":"example","name_common":"example","name_official":"example","region":"example","subregion":"example","population":42,"latitude":4.2,"longitude":4.2,"area_sqkm":4.2}],"total":1,"limit":25,"offset":0}}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/data/global-country-information/search":{"get":{"tags":["Geopolitical"],"summary":"Search Global Country Information by name_common","description":"Search Global Country Information records by `name_common` (partial, case-insensitive).\n\n**Example:** `GET /v1/data/global-country-information/search?q=exa`","operationId":"search_endpoint_v1_data_global_country_information_search_get","parameters":[{"name":"q","in":"query","required":true,"schema":{"type":"string","minLength":2,"maxLength":100,"description":"Case-insensitive partial match on name_common.","examples":["exa"],"title":"Q"},"description":"Case-insensitive partial match on name_common."},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":100,"minimum":1,"description":"Max records to return (1-100).","default":25,"title":"Limit"},"description":"Max records to return (1-100)."},{"name":"X-API-Key","in":"header","required":true,"schema":{"type":"string","title":"X-Api-Key"}}],"responses":{"200":{"description":"Matching Global Country Information records.","content":{"application/json":{"schema":{},"example":{"data":{"items":[{"cca2":"example","name_common":"example","name_official":"example","region":"example","subregion":"example","population":42,"latitude":4.2,"longitude":4.2,"area_sqkm":4.2}]}}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/data/global-country-information/{key}":{"get":{"tags":["Geopolitical"],"summary":"Get one Global Country Information record by cca2","description":"Fetch a single Global Country Information record by its `cca2`.\n\n**Example:** `GET /v1/data/global-country-information/example`","operationId":"get_endpoint_v1_data_global_country_information__key__get","parameters":[{"name":"key","in":"path","required":true,"schema":{"type":"string","description":"The cca2 value to look up (case-insensitive).","examples":["example"],"title":"Key"},"description":"The cca2 value to look up (case-insensitive)."},{"name":"X-API-Key","in":"header","required":true,"schema":{"type":"string","title":"X-Api-Key"}}],"responses":{"200":{"description":"A single Global Country Information record.","content":{"application/json":{"schema":{},"example":{"data":{"cca2":"example","name_common":"example","name_official":"example","region":"example","subregion":"example","population":42,"latitude":4.2,"longitude":4.2,"area_sqkm":4.2}}}}},"404":{"content":{"application/json":{"example":{"error":{"code":"NOT_FOUND","message":"No Global Country Information record for '...'."}}}},"description":"Not Found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/data/global-currency-exchange-rates":{"get":{"tags":["Currency Exchange Rates"],"summary":"List Global Currency Exchange Rates records","description":"List Global Currency Exchange Rates records with optional filters and pagination.\n\n**Source:** Source: U.S. Department of the Treasury, Fiscal Data (fiscaldata.treasury.gov) (Public domain (US Government work, free to use per Fiscal Data licence)).\n\n**Fields returned:**\n- `record_date` (date) — Date the rate was published in the Treasury report\n- `country` (str) — Country or issuing authority of the currency\n- `currency` (str) — Currency name, for example Dollar or Euro\n- `country_currency_desc` (str) — Combined country and currency label, for example Australia-Dollar\n- `exchange_rate` (float) — Units of the foreign currency per one US dollar\n- `effective_date` (date) — Date from which the rate applies\n- `record_calendar_year` (int) — Calendar year of the published rate\n- `record_calendar_month` (int) — Calendar month of the published rate\n\n**Example:** `GET /v1/data/global-currency-exchange-rates?limit=10&country=example`","operationId":"list_endpoint_v1_data_global_currency_exchange_rates_get","parameters":[{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":100,"minimum":1,"description":"Max records to return (1-100).","default":25,"title":"Limit"},"description":"Max records to return (1-100)."},{"name":"offset","in":"query","required":false,"schema":{"type":"integer","minimum":0,"description":"Records to skip, for pagination.","default":0,"title":"Offset"},"description":"Records to skip, for pagination."},{"name":"country","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Country or issuing authority of the currency","examples":["example"],"title":"Country"},"description":"Country or issuing authority of the currency"},{"name":"currency","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Currency name, for example Dollar or Euro","examples":["example"],"title":"Currency"},"description":"Currency name, for example Dollar or Euro"},{"name":"record_date","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Date the rate was published in the Treasury report","examples":["2026-01-01"],"title":"Record Date"},"description":"Date the rate was published in the Treasury report"},{"name":"effective_date","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Date from which the rate applies","examples":["2026-01-01"],"title":"Effective Date"},"description":"Date from which the rate applies"},{"name":"record_calendar_year","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Calendar year of the published rate","examples":["42"],"title":"Record Calendar Year"},"description":"Calendar year of the published rate"},{"name":"X-API-Key","in":"header","required":true,"schema":{"type":"string","title":"X-Api-Key"}}],"responses":{"200":{"description":"A page of Global Currency Exchange Rates records with pagination metadata.","content":{"application/json":{"schema":{},"example":{"data":{"items":[{"record_date":"2026-01-01","country":"example","currency":"example","country_currency_desc":"example","exchange_rate":4.2,"effective_date":"2026-01-01","record_calendar_year":42,"record_calendar_month":42}],"total":1,"limit":25,"offset":0}}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/data/global-currency-exchange-rates/search":{"get":{"tags":["Currency Exchange Rates"],"summary":"Search Global Currency Exchange Rates by country_currency_desc","description":"Search Global Currency Exchange Rates records by `country_currency_desc` (partial, case-insensitive).\n\n**Example:** `GET /v1/data/global-currency-exchange-rates/search?q=exa`","operationId":"search_endpoint_v1_data_global_currency_exchange_rates_search_get","parameters":[{"name":"q","in":"query","required":true,"schema":{"type":"string","minLength":2,"maxLength":100,"description":"Case-insensitive partial match on country_currency_desc.","examples":["exa"],"title":"Q"},"description":"Case-insensitive partial match on country_currency_desc."},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":100,"minimum":1,"description":"Max records to return (1-100).","default":25,"title":"Limit"},"description":"Max records to return (1-100)."},{"name":"X-API-Key","in":"header","required":true,"schema":{"type":"string","title":"X-Api-Key"}}],"responses":{"200":{"description":"Matching Global Currency Exchange Rates records.","content":{"application/json":{"schema":{},"example":{"data":{"items":[{"record_date":"2026-01-01","country":"example","currency":"example","country_currency_desc":"example","exchange_rate":4.2,"effective_date":"2026-01-01","record_calendar_year":42,"record_calendar_month":42}]}}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/data/global-currency-exchange-rates/{key}":{"get":{"tags":["Currency Exchange Rates"],"summary":"Get one Global Currency Exchange Rates record by country_currency_desc","description":"Fetch a single Global Currency Exchange Rates record by its `country_currency_desc`.\n\n**Example:** `GET /v1/data/global-currency-exchange-rates/example`","operationId":"get_endpoint_v1_data_global_currency_exchange_rates__key__get","parameters":[{"name":"key","in":"path","required":true,"schema":{"type":"string","description":"The country_currency_desc value to look up (case-insensitive).","examples":["example"],"title":"Key"},"description":"The country_currency_desc value to look up (case-insensitive)."},{"name":"X-API-Key","in":"header","required":true,"schema":{"type":"string","title":"X-Api-Key"}}],"responses":{"200":{"description":"A single Global Currency Exchange Rates record.","content":{"application/json":{"schema":{},"example":{"data":{"record_date":"2026-01-01","country":"example","currency":"example","country_currency_desc":"example","exchange_rate":4.2,"effective_date":"2026-01-01","record_calendar_year":42,"record_calendar_month":42}}}}},"404":{"content":{"application/json":{"example":{"error":{"code":"NOT_FOUND","message":"No Global Currency Exchange Rates record for '...'."}}}},"description":"Not Found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/data/global-food-nutrient-database":{"get":{"tags":["Health & Food"],"summary":"List Global Food Nutrient Database records","description":"List Global Food Nutrient Database records with optional filters and pagination.\n\n**Source:** Source: U.S. Department of Agriculture, Agricultural Research Service. (Public Domain (US Government Work)).\n\n**Fields returned:**\n- `fdc_id` (int) — The unique identifier for the food item in the FoodData Central database.\n- `description` (str) — The name or description of the food item.\n- `data_type` (str) — The type of food data (e.g., SR Legacy, Branded).\n- `brand_owner` (str) — The brand owner for branded food products.\n- `serving_size` (float) — The serving size in grams.\n- `calories_kcal` (float) — Energy content in kilocalories per 100g.\n- `protein_g` (float) — Protein content in grams per 100g.\n- `fat_g` (float) — Total fat content in grams per 100g.\n- `carbohydrates_g` (float) — Carbohydrate content in grams per 100g.\n\n**Example:** `GET /v1/data/global-food-nutrient-database?limit=10&data_type=example`","operationId":"list_endpoint_v1_data_global_food_nutrient_database_get","parameters":[{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":100,"minimum":1,"description":"Max records to return (1-100).","default":25,"title":"Limit"},"description":"Max records to return (1-100)."},{"name":"offset","in":"query","required":false,"schema":{"type":"integer","minimum":0,"description":"Records to skip, for pagination.","default":0,"title":"Offset"},"description":"Records to skip, for pagination."},{"name":"data_type","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The type of food data (e.g., SR Legacy, Branded).","examples":["example"],"title":"Data Type"},"description":"The type of food data (e.g., SR Legacy, Branded)."},{"name":"brand_owner","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The brand owner for branded food products.","examples":["example"],"title":"Brand Owner"},"description":"The brand owner for branded food products."},{"name":"X-API-Key","in":"header","required":true,"schema":{"type":"string","title":"X-Api-Key"}}],"responses":{"200":{"description":"A page of Global Food Nutrient Database records with pagination metadata.","content":{"application/json":{"schema":{},"example":{"data":{"items":[{"fdc_id":42,"description":"example","data_type":"example","brand_owner":"example","serving_size":4.2,"calories_kcal":4.2,"protein_g":4.2,"fat_g":4.2,"carbohydrates_g":4.2}],"total":1,"limit":25,"offset":0}}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/data/global-food-nutrient-database/search":{"get":{"tags":["Health & Food"],"summary":"Search Global Food Nutrient Database by description","description":"Search Global Food Nutrient Database records by `description` (partial, case-insensitive).\n\n**Example:** `GET /v1/data/global-food-nutrient-database/search?q=exa`","operationId":"search_endpoint_v1_data_global_food_nutrient_database_search_get","parameters":[{"name":"q","in":"query","required":true,"schema":{"type":"string","minLength":2,"maxLength":100,"description":"Case-insensitive partial match on description.","examples":["exa"],"title":"Q"},"description":"Case-insensitive partial match on description."},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":100,"minimum":1,"description":"Max records to return (1-100).","default":25,"title":"Limit"},"description":"Max records to return (1-100)."},{"name":"X-API-Key","in":"header","required":true,"schema":{"type":"string","title":"X-Api-Key"}}],"responses":{"200":{"description":"Matching Global Food Nutrient Database records.","content":{"application/json":{"schema":{},"example":{"data":{"items":[{"fdc_id":42,"description":"example","data_type":"example","brand_owner":"example","serving_size":4.2,"calories_kcal":4.2,"protein_g":4.2,"fat_g":4.2,"carbohydrates_g":4.2}]}}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/data/global-food-nutrient-database/{key}":{"get":{"tags":["Health & Food"],"summary":"Get one Global Food Nutrient Database record by fdc_id","description":"Fetch a single Global Food Nutrient Database record by its `fdc_id`.\n\n**Example:** `GET /v1/data/global-food-nutrient-database/42`","operationId":"get_endpoint_v1_data_global_food_nutrient_database__key__get","parameters":[{"name":"key","in":"path","required":true,"schema":{"type":"string","description":"The fdc_id value to look up (case-insensitive).","examples":["42"],"title":"Key"},"description":"The fdc_id value to look up (case-insensitive)."},{"name":"X-API-Key","in":"header","required":true,"schema":{"type":"string","title":"X-Api-Key"}}],"responses":{"200":{"description":"A single Global Food Nutrient Database record.","content":{"application/json":{"schema":{},"example":{"data":{"fdc_id":42,"description":"example","data_type":"example","brand_owner":"example","serving_size":4.2,"calories_kcal":4.2,"protein_g":4.2,"fat_g":4.2,"carbohydrates_g":4.2}}}}},"404":{"content":{"application/json":{"example":{"error":{"code":"NOT_FOUND","message":"No Global Food Nutrient Database record for '...'."}}}},"description":"Not Found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/data/global-gross-domestic-product":{"get":{"tags":["Gross Domestic Product"],"summary":"List Global Gross Domestic Product records","description":"List Global Gross Domestic Product records with optional filters and pagination.\n\n**Source:** Source: World Bank, World Development Indicators (CC BY 4.0) (CC BY 4.0).\n\n**Fields returned:**\n- `country_name` (str) — Country or aggregate region name\n- `country_code` (str) — Three-letter country code\n- `indicator_name` (str) — Name of the indicator series being reported\n- `year` (int) — Calendar year of the observation\n- `gdp_usd` (float) — Gross domestic product in current US dollars; null where not reported\n\n**Example:** `GET /v1/data/global-gross-domestic-product?limit=10&country_code=example`","operationId":"list_endpoint_v1_data_global_gross_domestic_product_get","parameters":[{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":100,"minimum":1,"description":"Max records to return (1-100).","default":25,"title":"Limit"},"description":"Max records to return (1-100)."},{"name":"offset","in":"query","required":false,"schema":{"type":"integer","minimum":0,"description":"Records to skip, for pagination.","default":0,"title":"Offset"},"description":"Records to skip, for pagination."},{"name":"country_code","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Three-letter country code","examples":["example"],"title":"Country Code"},"description":"Three-letter country code"},{"name":"country_name","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Country or aggregate region name","examples":["example"],"title":"Country Name"},"description":"Country or aggregate region name"},{"name":"year","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Calendar year of the observation","examples":["42"],"title":"Year"},"description":"Calendar year of the observation"},{"name":"X-API-Key","in":"header","required":true,"schema":{"type":"string","title":"X-Api-Key"}}],"responses":{"200":{"description":"A page of Global Gross Domestic Product records with pagination metadata.","content":{"application/json":{"schema":{},"example":{"data":{"items":[{"country_name":"example","country_code":"example","indicator_name":"example","year":42,"gdp_usd":4.2}],"total":1,"limit":25,"offset":0}}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/data/global-gross-domestic-product/search":{"get":{"tags":["Gross Domestic Product"],"summary":"Search Global Gross Domestic Product by country_name","description":"Search Global Gross Domestic Product records by `country_name` (partial, case-insensitive).\n\n**Example:** `GET /v1/data/global-gross-domestic-product/search?q=exa`","operationId":"search_endpoint_v1_data_global_gross_domestic_product_search_get","parameters":[{"name":"q","in":"query","required":true,"schema":{"type":"string","minLength":2,"maxLength":100,"description":"Case-insensitive partial match on country_name.","examples":["exa"],"title":"Q"},"description":"Case-insensitive partial match on country_name."},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":100,"minimum":1,"description":"Max records to return (1-100).","default":25,"title":"Limit"},"description":"Max records to return (1-100)."},{"name":"X-API-Key","in":"header","required":true,"schema":{"type":"string","title":"X-Api-Key"}}],"responses":{"200":{"description":"Matching Global Gross Domestic Product records.","content":{"application/json":{"schema":{},"example":{"data":{"items":[{"country_name":"example","country_code":"example","indicator_name":"example","year":42,"gdp_usd":4.2}]}}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/data/global-gross-domestic-product/{key}":{"get":{"tags":["Gross Domestic Product"],"summary":"Get one Global Gross Domestic Product record by country_code","description":"Fetch a single Global Gross Domestic Product record by its `country_code`.\n\n**Example:** `GET /v1/data/global-gross-domestic-product/example`","operationId":"get_endpoint_v1_data_global_gross_domestic_product__key__get","parameters":[{"name":"key","in":"path","required":true,"schema":{"type":"string","description":"The country_code value to look up (case-insensitive).","examples":["example"],"title":"Key"},"description":"The country_code value to look up (case-insensitive)."},{"name":"X-API-Key","in":"header","required":true,"schema":{"type":"string","title":"X-Api-Key"}}],"responses":{"200":{"description":"A single Global Gross Domestic Product record.","content":{"application/json":{"schema":{},"example":{"data":{"country_name":"example","country_code":"example","indicator_name":"example","year":42,"gdp_usd":4.2}}}}},"404":{"content":{"application/json":{"example":{"error":{"code":"NOT_FOUND","message":"No Global Gross Domestic Product record for '...'."}}}},"description":"Not Found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/data/global-power-plant-database":{"get":{"tags":["Energy & Climate"],"summary":"List Global Power Plant Database records","description":"List Global Power Plant Database records with optional filters and pagination.\n\n**Source:** World Resources Institute. 2021. Global Power Plant Database. Published on Resource Watch; http://resourcewatch.org/ (CC BY 4.0).\n\n**Fields returned:**\n- `country_code` (str) — Three-letter ISO country code\n- `name` (str) — Name of the power plant\n- `gppd_id` (str) — Global Power Plant Database ID\n- `capacity_mw` (float) — Electrical generating capacity in megawatts\n- `latitude` (float) — Latitude of the plant\n- `longitude` (float) — Longitude of the plant\n- `primary_fuel` (str) — Primary fuel type (e.g., Solar, Wind, Gas)\n- `commissioning_year` (int) — Year the plant was commissioned\n- `owner` (str) — Owner of the power plant\n\n**Example:** `GET /v1/data/global-power-plant-database?limit=10&country_code=example`","operationId":"list_endpoint_v1_data_global_power_plant_database_get","parameters":[{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":100,"minimum":1,"description":"Max records to return (1-100).","default":25,"title":"Limit"},"description":"Max records to return (1-100)."},{"name":"offset","in":"query","required":false,"schema":{"type":"integer","minimum":0,"description":"Records to skip, for pagination.","default":0,"title":"Offset"},"description":"Records to skip, for pagination."},{"name":"country_code","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Three-letter ISO country code","examples":["example"],"title":"Country Code"},"description":"Three-letter ISO country code"},{"name":"primary_fuel","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Primary fuel type (e.g., Solar, Wind, Gas)","examples":["example"],"title":"Primary Fuel"},"description":"Primary fuel type (e.g., Solar, Wind, Gas)"},{"name":"X-API-Key","in":"header","required":true,"schema":{"type":"string","title":"X-Api-Key"}}],"responses":{"200":{"description":"A page of Global Power Plant Database records with pagination metadata.","content":{"application/json":{"schema":{},"example":{"data":{"items":[{"country_code":"example","name":"example","gppd_id":"example","capacity_mw":4.2,"latitude":4.2,"longitude":4.2,"primary_fuel":"example","commissioning_year":42,"owner":"example"}],"total":1,"limit":25,"offset":0}}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/data/global-power-plant-database/search":{"get":{"tags":["Energy & Climate"],"summary":"Search Global Power Plant Database by name","description":"Search Global Power Plant Database records by `name` (partial, case-insensitive).\n\n**Example:** `GET /v1/data/global-power-plant-database/search?q=exa`","operationId":"search_endpoint_v1_data_global_power_plant_database_search_get","parameters":[{"name":"q","in":"query","required":true,"schema":{"type":"string","minLength":2,"maxLength":100,"description":"Case-insensitive partial match on name.","examples":["exa"],"title":"Q"},"description":"Case-insensitive partial match on name."},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":100,"minimum":1,"description":"Max records to return (1-100).","default":25,"title":"Limit"},"description":"Max records to return (1-100)."},{"name":"X-API-Key","in":"header","required":true,"schema":{"type":"string","title":"X-Api-Key"}}],"responses":{"200":{"description":"Matching Global Power Plant Database records.","content":{"application/json":{"schema":{},"example":{"data":{"items":[{"country_code":"example","name":"example","gppd_id":"example","capacity_mw":4.2,"latitude":4.2,"longitude":4.2,"primary_fuel":"example","commissioning_year":42,"owner":"example"}]}}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/data/global-power-plant-database/{key}":{"get":{"tags":["Energy & Climate"],"summary":"Get one Global Power Plant Database record by gppd_id","description":"Fetch a single Global Power Plant Database record by its `gppd_id`.\n\n**Example:** `GET /v1/data/global-power-plant-database/example`","operationId":"get_endpoint_v1_data_global_power_plant_database__key__get","parameters":[{"name":"key","in":"path","required":true,"schema":{"type":"string","description":"The gppd_id value to look up (case-insensitive).","examples":["example"],"title":"Key"},"description":"The gppd_id value to look up (case-insensitive)."},{"name":"X-API-Key","in":"header","required":true,"schema":{"type":"string","title":"X-Api-Key"}}],"responses":{"200":{"description":"A single Global Power Plant Database record.","content":{"application/json":{"schema":{},"example":{"data":{"country_code":"example","name":"example","gppd_id":"example","capacity_mw":4.2,"latitude":4.2,"longitude":4.2,"primary_fuel":"example","commissioning_year":42,"owner":"example"}}}}},"404":{"content":{"application/json":{"example":{"error":{"code":"NOT_FOUND","message":"No Global Power Plant Database record for '...'."}}}},"description":"Not Found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/data/global-sea-level-rise":{"get":{"tags":["Sea Level"],"summary":"List Global Sea Level Rise records","description":"List Global Sea Level Rise records with optional filters and pagination.\n\n**Source:** US EPA Climate Change Indicators (CSIRO and NOAA data), packaged by the Open Knowledge Foundation datasets project (ODC-PDDL-1.0).\n\n**Fields returned:**\n- `year` (date) — Year of observation\n- `csiro_adjusted_sea_level` (float) — CSIRO adjusted sea level change (inches)\n- `lower_error_bound` (float) — Lower error bound (inches)\n- `upper_error_bound` (float) — Upper error bound (inches)\n- `noaa_adjusted_sea_level` (float) — NOAA satellite adjusted sea level change (inches)\n\n**Example:** `GET /v1/data/global-sea-level-rise?limit=10&year=2026-01-01`","operationId":"list_endpoint_v1_data_global_sea_level_rise_get","parameters":[{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":100,"minimum":1,"description":"Max records to return (1-100).","default":25,"title":"Limit"},"description":"Max records to return (1-100)."},{"name":"offset","in":"query","required":false,"schema":{"type":"integer","minimum":0,"description":"Records to skip, for pagination.","default":0,"title":"Offset"},"description":"Records to skip, for pagination."},{"name":"year","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Year of observation","examples":["2026-01-01"],"title":"Year"},"description":"Year of observation"},{"name":"X-API-Key","in":"header","required":true,"schema":{"type":"string","title":"X-Api-Key"}}],"responses":{"200":{"description":"A page of Global Sea Level Rise records with pagination metadata.","content":{"application/json":{"schema":{},"example":{"data":{"items":[{"year":"2026-01-01","csiro_adjusted_sea_level":4.2,"lower_error_bound":4.2,"upper_error_bound":4.2,"noaa_adjusted_sea_level":4.2}],"total":1,"limit":25,"offset":0}}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/data/global-sea-level-rise/search":{"get":{"tags":["Sea Level"],"summary":"Search Global Sea Level Rise by year","description":"Search Global Sea Level Rise records by `year` (partial, case-insensitive).\n\n**Example:** `GET /v1/data/global-sea-level-rise/search?q=202`","operationId":"search_endpoint_v1_data_global_sea_level_rise_search_get","parameters":[{"name":"q","in":"query","required":true,"schema":{"type":"string","minLength":2,"maxLength":100,"description":"Case-insensitive partial match on year.","examples":["202"],"title":"Q"},"description":"Case-insensitive partial match on year."},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":100,"minimum":1,"description":"Max records to return (1-100).","default":25,"title":"Limit"},"description":"Max records to return (1-100)."},{"name":"X-API-Key","in":"header","required":true,"schema":{"type":"string","title":"X-Api-Key"}}],"responses":{"200":{"description":"Matching Global Sea Level Rise records.","content":{"application/json":{"schema":{},"example":{"data":{"items":[{"year":"2026-01-01","csiro_adjusted_sea_level":4.2,"lower_error_bound":4.2,"upper_error_bound":4.2,"noaa_adjusted_sea_level":4.2}]}}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/data/global-sea-level-rise/{key}":{"get":{"tags":["Sea Level"],"summary":"Get one Global Sea Level Rise record by year","description":"Fetch a single Global Sea Level Rise record by its `year`.\n\n**Example:** `GET /v1/data/global-sea-level-rise/2026-01-01`","operationId":"get_endpoint_v1_data_global_sea_level_rise__key__get","parameters":[{"name":"key","in":"path","required":true,"schema":{"type":"string","description":"The year value to look up (case-insensitive).","examples":["2026-01-01"],"title":"Key"},"description":"The year value to look up (case-insensitive)."},{"name":"X-API-Key","in":"header","required":true,"schema":{"type":"string","title":"X-Api-Key"}}],"responses":{"200":{"description":"A single Global Sea Level Rise record.","content":{"application/json":{"schema":{},"example":{"data":{"year":"2026-01-01","csiro_adjusted_sea_level":4.2,"lower_error_bound":4.2,"upper_error_bound":4.2,"noaa_adjusted_sea_level":4.2}}}}},"404":{"content":{"application/json":{"example":{"error":{"code":"NOT_FOUND","message":"No Global Sea Level Rise record for '...'."}}}},"description":"Not Found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/data/global-significant-earthquakes":{"get":{"tags":["Geoscience & Environment"],"summary":"List Global Significant Earthquakes records","description":"List Global Significant Earthquakes records with optional filters and pagination.\n\n**Source:** U.S. Geological Survey (Public Domain).\n\n**Fields returned:**\n- `event_id` (str) — The unique identifier for the earthquake event.\n- `event_time_utc` (str) — The time the event occurred in ISO 8601 format (UTC).\n- `latitude` (float) — The latitude of the earthquake's epicenter.\n- `longitude` (float) — The longitude of the earthquake's epicenter.\n- `depth_km` (float) — The depth of the event in kilometers.\n- `magnitude` (float) — The magnitude of the earthquake.\n- `magnitude_type` (str) — The method or scale used to calculate magnitude (e.g., 'mw', 'ml').\n- `place_description` (str) — A human-readable description of the event's location.\n- `tsunami_alert` (int) — Indicates if a tsunami alert was issued (1 for yes, 0 for no).\n- `status` (str) — The review status of the event, e.g., 'automatic' or 'reviewed'.\n\n**Example:** `GET /v1/data/global-significant-earthquakes?limit=10&magnitude_type=example`","operationId":"list_endpoint_v1_data_global_significant_earthquakes_get","parameters":[{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":100,"minimum":1,"description":"Max records to return (1-100).","default":25,"title":"Limit"},"description":"Max records to return (1-100)."},{"name":"offset","in":"query","required":false,"schema":{"type":"integer","minimum":0,"description":"Records to skip, for pagination.","default":0,"title":"Offset"},"description":"Records to skip, for pagination."},{"name":"magnitude_type","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The method or scale used to calculate magnitude (e.g., 'mw', 'ml').","examples":["example"],"title":"Magnitude Type"},"description":"The method or scale used to calculate magnitude (e.g., 'mw', 'ml')."},{"name":"tsunami_alert","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Indicates if a tsunami alert was issued (1 for yes, 0 for no).","examples":["42"],"title":"Tsunami Alert"},"description":"Indicates if a tsunami alert was issued (1 for yes, 0 for no)."},{"name":"status","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The review status of the event, e.g., 'automatic' or 'reviewed'.","examples":["example"],"title":"Status"},"description":"The review status of the event, e.g., 'automatic' or 'reviewed'."},{"name":"X-API-Key","in":"header","required":true,"schema":{"type":"string","title":"X-Api-Key"}}],"responses":{"200":{"description":"A page of Global Significant Earthquakes records with pagination metadata.","content":{"application/json":{"schema":{},"example":{"data":{"items":[{"event_id":"example","event_time_utc":"example","latitude":4.2,"longitude":4.2,"depth_km":4.2,"magnitude":4.2,"magnitude_type":"example","place_description":"example","tsunami_alert":42,"status":"example"}],"total":1,"limit":25,"offset":0}}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/data/global-significant-earthquakes/search":{"get":{"tags":["Geoscience & Environment"],"summary":"Search Global Significant Earthquakes by place_description","description":"Search Global Significant Earthquakes records by `place_description` (partial, case-insensitive).\n\n**Example:** `GET /v1/data/global-significant-earthquakes/search?q=exa`","operationId":"search_endpoint_v1_data_global_significant_earthquakes_search_get","parameters":[{"name":"q","in":"query","required":true,"schema":{"type":"string","minLength":2,"maxLength":100,"description":"Case-insensitive partial match on place_description.","examples":["exa"],"title":"Q"},"description":"Case-insensitive partial match on place_description."},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":100,"minimum":1,"description":"Max records to return (1-100).","default":25,"title":"Limit"},"description":"Max records to return (1-100)."},{"name":"X-API-Key","in":"header","required":true,"schema":{"type":"string","title":"X-Api-Key"}}],"responses":{"200":{"description":"Matching Global Significant Earthquakes records.","content":{"application/json":{"schema":{},"example":{"data":{"items":[{"event_id":"example","event_time_utc":"example","latitude":4.2,"longitude":4.2,"depth_km":4.2,"magnitude":4.2,"magnitude_type":"example","place_description":"example","tsunami_alert":42,"status":"example"}]}}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/data/global-significant-earthquakes/{key}":{"get":{"tags":["Geoscience & Environment"],"summary":"Get one Global Significant Earthquakes record by event_id","description":"Fetch a single Global Significant Earthquakes record by its `event_id`.\n\n**Example:** `GET /v1/data/global-significant-earthquakes/example`","operationId":"get_endpoint_v1_data_global_significant_earthquakes__key__get","parameters":[{"name":"key","in":"path","required":true,"schema":{"type":"string","description":"The event_id value to look up (case-insensitive).","examples":["example"],"title":"Key"},"description":"The event_id value to look up (case-insensitive)."},{"name":"X-API-Key","in":"header","required":true,"schema":{"type":"string","title":"X-Api-Key"}}],"responses":{"200":{"description":"A single Global Significant Earthquakes record.","content":{"application/json":{"schema":{},"example":{"data":{"event_id":"example","event_time_utc":"example","latitude":4.2,"longitude":4.2,"depth_km":4.2,"magnitude":4.2,"magnitude_type":"example","place_description":"example","tsunami_alert":42,"status":"example"}}}}},"404":{"content":{"application/json":{"example":{"error":{"code":"NOT_FOUND","message":"No Global Significant Earthquakes record for '...'."}}}},"description":"Not Found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/data/global-time-zones":{"get":{"tags":["Reference"],"summary":"List Global Time Zones records","description":"List Global Time Zones records with optional filters and pagination.\n\n**Source:** Denis Filipenko (https://github.com/dmfilipenko/timezones.json) (MIT).\n\n**Fields returned:**\n- `iana_name` (str) — The canonical IANA time zone name (e.g., 'Australia/Sydney').\n- `abbreviation` (str) — The common abbreviation for the time zone (e.g., 'AEST').\n- `utc_offset` (float) — The time offset from Coordinated Universal Time (UTC) in hours.\n- `is_dst` (bool) — Indicates if the time zone is currently in Daylight Saving Time.\n- `display_text` (str) — A human-readable string representing the time zone.\n\n**Example:** `GET /v1/data/global-time-zones?limit=10&utc_offset=4.2`","operationId":"list_endpoint_v1_data_global_time_zones_get","parameters":[{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":100,"minimum":1,"description":"Max records to return (1-100).","default":25,"title":"Limit"},"description":"Max records to return (1-100)."},{"name":"offset","in":"query","required":false,"schema":{"type":"integer","minimum":0,"description":"Records to skip, for pagination.","default":0,"title":"Offset"},"description":"Records to skip, for pagination."},{"name":"utc_offset","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The time offset from Coordinated Universal Time (UTC) in hours.","examples":["4.2"],"title":"Utc Offset"},"description":"The time offset from Coordinated Universal Time (UTC) in hours."},{"name":"is_dst","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Indicates if the time zone is currently in Daylight Saving Time.","examples":["True"],"title":"Is Dst"},"description":"Indicates if the time zone is currently in Daylight Saving Time."},{"name":"X-API-Key","in":"header","required":true,"schema":{"type":"string","title":"X-Api-Key"}}],"responses":{"200":{"description":"A page of Global Time Zones records with pagination metadata.","content":{"application/json":{"schema":{},"example":{"data":{"items":[{"iana_name":"example","abbreviation":"example","utc_offset":4.2,"is_dst":true,"display_text":"example"}],"total":1,"limit":25,"offset":0}}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/data/global-time-zones/search":{"get":{"tags":["Reference"],"summary":"Search Global Time Zones by display_text","description":"Search Global Time Zones records by `display_text` (partial, case-insensitive).\n\n**Example:** `GET /v1/data/global-time-zones/search?q=exa`","operationId":"search_endpoint_v1_data_global_time_zones_search_get","parameters":[{"name":"q","in":"query","required":true,"schema":{"type":"string","minLength":2,"maxLength":100,"description":"Case-insensitive partial match on display_text.","examples":["exa"],"title":"Q"},"description":"Case-insensitive partial match on display_text."},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":100,"minimum":1,"description":"Max records to return (1-100).","default":25,"title":"Limit"},"description":"Max records to return (1-100)."},{"name":"X-API-Key","in":"header","required":true,"schema":{"type":"string","title":"X-Api-Key"}}],"responses":{"200":{"description":"Matching Global Time Zones records.","content":{"application/json":{"schema":{},"example":{"data":{"items":[{"iana_name":"example","abbreviation":"example","utc_offset":4.2,"is_dst":true,"display_text":"example"}]}}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/data/global-time-zones/{key}":{"get":{"tags":["Reference"],"summary":"Get one Global Time Zones record by iana_name","description":"Fetch a single Global Time Zones record by its `iana_name`.\n\n**Example:** `GET /v1/data/global-time-zones/example`","operationId":"get_endpoint_v1_data_global_time_zones__key__get","parameters":[{"name":"key","in":"path","required":true,"schema":{"type":"string","description":"The iana_name value to look up (case-insensitive).","examples":["example"],"title":"Key"},"description":"The iana_name value to look up (case-insensitive)."},{"name":"X-API-Key","in":"header","required":true,"schema":{"type":"string","title":"X-Api-Key"}}],"responses":{"200":{"description":"A single Global Time Zones record.","content":{"application/json":{"schema":{},"example":{"data":{"iana_name":"example","abbreviation":"example","utc_offset":4.2,"is_dst":true,"display_text":"example"}}}}},"404":{"content":{"application/json":{"example":{"error":{"code":"NOT_FOUND","message":"No Global Time Zones record for '...'."}}}},"description":"Not Found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/data/global-volcanic-eruptions":{"get":{"tags":["Volcanic Eruptions"],"summary":"List Global Volcanic Eruptions records","description":"List Global Volcanic Eruptions records with optional filters and pagination.\n\n**Source:** Source: NOAA National Centers for Environmental Information, Significant Volcanic Eruption Database (public domain). (Public Domain (U.S. Government Work)).\n\n**Fields returned:**\n- `event_id` (int) — Unique identifier for the eruption event\n- `volcano_name` (str) — Name of the volcano\n- `location` (str) — Descriptive location of the volcano\n- `country` (str) — Country in which the volcano sits\n- `year` (int) — Year of the eruption; negative values indicate BCE\n- `month` (int) — Month of the eruption where known\n- `day` (int) — Day of the eruption where known\n- `latitude` (float) — Latitude in decimal degrees\n- `longitude` (float) — Longitude in decimal degrees\n- `elevation_m` (int) — Volcano summit elevation in metres\n- `morphology` (str) — Volcano type, e.g. stratovolcano, caldera, shield\n- `explosivity_index` (int) — Volcanic Explosivity Index from 0 to 8\n- `deaths_total` (int) — Total recorded deaths attributed to the eruption\n- `damage_millions_usd` (float) — Recorded economic damage in millions of US dollars\n\n**Example:** `GET /v1/data/global-volcanic-eruptions?limit=10&country=example`","operationId":"list_endpoint_v1_data_global_volcanic_eruptions_get","parameters":[{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":100,"minimum":1,"description":"Max records to return (1-100).","default":25,"title":"Limit"},"description":"Max records to return (1-100)."},{"name":"offset","in":"query","required":false,"schema":{"type":"integer","minimum":0,"description":"Records to skip, for pagination.","default":0,"title":"Offset"},"description":"Records to skip, for pagination."},{"name":"country","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Country in which the volcano sits","examples":["example"],"title":"Country"},"description":"Country in which the volcano sits"},{"name":"year","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Year of the eruption; negative values indicate BCE","examples":["42"],"title":"Year"},"description":"Year of the eruption; negative values indicate BCE"},{"name":"explosivity_index","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Volcanic Explosivity Index from 0 to 8","examples":["42"],"title":"Explosivity Index"},"description":"Volcanic Explosivity Index from 0 to 8"},{"name":"morphology","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Volcano type, e.g. stratovolcano, caldera, shield","examples":["example"],"title":"Morphology"},"description":"Volcano type, e.g. stratovolcano, caldera, shield"},{"name":"X-API-Key","in":"header","required":true,"schema":{"type":"string","title":"X-Api-Key"}}],"responses":{"200":{"description":"A page of Global Volcanic Eruptions records with pagination metadata.","content":{"application/json":{"schema":{},"example":{"data":{"items":[{"event_id":42,"volcano_name":"example","location":"example","country":"example","year":42,"month":42,"day":42,"latitude":4.2,"longitude":4.2,"elevation_m":42,"morphology":"example","explosivity_index":42,"deaths_total":42,"damage_millions_usd":4.2}],"total":1,"limit":25,"offset":0}}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/data/global-volcanic-eruptions/search":{"get":{"tags":["Volcanic Eruptions"],"summary":"Search Global Volcanic Eruptions by volcano_name","description":"Search Global Volcanic Eruptions records by `volcano_name` (partial, case-insensitive).\n\n**Example:** `GET /v1/data/global-volcanic-eruptions/search?q=exa`","operationId":"search_endpoint_v1_data_global_volcanic_eruptions_search_get","parameters":[{"name":"q","in":"query","required":true,"schema":{"type":"string","minLength":2,"maxLength":100,"description":"Case-insensitive partial match on volcano_name.","examples":["exa"],"title":"Q"},"description":"Case-insensitive partial match on volcano_name."},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":100,"minimum":1,"description":"Max records to return (1-100).","default":25,"title":"Limit"},"description":"Max records to return (1-100)."},{"name":"X-API-Key","in":"header","required":true,"schema":{"type":"string","title":"X-Api-Key"}}],"responses":{"200":{"description":"Matching Global Volcanic Eruptions records.","content":{"application/json":{"schema":{},"example":{"data":{"items":[{"event_id":42,"volcano_name":"example","location":"example","country":"example","year":42,"month":42,"day":42,"latitude":4.2,"longitude":4.2,"elevation_m":42,"morphology":"example","explosivity_index":42,"deaths_total":42,"damage_millions_usd":4.2}]}}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/data/global-volcanic-eruptions/{key}":{"get":{"tags":["Volcanic Eruptions"],"summary":"Get one Global Volcanic Eruptions record by event_id","description":"Fetch a single Global Volcanic Eruptions record by its `event_id`.\n\n**Example:** `GET /v1/data/global-volcanic-eruptions/42`","operationId":"get_endpoint_v1_data_global_volcanic_eruptions__key__get","parameters":[{"name":"key","in":"path","required":true,"schema":{"type":"string","description":"The event_id value to look up (case-insensitive).","examples":["42"],"title":"Key"},"description":"The event_id value to look up (case-insensitive)."},{"name":"X-API-Key","in":"header","required":true,"schema":{"type":"string","title":"X-Api-Key"}}],"responses":{"200":{"description":"A single Global Volcanic Eruptions record.","content":{"application/json":{"schema":{},"example":{"data":{"event_id":42,"volcano_name":"example","location":"example","country":"example","year":42,"month":42,"day":42,"latitude":4.2,"longitude":4.2,"elevation_m":42,"morphology":"example","explosivity_index":42,"deaths_total":42,"damage_millions_usd":4.2}}}}},"404":{"content":{"application/json":{"example":{"error":{"code":"NOT_FOUND","message":"No Global Volcanic Eruptions record for '...'."}}}},"description":"Not Found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/data/international-airline-airport-codes":{"get":{"tags":["Aviation"],"summary":"List International Airline and Airport Codes records","description":"List International Airline and Airport Codes records with optional filters and pagination.\n\n**Source:** DataHub, Airport Codes (ODbL).\n\n**Fields returned:**\n- `ident_code` (str) — A unique identifier for the airport, usually the ICAO code.\n- `type` (str) — The type of airport (e.g., 'large_airport', 'heliport').\n- `name` (str) — The official name of the airport.\n- `latitude` (float) — The latitude of the airport.\n- `longitude` (float) — The longitude of the airport.\n- `elevation_ft` (int) — The elevation of the airport in feet.\n- `country_iso` (str) — The ISO 3166-1 alpha-2 country code.\n- `municipality` (str) — The city or municipality the airport serves.\n- `iata_code` (str) — The 3-letter IATA airport code.\n\n**Example:** `GET /v1/data/international-airline-airport-codes?limit=10&type=example`","operationId":"list_endpoint_v1_data_international_airline_airport_codes_get","parameters":[{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":100,"minimum":1,"description":"Max records to return (1-100).","default":25,"title":"Limit"},"description":"Max records to return (1-100)."},{"name":"offset","in":"query","required":false,"schema":{"type":"integer","minimum":0,"description":"Records to skip, for pagination.","default":0,"title":"Offset"},"description":"Records to skip, for pagination."},{"name":"type","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The type of airport (e.g., 'large_airport', 'heliport').","examples":["example"],"title":"Type"},"description":"The type of airport (e.g., 'large_airport', 'heliport')."},{"name":"country_iso","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The ISO 3166-1 alpha-2 country code.","examples":["example"],"title":"Country Iso"},"description":"The ISO 3166-1 alpha-2 country code."},{"name":"X-API-Key","in":"header","required":true,"schema":{"type":"string","title":"X-Api-Key"}}],"responses":{"200":{"description":"A page of International Airline and Airport Codes records with pagination metadata.","content":{"application/json":{"schema":{},"example":{"data":{"items":[{"ident_code":"example","type":"example","name":"example","latitude":4.2,"longitude":4.2,"elevation_ft":42,"country_iso":"example","municipality":"example","iata_code":"example"}],"total":1,"limit":25,"offset":0}}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/data/international-airline-airport-codes/search":{"get":{"tags":["Aviation"],"summary":"Search International Airline and Airport Codes by name","description":"Search International Airline and Airport Codes records by `name` (partial, case-insensitive).\n\n**Example:** `GET /v1/data/international-airline-airport-codes/search?q=exa`","operationId":"search_endpoint_v1_data_international_airline_airport_codes_search_get","parameters":[{"name":"q","in":"query","required":true,"schema":{"type":"string","minLength":2,"maxLength":100,"description":"Case-insensitive partial match on name.","examples":["exa"],"title":"Q"},"description":"Case-insensitive partial match on name."},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":100,"minimum":1,"description":"Max records to return (1-100).","default":25,"title":"Limit"},"description":"Max records to return (1-100)."},{"name":"X-API-Key","in":"header","required":true,"schema":{"type":"string","title":"X-Api-Key"}}],"responses":{"200":{"description":"Matching International Airline and Airport Codes records.","content":{"application/json":{"schema":{},"example":{"data":{"items":[{"ident_code":"example","type":"example","name":"example","latitude":4.2,"longitude":4.2,"elevation_ft":42,"country_iso":"example","municipality":"example","iata_code":"example"}]}}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/data/international-airline-airport-codes/{key}":{"get":{"tags":["Aviation"],"summary":"Get one International Airline and Airport Codes record by iata_code","description":"Fetch a single International Airline and Airport Codes record by its `iata_code`.\n\n**Example:** `GET /v1/data/international-airline-airport-codes/example`","operationId":"get_endpoint_v1_data_international_airline_airport_codes__key__get","parameters":[{"name":"key","in":"path","required":true,"schema":{"type":"string","description":"The iata_code value to look up (case-insensitive).","examples":["example"],"title":"Key"},"description":"The iata_code value to look up (case-insensitive)."},{"name":"X-API-Key","in":"header","required":true,"schema":{"type":"string","title":"X-Api-Key"}}],"responses":{"200":{"description":"A single International Airline and Airport Codes record.","content":{"application/json":{"schema":{},"example":{"data":{"ident_code":"example","type":"example","name":"example","latitude":4.2,"longitude":4.2,"elevation_ft":42,"country_iso":"example","municipality":"example","iata_code":"example"}}}}},"404":{"content":{"application/json":{"example":{"error":{"code":"NOT_FOUND","message":"No International Airline and Airport Codes record for '...'."}}}},"description":"Not Found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/data/known-exploited-software-vulnerabilities":{"get":{"tags":["Cybersecurity"],"summary":"List Known Exploited Software Vulnerabilities records","description":"List Known Exploited Software Vulnerabilities records with optional filters and pagination.\n\n**Source:** Source: Cybersecurity and Infrastructure Security Agency (CISA), Known Exploited Vulnerabilities Catalog. (Public Domain (U.S. Government Work)).\n\n**Fields returned:**\n- `cve_id` (str) — Common Vulnerabilities and Exposures identifier for the flaw.\n- `vendor_project` (str) — Vendor or open-source project that publishes the affected software.\n- `product` (str) — Affected product name.\n- `vulnerability_name` (str) — Short human-readable name of the vulnerability.\n- `date_added` (date) — Date the vulnerability was added to the catalogue.\n- `short_description` (str) — Plain-language summary of the weakness and how it is abused.\n- `required_action` (str) — Remediation action required of US federal agencies.\n- `due_date` (date) — Deadline by which the required action must be completed.\n- `known_ransomware_campaign_use` (str) — Whether the flaw is known to be used in ransomware campaigns ('Known' or 'Unknown').\n- `notes` (str) — Reference links and additional vendor advisory notes.\n\n**Example:** `GET /v1/data/known-exploited-software-vulnerabilities?limit=10&vendor_project=example`","operationId":"list_endpoint_v1_data_known_exploited_software_vulnerabilities_get","parameters":[{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":100,"minimum":1,"description":"Max records to return (1-100).","default":25,"title":"Limit"},"description":"Max records to return (1-100)."},{"name":"offset","in":"query","required":false,"schema":{"type":"integer","minimum":0,"description":"Records to skip, for pagination.","default":0,"title":"Offset"},"description":"Records to skip, for pagination."},{"name":"vendor_project","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Vendor or open-source project that publishes the affected software.","examples":["example"],"title":"Vendor Project"},"description":"Vendor or open-source project that publishes the affected software."},{"name":"product","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Affected product name.","examples":["example"],"title":"Product"},"description":"Affected product name."},{"name":"known_ransomware_campaign_use","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Whether the flaw is known to be used in ransomware campaigns ('Known' or 'Unknown').","examples":["example"],"title":"Known Ransomware Campaign Use"},"description":"Whether the flaw is known to be used in ransomware campaigns ('Known' or 'Unknown')."},{"name":"date_added","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Date the vulnerability was added to the catalogue.","examples":["2026-01-01"],"title":"Date Added"},"description":"Date the vulnerability was added to the catalogue."},{"name":"due_date","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Deadline by which the required action must be completed.","examples":["2026-01-01"],"title":"Due Date"},"description":"Deadline by which the required action must be completed."},{"name":"X-API-Key","in":"header","required":true,"schema":{"type":"string","title":"X-Api-Key"}}],"responses":{"200":{"description":"A page of Known Exploited Software Vulnerabilities records with pagination metadata.","content":{"application/json":{"schema":{},"example":{"data":{"items":[{"cve_id":"example","vendor_project":"example","product":"example","vulnerability_name":"example","date_added":"2026-01-01","short_description":"example","required_action":"example","due_date":"2026-01-01","known_ransomware_campaign_use":"example","notes":"example"}],"total":1,"limit":25,"offset":0}}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/data/known-exploited-software-vulnerabilities/search":{"get":{"tags":["Cybersecurity"],"summary":"Search Known Exploited Software Vulnerabilities by vulnerability_name","description":"Search Known Exploited Software Vulnerabilities records by `vulnerability_name` (partial, case-insensitive).\n\n**Example:** `GET /v1/data/known-exploited-software-vulnerabilities/search?q=exa`","operationId":"search_endpoint_v1_data_known_exploited_software_vulnerabilities_search_get","parameters":[{"name":"q","in":"query","required":true,"schema":{"type":"string","minLength":2,"maxLength":100,"description":"Case-insensitive partial match on vulnerability_name.","examples":["exa"],"title":"Q"},"description":"Case-insensitive partial match on vulnerability_name."},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":100,"minimum":1,"description":"Max records to return (1-100).","default":25,"title":"Limit"},"description":"Max records to return (1-100)."},{"name":"X-API-Key","in":"header","required":true,"schema":{"type":"string","title":"X-Api-Key"}}],"responses":{"200":{"description":"Matching Known Exploited Software Vulnerabilities records.","content":{"application/json":{"schema":{},"example":{"data":{"items":[{"cve_id":"example","vendor_project":"example","product":"example","vulnerability_name":"example","date_added":"2026-01-01","short_description":"example","required_action":"example","due_date":"2026-01-01","known_ransomware_campaign_use":"example","notes":"example"}]}}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/data/known-exploited-software-vulnerabilities/{key}":{"get":{"tags":["Cybersecurity"],"summary":"Get one Known Exploited Software Vulnerabilities record by cve_id","description":"Fetch a single Known Exploited Software Vulnerabilities record by its `cve_id`.\n\n**Example:** `GET /v1/data/known-exploited-software-vulnerabilities/example`","operationId":"get_endpoint_v1_data_known_exploited_software_vulnerabilities__key__get","parameters":[{"name":"key","in":"path","required":true,"schema":{"type":"string","description":"The cve_id value to look up (case-insensitive).","examples":["example"],"title":"Key"},"description":"The cve_id value to look up (case-insensitive)."},{"name":"X-API-Key","in":"header","required":true,"schema":{"type":"string","title":"X-Api-Key"}}],"responses":{"200":{"description":"A single Known Exploited Software Vulnerabilities record.","content":{"application/json":{"schema":{},"example":{"data":{"cve_id":"example","vendor_project":"example","product":"example","vulnerability_name":"example","date_added":"2026-01-01","short_description":"example","required_action":"example","due_date":"2026-01-01","known_ransomware_campaign_use":"example","notes":"example"}}}}},"404":{"content":{"application/json":{"example":{"error":{"code":"NOT_FOUND","message":"No Known Exploited Software Vulnerabilities record for '...'."}}}},"description":"Not Found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/data/near-earth-asteroid-approaches":{"get":{"tags":["Asteroid Approaches"],"summary":"List Near Earth Asteroid Approaches records","description":"List Near Earth Asteroid Approaches records with optional filters and pagination.\n\n**Source:** Data courtesy NASA/JPL-Caltech, Center for Near-Earth Object Studies Close-Approach Data API. (Public Domain (U.S. Government Work)).\n\n**Fields returned:**\n- `designation` (str) — Object primary designation, e.g. 2024 AB1 or 433 Eros\n- `orbit_id` (str) — Identifier of the orbit solution used for the prediction\n- `close_approach_time` (str) — Close-approach date and time in universal time, as published by the source\n- `julian_date` (float) — Close-approach time as a Julian date, useful for sorting and maths\n- `distance_au` (float) — Nominal approach distance in astronomical units\n- `distance_min_au` (float) — Minimum approach distance within the uncertainty range, in astronomical units\n- `distance_max_au` (float) — Maximum approach distance within the uncertainty range, in astronomical units\n- `relative_velocity_km_s` (float) — Velocity relative to Earth at approach, kilometres per second\n- `absolute_magnitude` (float) — Absolute magnitude, a proxy for object size — smaller numbers mean larger objects\n\n**Example:** `GET /v1/data/near-earth-asteroid-approaches?limit=10&designation=example`","operationId":"list_endpoint_v1_data_near_earth_asteroid_approaches_get","parameters":[{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":100,"minimum":1,"description":"Max records to return (1-100).","default":25,"title":"Limit"},"description":"Max records to return (1-100)."},{"name":"offset","in":"query","required":false,"schema":{"type":"integer","minimum":0,"description":"Records to skip, for pagination.","default":0,"title":"Offset"},"description":"Records to skip, for pagination."},{"name":"designation","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Object primary designation, e.g. 2024 AB1 or 433 Eros","examples":["example"],"title":"Designation"},"description":"Object primary designation, e.g. 2024 AB1 or 433 Eros"},{"name":"close_approach_time","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Close-approach date and time in universal time, as published by the source","examples":["example"],"title":"Close Approach Time"},"description":"Close-approach date and time in universal time, as published by the source"},{"name":"X-API-Key","in":"header","required":true,"schema":{"type":"string","title":"X-Api-Key"}}],"responses":{"200":{"description":"A page of Near Earth Asteroid Approaches records with pagination metadata.","content":{"application/json":{"schema":{},"example":{"data":{"items":[{"designation":"example","orbit_id":"example","close_approach_time":"example","julian_date":4.2,"distance_au":4.2,"distance_min_au":4.2,"distance_max_au":4.2,"relative_velocity_km_s":4.2,"absolute_magnitude":4.2}],"total":1,"limit":25,"offset":0}}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/data/near-earth-asteroid-approaches/search":{"get":{"tags":["Asteroid Approaches"],"summary":"Search Near Earth Asteroid Approaches by designation","description":"Search Near Earth Asteroid Approaches records by `designation` (partial, case-insensitive).\n\n**Example:** `GET /v1/data/near-earth-asteroid-approaches/search?q=exa`","operationId":"search_endpoint_v1_data_near_earth_asteroid_approaches_search_get","parameters":[{"name":"q","in":"query","required":true,"schema":{"type":"string","minLength":2,"maxLength":100,"description":"Case-insensitive partial match on designation.","examples":["exa"],"title":"Q"},"description":"Case-insensitive partial match on designation."},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":100,"minimum":1,"description":"Max records to return (1-100).","default":25,"title":"Limit"},"description":"Max records to return (1-100)."},{"name":"X-API-Key","in":"header","required":true,"schema":{"type":"string","title":"X-Api-Key"}}],"responses":{"200":{"description":"Matching Near Earth Asteroid Approaches records.","content":{"application/json":{"schema":{},"example":{"data":{"items":[{"designation":"example","orbit_id":"example","close_approach_time":"example","julian_date":4.2,"distance_au":4.2,"distance_min_au":4.2,"distance_max_au":4.2,"relative_velocity_km_s":4.2,"absolute_magnitude":4.2}]}}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/data/near-earth-asteroid-approaches/{key}":{"get":{"tags":["Asteroid Approaches"],"summary":"Get one Near Earth Asteroid Approaches record by designation","description":"Fetch a single Near Earth Asteroid Approaches record by its `designation`.\n\n**Example:** `GET /v1/data/near-earth-asteroid-approaches/example`","operationId":"get_endpoint_v1_data_near_earth_asteroid_approaches__key__get","parameters":[{"name":"key","in":"path","required":true,"schema":{"type":"string","description":"The designation value to look up (case-insensitive).","examples":["example"],"title":"Key"},"description":"The designation value to look up (case-insensitive)."},{"name":"X-API-Key","in":"header","required":true,"schema":{"type":"string","title":"X-Api-Key"}}],"responses":{"200":{"description":"A single Near Earth Asteroid Approaches record.","content":{"application/json":{"schema":{},"example":{"data":{"designation":"example","orbit_id":"example","close_approach_time":"example","julian_date":4.2,"distance_au":4.2,"distance_min_au":4.2,"distance_max_au":4.2,"relative_velocity_km_s":4.2,"absolute_magnitude":4.2}}}}},"404":{"content":{"application/json":{"example":{"error":{"code":"NOT_FOUND","message":"No Near Earth Asteroid Approaches record for '...'."}}}},"description":"Not Found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/data/s-p-500-company-constituents":{"get":{"tags":["Stock Market Indices"],"summary":"List S&P 500 Company Constituents records","description":"List S&P 500 Company Constituents records with optional filters and pagination.\n\n**Source:** S&P 500 constituents data from the datasets/s-and-p-500-companies project (github.com/datasets) (ODC-PDDL-1.0).\n\n**Fields returned:**\n- `symbol` (str) — Stock ticker symbol\n- `security` (str) — Company name\n- `gics_sector` (str) — Industry sector\n- `gics_sub_industry` (str) — Industry sub-category\n- `headquarters_location` (str) — City and state of company headquarters\n- `date_added` (str) — Date the company joined the index\n- `cik` (str) — SEC Central Index Key\n- `founded` (str) — Year the company was founded\n\n**Example:** `GET /v1/data/s-p-500-company-constituents?limit=10&gics_sector=example`","operationId":"list_endpoint_v1_data_s_p_500_company_constituents_get","parameters":[{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":100,"minimum":1,"description":"Max records to return (1-100).","default":25,"title":"Limit"},"description":"Max records to return (1-100)."},{"name":"offset","in":"query","required":false,"schema":{"type":"integer","minimum":0,"description":"Records to skip, for pagination.","default":0,"title":"Offset"},"description":"Records to skip, for pagination."},{"name":"gics_sector","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Industry sector","examples":["example"],"title":"Gics Sector"},"description":"Industry sector"},{"name":"gics_sub_industry","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Industry sub-category","examples":["example"],"title":"Gics Sub Industry"},"description":"Industry sub-category"},{"name":"X-API-Key","in":"header","required":true,"schema":{"type":"string","title":"X-Api-Key"}}],"responses":{"200":{"description":"A page of S&P 500 Company Constituents records with pagination metadata.","content":{"application/json":{"schema":{},"example":{"data":{"items":[{"symbol":"example","security":"example","gics_sector":"example","gics_sub_industry":"example","headquarters_location":"example","date_added":"example","cik":"example","founded":"example"}],"total":1,"limit":25,"offset":0}}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/data/s-p-500-company-constituents/search":{"get":{"tags":["Stock Market Indices"],"summary":"Search S&P 500 Company Constituents by security","description":"Search S&P 500 Company Constituents records by `security` (partial, case-insensitive).\n\n**Example:** `GET /v1/data/s-p-500-company-constituents/search?q=exa`","operationId":"search_endpoint_v1_data_s_p_500_company_constituents_search_get","parameters":[{"name":"q","in":"query","required":true,"schema":{"type":"string","minLength":2,"maxLength":100,"description":"Case-insensitive partial match on security.","examples":["exa"],"title":"Q"},"description":"Case-insensitive partial match on security."},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":100,"minimum":1,"description":"Max records to return (1-100).","default":25,"title":"Limit"},"description":"Max records to return (1-100)."},{"name":"X-API-Key","in":"header","required":true,"schema":{"type":"string","title":"X-Api-Key"}}],"responses":{"200":{"description":"Matching S&P 500 Company Constituents records.","content":{"application/json":{"schema":{},"example":{"data":{"items":[{"symbol":"example","security":"example","gics_sector":"example","gics_sub_industry":"example","headquarters_location":"example","date_added":"example","cik":"example","founded":"example"}]}}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/data/s-p-500-company-constituents/{key}":{"get":{"tags":["Stock Market Indices"],"summary":"Get one S&P 500 Company Constituents record by symbol","description":"Fetch a single S&P 500 Company Constituents record by its `symbol`.\n\n**Example:** `GET /v1/data/s-p-500-company-constituents/example`","operationId":"get_endpoint_v1_data_s_p_500_company_constituents__key__get","parameters":[{"name":"key","in":"path","required":true,"schema":{"type":"string","description":"The symbol value to look up (case-insensitive).","examples":["example"],"title":"Key"},"description":"The symbol value to look up (case-insensitive)."},{"name":"X-API-Key","in":"header","required":true,"schema":{"type":"string","title":"X-Api-Key"}}],"responses":{"200":{"description":"A single S&P 500 Company Constituents record.","content":{"application/json":{"schema":{},"example":{"data":{"symbol":"example","security":"example","gics_sector":"example","gics_sub_industry":"example","headquarters_location":"example","date_added":"example","cik":"example","founded":"example"}}}}},"404":{"content":{"application/json":{"example":{"error":{"code":"NOT_FOUND","message":"No S&P 500 Company Constituents record for '...'."}}}},"description":"Not Found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/data/space-weather-geomagnetic-activity":{"get":{"tags":["Space Weather"],"summary":"List Space Weather Geomagnetic Activity records","description":"List Space Weather Geomagnetic Activity records with optional filters and pagination.\n\n**Source:** Source: NOAA Space Weather Prediction Center (Public domain (U.S. Government work)).\n\n**Fields returned:**\n- `observed_at` (date) — UTC timestamp of the reading\n- `geomagnetic_index` (float) — Estimated planetary geomagnetic disturbance index, 0 to 9\n- `estimated_index` (float) — Estimated index value as published by the forecast centre\n- `index_label` (str) — Text form of the index, including plus or minus qualifiers\n\n**Example:** `GET /v1/data/space-weather-geomagnetic-activity?limit=10&observed_at=2026-01-01`","operationId":"list_endpoint_v1_data_space_weather_geomagnetic_activity_get","parameters":[{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":100,"minimum":1,"description":"Max records to return (1-100).","default":25,"title":"Limit"},"description":"Max records to return (1-100)."},{"name":"offset","in":"query","required":false,"schema":{"type":"integer","minimum":0,"description":"Records to skip, for pagination.","default":0,"title":"Offset"},"description":"Records to skip, for pagination."},{"name":"observed_at","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"UTC timestamp of the reading","examples":["2026-01-01"],"title":"Observed At"},"description":"UTC timestamp of the reading"},{"name":"geomagnetic_index","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Estimated planetary geomagnetic disturbance index, 0 to 9","examples":["4.2"],"title":"Geomagnetic Index"},"description":"Estimated planetary geomagnetic disturbance index, 0 to 9"},{"name":"X-API-Key","in":"header","required":true,"schema":{"type":"string","title":"X-Api-Key"}}],"responses":{"200":{"description":"A page of Space Weather Geomagnetic Activity records with pagination metadata.","content":{"application/json":{"schema":{},"example":{"data":{"items":[{"observed_at":"2026-01-01","geomagnetic_index":4.2,"estimated_index":4.2,"index_label":"example"}],"total":1,"limit":25,"offset":0}}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/data/space-weather-geomagnetic-activity/search":{"get":{"tags":["Space Weather"],"summary":"Search Space Weather Geomagnetic Activity by observed_at","description":"Search Space Weather Geomagnetic Activity records by `observed_at` (partial, case-insensitive).\n\n**Example:** `GET /v1/data/space-weather-geomagnetic-activity/search?q=202`","operationId":"search_endpoint_v1_data_space_weather_geomagnetic_activity_search_get","parameters":[{"name":"q","in":"query","required":true,"schema":{"type":"string","minLength":2,"maxLength":100,"description":"Case-insensitive partial match on observed_at.","examples":["202"],"title":"Q"},"description":"Case-insensitive partial match on observed_at."},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":100,"minimum":1,"description":"Max records to return (1-100).","default":25,"title":"Limit"},"description":"Max records to return (1-100)."},{"name":"X-API-Key","in":"header","required":true,"schema":{"type":"string","title":"X-Api-Key"}}],"responses":{"200":{"description":"Matching Space Weather Geomagnetic Activity records.","content":{"application/json":{"schema":{},"example":{"data":{"items":[{"observed_at":"2026-01-01","geomagnetic_index":4.2,"estimated_index":4.2,"index_label":"example"}]}}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/data/space-weather-geomagnetic-activity/{key}":{"get":{"tags":["Space Weather"],"summary":"Get one Space Weather Geomagnetic Activity record by observed_at","description":"Fetch a single Space Weather Geomagnetic Activity record by its `observed_at`.\n\n**Example:** `GET /v1/data/space-weather-geomagnetic-activity/2026-01-01`","operationId":"get_endpoint_v1_data_space_weather_geomagnetic_activity__key__get","parameters":[{"name":"key","in":"path","required":true,"schema":{"type":"string","description":"The observed_at value to look up (case-insensitive).","examples":["2026-01-01"],"title":"Key"},"description":"The observed_at value to look up (case-insensitive)."},{"name":"X-API-Key","in":"header","required":true,"schema":{"type":"string","title":"X-Api-Key"}}],"responses":{"200":{"description":"A single Space Weather Geomagnetic Activity record.","content":{"application/json":{"schema":{},"example":{"data":{"observed_at":"2026-01-01","geomagnetic_index":4.2,"estimated_index":4.2,"index_label":"example"}}}}},"404":{"content":{"application/json":{"example":{"error":{"code":"NOT_FOUND","message":"No Space Weather Geomagnetic Activity record for '...'."}}}},"description":"Not Found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/data/stock-market-volatility-index":{"get":{"tags":["Market Volatility"],"summary":"List Stock Market Volatility Index records","description":"List Stock Market Volatility Index records with optional filters and pagination.\n\n**Source:** VIX data from Cboe Global Markets, packaged by the Open Knowledge Foundation datasets project (ODC-PDDL-1.0).\n\n**Fields returned:**\n- `date` (date) — Trading date\n- `open` (float) — Opening index value\n- `high` (float) — Intraday high\n- `low` (float) — Intraday low\n- `close` (float) — Closing index value\n\n**Example:** `GET /v1/data/stock-market-volatility-index?limit=10&date=2026-01-01`","operationId":"list_endpoint_v1_data_stock_market_volatility_index_get","parameters":[{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":100,"minimum":1,"description":"Max records to return (1-100).","default":25,"title":"Limit"},"description":"Max records to return (1-100)."},{"name":"offset","in":"query","required":false,"schema":{"type":"integer","minimum":0,"description":"Records to skip, for pagination.","default":0,"title":"Offset"},"description":"Records to skip, for pagination."},{"name":"date","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Trading date","examples":["2026-01-01"],"title":"Date"},"description":"Trading date"},{"name":"X-API-Key","in":"header","required":true,"schema":{"type":"string","title":"X-Api-Key"}}],"responses":{"200":{"description":"A page of Stock Market Volatility Index records with pagination metadata.","content":{"application/json":{"schema":{},"example":{"data":{"items":[{"date":"2026-01-01","open":4.2,"high":4.2,"low":4.2,"close":4.2}],"total":1,"limit":25,"offset":0}}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/data/stock-market-volatility-index/search":{"get":{"tags":["Market Volatility"],"summary":"Search Stock Market Volatility Index by date","description":"Search Stock Market Volatility Index records by `date` (partial, case-insensitive).\n\n**Example:** `GET /v1/data/stock-market-volatility-index/search?q=202`","operationId":"search_endpoint_v1_data_stock_market_volatility_index_search_get","parameters":[{"name":"q","in":"query","required":true,"schema":{"type":"string","minLength":2,"maxLength":100,"description":"Case-insensitive partial match on date.","examples":["202"],"title":"Q"},"description":"Case-insensitive partial match on date."},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":100,"minimum":1,"description":"Max records to return (1-100).","default":25,"title":"Limit"},"description":"Max records to return (1-100)."},{"name":"X-API-Key","in":"header","required":true,"schema":{"type":"string","title":"X-Api-Key"}}],"responses":{"200":{"description":"Matching Stock Market Volatility Index records.","content":{"application/json":{"schema":{},"example":{"data":{"items":[{"date":"2026-01-01","open":4.2,"high":4.2,"low":4.2,"close":4.2}]}}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/data/stock-market-volatility-index/{key}":{"get":{"tags":["Market Volatility"],"summary":"Get one Stock Market Volatility Index record by date","description":"Fetch a single Stock Market Volatility Index record by its `date`.\n\n**Example:** `GET /v1/data/stock-market-volatility-index/2026-01-01`","operationId":"get_endpoint_v1_data_stock_market_volatility_index__key__get","parameters":[{"name":"key","in":"path","required":true,"schema":{"type":"string","description":"The date value to look up (case-insensitive).","examples":["2026-01-01"],"title":"Key"},"description":"The date value to look up (case-insensitive)."},{"name":"X-API-Key","in":"header","required":true,"schema":{"type":"string","title":"X-Api-Key"}}],"responses":{"200":{"description":"A single Stock Market Volatility Index record.","content":{"application/json":{"schema":{},"example":{"data":{"date":"2026-01-01","open":4.2,"high":4.2,"low":4.2,"close":4.2}}}}},"404":{"content":{"application/json":{"example":{"error":{"code":"NOT_FOUND","message":"No Stock Market Volatility Index record for '...'."}}}},"description":"Not Found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/data/united-states-consumer-product-recalls":{"get":{"tags":["Product Recalls"],"summary":"List United States Consumer Product Recalls records","description":"List United States Consumer Product Recalls records with optional filters and pagination.\n\n**Source:** Source: U.S. Consumer Product Safety Commission (CPSC), SaferProducts.gov Recalls API. (Public Domain (U.S. Government work, 17 U.S.C. 105)).\n\n**Fields returned:**\n- `recall_id` (int) — Internal CPSC recall identifier\n- `recall_number` (str) — Published CPSC recall number\n- `recall_date` (date) — Date the recall was announced\n- `title` (str) — Short recall headline, usually the product and the reason\n- `description` (str) — Description of the recalled product and the hazard\n- `consumer_contact` (str) — How consumers should contact the firm about the recall\n- `last_publish_date` (date) — Date the recall record was last updated\n- `recall_url` (str) — Link to the official CPSC recall notice\n\n**Example:** `GET /v1/data/united-states-consumer-product-recalls?limit=10&recall_date=2026-01-01`","operationId":"list_endpoint_v1_data_united_states_consumer_product_recalls_get","parameters":[{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":100,"minimum":1,"description":"Max records to return (1-100).","default":25,"title":"Limit"},"description":"Max records to return (1-100)."},{"name":"offset","in":"query","required":false,"schema":{"type":"integer","minimum":0,"description":"Records to skip, for pagination.","default":0,"title":"Offset"},"description":"Records to skip, for pagination."},{"name":"recall_date","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Date the recall was announced","examples":["2026-01-01"],"title":"Recall Date"},"description":"Date the recall was announced"},{"name":"last_publish_date","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Date the recall record was last updated","examples":["2026-01-01"],"title":"Last Publish Date"},"description":"Date the recall record was last updated"},{"name":"X-API-Key","in":"header","required":true,"schema":{"type":"string","title":"X-Api-Key"}}],"responses":{"200":{"description":"A page of United States Consumer Product Recalls records with pagination metadata.","content":{"application/json":{"schema":{},"example":{"data":{"items":[{"recall_id":42,"recall_number":"example","recall_date":"2026-01-01","title":"example","description":"example","consumer_contact":"example","last_publish_date":"2026-01-01","recall_url":"example"}],"total":1,"limit":25,"offset":0}}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/data/united-states-consumer-product-recalls/search":{"get":{"tags":["Product Recalls"],"summary":"Search United States Consumer Product Recalls by title","description":"Search United States Consumer Product Recalls records by `title` (partial, case-insensitive).\n\n**Example:** `GET /v1/data/united-states-consumer-product-recalls/search?q=exa`","operationId":"search_endpoint_v1_data_united_states_consumer_product_recalls_search_get","parameters":[{"name":"q","in":"query","required":true,"schema":{"type":"string","minLength":2,"maxLength":100,"description":"Case-insensitive partial match on title.","examples":["exa"],"title":"Q"},"description":"Case-insensitive partial match on title."},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":100,"minimum":1,"description":"Max records to return (1-100).","default":25,"title":"Limit"},"description":"Max records to return (1-100)."},{"name":"X-API-Key","in":"header","required":true,"schema":{"type":"string","title":"X-Api-Key"}}],"responses":{"200":{"description":"Matching United States Consumer Product Recalls records.","content":{"application/json":{"schema":{},"example":{"data":{"items":[{"recall_id":42,"recall_number":"example","recall_date":"2026-01-01","title":"example","description":"example","consumer_contact":"example","last_publish_date":"2026-01-01","recall_url":"example"}]}}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/data/united-states-consumer-product-recalls/{key}":{"get":{"tags":["Product Recalls"],"summary":"Get one United States Consumer Product Recalls record by recall_number","description":"Fetch a single United States Consumer Product Recalls record by its `recall_number`.\n\n**Example:** `GET /v1/data/united-states-consumer-product-recalls/example`","operationId":"get_endpoint_v1_data_united_states_consumer_product_recalls__key__get","parameters":[{"name":"key","in":"path","required":true,"schema":{"type":"string","description":"The recall_number value to look up (case-insensitive).","examples":["example"],"title":"Key"},"description":"The recall_number value to look up (case-insensitive)."},{"name":"X-API-Key","in":"header","required":true,"schema":{"type":"string","title":"X-Api-Key"}}],"responses":{"200":{"description":"A single United States Consumer Product Recalls record.","content":{"application/json":{"schema":{},"example":{"data":{"recall_id":42,"recall_number":"example","recall_date":"2026-01-01","title":"example","description":"example","consumer_contact":"example","last_publish_date":"2026-01-01","recall_url":"example"}}}}},"404":{"content":{"application/json":{"example":{"error":{"code":"NOT_FOUND","message":"No United States Consumer Product Recalls record for '...'."}}}},"description":"Not Found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/data/united-states-drug-product-directory":{"get":{"tags":["Drug Products"],"summary":"List United States Drug Product Directory records","description":"List United States Drug Product Directory records with optional filters and pagination.\n\n**Source:** Source: openFDA, U.S. Food and Drug Administration. Not for clinical use. (Public domain (CC0, US Government work)).\n\n**Fields returned:**\n- `product_ndc` (str) — National drug code identifying the labeller and product\n- `brand_name` (str) — Marketed brand or proprietary name\n- `generic_name` (str) — Generic or non-proprietary name of the active ingredients\n- `labeler_name` (str) — Company that labels and markets the product\n- `dosage_form` (str) — Physical form, for example tablet, injection or cream\n- `product_type` (str) — Whether the product is prescription, over-the-counter or another category\n- `marketing_category` (str) — Regulatory pathway under which the product is marketed\n- `dea_schedule` (str) — Controlled substance schedule where one applies\n- `marketing_start_date` (str) — Date marketing began, formatted as YYYYMMDD\n- `finished` (bool) — True for finished dosage products, false for bulk ingredients\n\n**Example:** `GET /v1/data/united-states-drug-product-directory?limit=10&labeler_name=example`","operationId":"list_endpoint_v1_data_united_states_drug_product_directory_get","parameters":[{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":100,"minimum":1,"description":"Max records to return (1-100).","default":25,"title":"Limit"},"description":"Max records to return (1-100)."},{"name":"offset","in":"query","required":false,"schema":{"type":"integer","minimum":0,"description":"Records to skip, for pagination.","default":0,"title":"Offset"},"description":"Records to skip, for pagination."},{"name":"labeler_name","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Company that labels and markets the product","examples":["example"],"title":"Labeler Name"},"description":"Company that labels and markets the product"},{"name":"dosage_form","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Physical form, for example tablet, injection or cream","examples":["example"],"title":"Dosage Form"},"description":"Physical form, for example tablet, injection or cream"},{"name":"product_type","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Whether the product is prescription, over-the-counter or another category","examples":["example"],"title":"Product Type"},"description":"Whether the product is prescription, over-the-counter or another category"},{"name":"marketing_category","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Regulatory pathway under which the product is marketed","examples":["example"],"title":"Marketing Category"},"description":"Regulatory pathway under which the product is marketed"},{"name":"dea_schedule","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Controlled substance schedule where one applies","examples":["example"],"title":"Dea Schedule"},"description":"Controlled substance schedule where one applies"},{"name":"X-API-Key","in":"header","required":true,"schema":{"type":"string","title":"X-Api-Key"}}],"responses":{"200":{"description":"A page of United States Drug Product Directory records with pagination metadata.","content":{"application/json":{"schema":{},"example":{"data":{"items":[{"product_ndc":"example","brand_name":"example","generic_name":"example","labeler_name":"example","dosage_form":"example","product_type":"example","marketing_category":"example","dea_schedule":"example","marketing_start_date":"example","finished":true}],"total":1,"limit":25,"offset":0}}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/data/united-states-drug-product-directory/search":{"get":{"tags":["Drug Products"],"summary":"Search United States Drug Product Directory by brand_name","description":"Search United States Drug Product Directory records by `brand_name` (partial, case-insensitive).\n\n**Example:** `GET /v1/data/united-states-drug-product-directory/search?q=exa`","operationId":"search_endpoint_v1_data_united_states_drug_product_directory_search_get","parameters":[{"name":"q","in":"query","required":true,"schema":{"type":"string","minLength":2,"maxLength":100,"description":"Case-insensitive partial match on brand_name.","examples":["exa"],"title":"Q"},"description":"Case-insensitive partial match on brand_name."},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":100,"minimum":1,"description":"Max records to return (1-100).","default":25,"title":"Limit"},"description":"Max records to return (1-100)."},{"name":"X-API-Key","in":"header","required":true,"schema":{"type":"string","title":"X-Api-Key"}}],"responses":{"200":{"description":"Matching United States Drug Product Directory records.","content":{"application/json":{"schema":{},"example":{"data":{"items":[{"product_ndc":"example","brand_name":"example","generic_name":"example","labeler_name":"example","dosage_form":"example","product_type":"example","marketing_category":"example","dea_schedule":"example","marketing_start_date":"example","finished":true}]}}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/data/united-states-drug-product-directory/{key}":{"get":{"tags":["Drug Products"],"summary":"Get one United States Drug Product Directory record by product_ndc","description":"Fetch a single United States Drug Product Directory record by its `product_ndc`.\n\n**Example:** `GET /v1/data/united-states-drug-product-directory/example`","operationId":"get_endpoint_v1_data_united_states_drug_product_directory__key__get","parameters":[{"name":"key","in":"path","required":true,"schema":{"type":"string","description":"The product_ndc value to look up (case-insensitive).","examples":["example"],"title":"Key"},"description":"The product_ndc value to look up (case-insensitive)."},{"name":"X-API-Key","in":"header","required":true,"schema":{"type":"string","title":"X-Api-Key"}}],"responses":{"200":{"description":"A single United States Drug Product Directory record.","content":{"application/json":{"schema":{},"example":{"data":{"product_ndc":"example","brand_name":"example","generic_name":"example","labeler_name":"example","dosage_form":"example","product_type":"example","marketing_category":"example","dea_schedule":"example","marketing_start_date":"example","finished":true}}}}},"404":{"content":{"application/json":{"example":{"error":{"code":"NOT_FOUND","message":"No United States Drug Product Directory record for '...'."}}}},"description":"Not Found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/data/united-states-drug-shortages":{"get":{"tags":["Drug Shortages"],"summary":"List United States Drug Shortages records","description":"List United States Drug Shortages records with optional filters and pagination.\n\n**Source:** Data from openFDA, U.S. Food and Drug Administration. FDA does not endorse this product. (CC0 1.0 (US Government public domain)).\n\n**Fields returned:**\n- `package_ndc` (str) — National Drug Code of the affected package\n- `generic_name` (str) — Generic (non-proprietary) drug name\n- `proprietary_name` (str) — Brand name, if any\n- `company_name` (str) — Manufacturer or labeler\n- `dosage_form` (str) — Dosage form, e.g. Injection, Tablet\n- `presentation` (str) — Package presentation and strength description\n- `status` (str) — Shortage status, e.g. Current, Resolved, To Be Discontinued\n- `availability` (str) — Availability notes from the manufacturer\n- `shortage_reason` (str) — Reason given for the shortage\n- `related_info` (str) — Additional related information\n- `initial_posting_date` (str) — Date the shortage was first posted (MM/DD/YYYY)\n- `update_date` (str) — Date of the latest update (MM/DD/YYYY)\n\n**Example:** `GET /v1/data/united-states-drug-shortages?limit=10&status=example`","operationId":"list_endpoint_v1_data_united_states_drug_shortages_get","parameters":[{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":100,"minimum":1,"description":"Max records to return (1-100).","default":25,"title":"Limit"},"description":"Max records to return (1-100)."},{"name":"offset","in":"query","required":false,"schema":{"type":"integer","minimum":0,"description":"Records to skip, for pagination.","default":0,"title":"Offset"},"description":"Records to skip, for pagination."},{"name":"status","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Shortage status, e.g. Current, Resolved, To Be Discontinued","examples":["example"],"title":"Status"},"description":"Shortage status, e.g. Current, Resolved, To Be Discontinued"},{"name":"dosage_form","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Dosage form, e.g. Injection, Tablet","examples":["example"],"title":"Dosage Form"},"description":"Dosage form, e.g. Injection, Tablet"},{"name":"company_name","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Manufacturer or labeler","examples":["example"],"title":"Company Name"},"description":"Manufacturer or labeler"},{"name":"X-API-Key","in":"header","required":true,"schema":{"type":"string","title":"X-Api-Key"}}],"responses":{"200":{"description":"A page of United States Drug Shortages records with pagination metadata.","content":{"application/json":{"schema":{},"example":{"data":{"items":[{"package_ndc":"example","generic_name":"example","proprietary_name":"example","company_name":"example","dosage_form":"example","presentation":"example","status":"example","availability":"example","shortage_reason":"example","related_info":"example","initial_posting_date":"example","update_date":"example"}],"total":1,"limit":25,"offset":0}}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/data/united-states-drug-shortages/search":{"get":{"tags":["Drug Shortages"],"summary":"Search United States Drug Shortages by generic_name","description":"Search United States Drug Shortages records by `generic_name` (partial, case-insensitive).\n\n**Example:** `GET /v1/data/united-states-drug-shortages/search?q=exa`","operationId":"search_endpoint_v1_data_united_states_drug_shortages_search_get","parameters":[{"name":"q","in":"query","required":true,"schema":{"type":"string","minLength":2,"maxLength":100,"description":"Case-insensitive partial match on generic_name.","examples":["exa"],"title":"Q"},"description":"Case-insensitive partial match on generic_name."},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":100,"minimum":1,"description":"Max records to return (1-100).","default":25,"title":"Limit"},"description":"Max records to return (1-100)."},{"name":"X-API-Key","in":"header","required":true,"schema":{"type":"string","title":"X-Api-Key"}}],"responses":{"200":{"description":"Matching United States Drug Shortages records.","content":{"application/json":{"schema":{},"example":{"data":{"items":[{"package_ndc":"example","generic_name":"example","proprietary_name":"example","company_name":"example","dosage_form":"example","presentation":"example","status":"example","availability":"example","shortage_reason":"example","related_info":"example","initial_posting_date":"example","update_date":"example"}]}}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/data/united-states-drug-shortages/{key}":{"get":{"tags":["Drug Shortages"],"summary":"Get one United States Drug Shortages record by package_ndc","description":"Fetch a single United States Drug Shortages record by its `package_ndc`.\n\n**Example:** `GET /v1/data/united-states-drug-shortages/example`","operationId":"get_endpoint_v1_data_united_states_drug_shortages__key__get","parameters":[{"name":"key","in":"path","required":true,"schema":{"type":"string","description":"The package_ndc value to look up (case-insensitive).","examples":["example"],"title":"Key"},"description":"The package_ndc value to look up (case-insensitive)."},{"name":"X-API-Key","in":"header","required":true,"schema":{"type":"string","title":"X-Api-Key"}}],"responses":{"200":{"description":"A single United States Drug Shortages record.","content":{"application/json":{"schema":{},"example":{"data":{"package_ndc":"example","generic_name":"example","proprietary_name":"example","company_name":"example","dosage_form":"example","presentation":"example","status":"example","availability":"example","shortage_reason":"example","related_info":"example","initial_posting_date":"example","update_date":"example"}}}}},"404":{"content":{"application/json":{"example":{"error":{"code":"NOT_FOUND","message":"No United States Drug Shortages record for '...'."}}}},"description":"Not Found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/data/united-states-federal-register-documents":{"get":{"tags":["Government Regulations"],"summary":"List United States Federal Register Documents records","description":"List United States Federal Register Documents records with optional filters and pagination.\n\n**Source:** Source: Federal Register, Office of the Federal Register, U.S. National Archives and Records Administration. (Public Domain (U.S. Government work, 17 U.S.C. 105)).\n\n**Fields returned:**\n- `document_number` (str) — Unique Federal Register document number, e.g. 2026-01234\n- `title` (str) — Official title of the document\n- `document_type` (str) — Rule, Proposed Rule, Notice or Presidential Document\n- `abstract` (str) — Agency-written summary of the document\n- `publication_date` (date) — Date the document was published in the Federal Register\n- `html_url` (str) — Link to the official web version\n- `pdf_url` (str) — Link to the official PDF version\n\n**Example:** `GET /v1/data/united-states-federal-register-documents?limit=10&document_type=example`","operationId":"list_endpoint_v1_data_united_states_federal_register_documents_get","parameters":[{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":100,"minimum":1,"description":"Max records to return (1-100).","default":25,"title":"Limit"},"description":"Max records to return (1-100)."},{"name":"offset","in":"query","required":false,"schema":{"type":"integer","minimum":0,"description":"Records to skip, for pagination.","default":0,"title":"Offset"},"description":"Records to skip, for pagination."},{"name":"document_type","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Rule, Proposed Rule, Notice or Presidential Document","examples":["example"],"title":"Document Type"},"description":"Rule, Proposed Rule, Notice or Presidential Document"},{"name":"publication_date","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Date the document was published in the Federal Register","examples":["2026-01-01"],"title":"Publication Date"},"description":"Date the document was published in the Federal Register"},{"name":"X-API-Key","in":"header","required":true,"schema":{"type":"string","title":"X-Api-Key"}}],"responses":{"200":{"description":"A page of United States Federal Register Documents records with pagination metadata.","content":{"application/json":{"schema":{},"example":{"data":{"items":[{"document_number":"example","title":"example","document_type":"example","abstract":"example","publication_date":"2026-01-01","html_url":"example","pdf_url":"example"}],"total":1,"limit":25,"offset":0}}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/data/united-states-federal-register-documents/search":{"get":{"tags":["Government Regulations"],"summary":"Search United States Federal Register Documents by title","description":"Search United States Federal Register Documents records by `title` (partial, case-insensitive).\n\n**Example:** `GET /v1/data/united-states-federal-register-documents/search?q=exa`","operationId":"search_endpoint_v1_data_united_states_federal_register_documents_search_get","parameters":[{"name":"q","in":"query","required":true,"schema":{"type":"string","minLength":2,"maxLength":100,"description":"Case-insensitive partial match on title.","examples":["exa"],"title":"Q"},"description":"Case-insensitive partial match on title."},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":100,"minimum":1,"description":"Max records to return (1-100).","default":25,"title":"Limit"},"description":"Max records to return (1-100)."},{"name":"X-API-Key","in":"header","required":true,"schema":{"type":"string","title":"X-Api-Key"}}],"responses":{"200":{"description":"Matching United States Federal Register Documents records.","content":{"application/json":{"schema":{},"example":{"data":{"items":[{"document_number":"example","title":"example","document_type":"example","abstract":"example","publication_date":"2026-01-01","html_url":"example","pdf_url":"example"}]}}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/data/united-states-federal-register-documents/{key}":{"get":{"tags":["Government Regulations"],"summary":"Get one United States Federal Register Documents record by document_number","description":"Fetch a single United States Federal Register Documents record by its `document_number`.\n\n**Example:** `GET /v1/data/united-states-federal-register-documents/example`","operationId":"get_endpoint_v1_data_united_states_federal_register_documents__key__get","parameters":[{"name":"key","in":"path","required":true,"schema":{"type":"string","description":"The document_number value to look up (case-insensitive).","examples":["example"],"title":"Key"},"description":"The document_number value to look up (case-insensitive)."},{"name":"X-API-Key","in":"header","required":true,"schema":{"type":"string","title":"X-Api-Key"}}],"responses":{"200":{"description":"A single United States Federal Register Documents record.","content":{"application/json":{"schema":{},"example":{"data":{"document_number":"example","title":"example","document_type":"example","abstract":"example","publication_date":"2026-01-01","html_url":"example","pdf_url":"example"}}}}},"404":{"content":{"application/json":{"example":{"error":{"code":"NOT_FOUND","message":"No United States Federal Register Documents record for '...'."}}}},"description":"Not Found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/data/united-states-food-recalls":{"get":{"tags":["Food Recalls"],"summary":"List United States Food Recalls records","description":"List United States Food Recalls records with optional filters and pagination.\n\n**Source:** Data courtesy of openFDA, U.S. Food and Drug Administration. Not endorsed by the FDA. (Public domain (U.S. Government work), openFDA terms of service).\n\n**Fields returned:**\n- `recall_number` (str) — Unique recall identifier\n- `event_id` (str) — Identifier grouping related recall records\n- `status` (str) — Ongoing, completed, terminated or pending\n- `classification` (str) — Hazard class, where Class I is the most serious\n- `product_type` (str) — Product category, typically Food\n- `product_description` (str) — Description of the recalled product\n- `reason_for_recall` (str) — Why the product was recalled, such as an undeclared allergen\n- `recalling_firm` (str) — Company conducting the recall\n- `city` (str) — City of the recalling firm\n- `state` (str) — State or territory of the recalling firm\n- `country` (str) — Country of the recalling firm\n- `distribution_pattern` (str) — Where the product was distributed\n- `product_quantity` (str) — Amount of product affected as reported\n- `code_info` (str) — Lot codes, batch numbers or use-by dates identifying affected stock\n- `voluntary_mandated` (str) — Whether the recall was voluntary or ordered\n- `initial_firm_notification` (str) — How the firm first notified its customers\n- `recall_initiation_date` (date) — Date the firm began the recall\n- `report_date` (date) — Date the recall was published\n- `termination_date` (date) — Date the recall was closed out\n\n**Example:** `GET /v1/data/united-states-food-recalls?limit=10&classification=example`","operationId":"list_endpoint_v1_data_united_states_food_recalls_get","parameters":[{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":100,"minimum":1,"description":"Max records to return (1-100).","default":25,"title":"Limit"},"description":"Max records to return (1-100)."},{"name":"offset","in":"query","required":false,"schema":{"type":"integer","minimum":0,"description":"Records to skip, for pagination.","default":0,"title":"Offset"},"description":"Records to skip, for pagination."},{"name":"classification","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Hazard class, where Class I is the most serious","examples":["example"],"title":"Classification"},"description":"Hazard class, where Class I is the most serious"},{"name":"status","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Ongoing, completed, terminated or pending","examples":["example"],"title":"Status"},"description":"Ongoing, completed, terminated or pending"},{"name":"state","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"State or territory of the recalling firm","examples":["example"],"title":"State"},"description":"State or territory of the recalling firm"},{"name":"country","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Country of the recalling firm","examples":["example"],"title":"Country"},"description":"Country of the recalling firm"},{"name":"recalling_firm","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Company conducting the recall","examples":["example"],"title":"Recalling Firm"},"description":"Company conducting the recall"},{"name":"product_type","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Product category, typically Food","examples":["example"],"title":"Product Type"},"description":"Product category, typically Food"},{"name":"report_date","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Date the recall was published","examples":["2026-01-01"],"title":"Report Date"},"description":"Date the recall was published"},{"name":"X-API-Key","in":"header","required":true,"schema":{"type":"string","title":"X-Api-Key"}}],"responses":{"200":{"description":"A page of United States Food Recalls records with pagination metadata.","content":{"application/json":{"schema":{},"example":{"data":{"items":[{"recall_number":"example","event_id":"example","status":"example","classification":"example","product_type":"example","product_description":"example","reason_for_recall":"example","recalling_firm":"example","city":"example","state":"example","country":"example","distribution_pattern":"example","product_quantity":"example","code_info":"example","voluntary_mandated":"example","initial_firm_notification":"example","recall_initiation_date":"2026-01-01","report_date":"2026-01-01","termination_date":"2026-01-01"}],"total":1,"limit":25,"offset":0}}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/data/united-states-food-recalls/search":{"get":{"tags":["Food Recalls"],"summary":"Search United States Food Recalls by product_description","description":"Search United States Food Recalls records by `product_description` (partial, case-insensitive).\n\n**Example:** `GET /v1/data/united-states-food-recalls/search?q=exa`","operationId":"search_endpoint_v1_data_united_states_food_recalls_search_get","parameters":[{"name":"q","in":"query","required":true,"schema":{"type":"string","minLength":2,"maxLength":100,"description":"Case-insensitive partial match on product_description.","examples":["exa"],"title":"Q"},"description":"Case-insensitive partial match on product_description."},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":100,"minimum":1,"description":"Max records to return (1-100).","default":25,"title":"Limit"},"description":"Max records to return (1-100)."},{"name":"X-API-Key","in":"header","required":true,"schema":{"type":"string","title":"X-Api-Key"}}],"responses":{"200":{"description":"Matching United States Food Recalls records.","content":{"application/json":{"schema":{},"example":{"data":{"items":[{"recall_number":"example","event_id":"example","status":"example","classification":"example","product_type":"example","product_description":"example","reason_for_recall":"example","recalling_firm":"example","city":"example","state":"example","country":"example","distribution_pattern":"example","product_quantity":"example","code_info":"example","voluntary_mandated":"example","initial_firm_notification":"example","recall_initiation_date":"2026-01-01","report_date":"2026-01-01","termination_date":"2026-01-01"}]}}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/data/united-states-food-recalls/{key}":{"get":{"tags":["Food Recalls"],"summary":"Get one United States Food Recalls record by recall_number","description":"Fetch a single United States Food Recalls record by its `recall_number`.\n\n**Example:** `GET /v1/data/united-states-food-recalls/example`","operationId":"get_endpoint_v1_data_united_states_food_recalls__key__get","parameters":[{"name":"key","in":"path","required":true,"schema":{"type":"string","description":"The recall_number value to look up (case-insensitive).","examples":["example"],"title":"Key"},"description":"The recall_number value to look up (case-insensitive)."},{"name":"X-API-Key","in":"header","required":true,"schema":{"type":"string","title":"X-Api-Key"}}],"responses":{"200":{"description":"A single United States Food Recalls record.","content":{"application/json":{"schema":{},"example":{"data":{"recall_number":"example","event_id":"example","status":"example","classification":"example","product_type":"example","product_description":"example","reason_for_recall":"example","recalling_firm":"example","city":"example","state":"example","country":"example","distribution_pattern":"example","product_quantity":"example","code_info":"example","voluntary_mandated":"example","initial_firm_notification":"example","recall_initiation_date":"2026-01-01","report_date":"2026-01-01","termination_date":"2026-01-01"}}}}},"404":{"content":{"application/json":{"example":{"error":{"code":"NOT_FOUND","message":"No United States Food Recalls record for '...'."}}}},"description":"Not Found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/data/united-states-government-domain-names":{"get":{"tags":["Government Directory"],"summary":"List United States Government Domain Names records","description":"List United States Government Domain Names records with optional filters and pagination.\n\n**Source:** Source: Cybersecurity and Infrastructure Security Agency (CISA), .gov Program - dotgov-data. (Public Domain (U.S. Government Work, CC0 1.0)).\n\n**Fields returned:**\n- `domain_name` (str) — The registered .gov domain name.\n- `domain_type` (str) — Level of government, e.g. Federal Agency, State, City, County or Tribal.\n- `agency` (str) — Parent agency or department responsible for the domain.\n- `organization` (str) — Specific organisation or office that registered the domain.\n- `city` (str) — City recorded for the registering organisation.\n- `state` (str) — State or territory recorded for the registering organisation.\n\n**Example:** `GET /v1/data/united-states-government-domain-names?limit=10&domain_type=example`","operationId":"list_endpoint_v1_data_united_states_government_domain_names_get","parameters":[{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":100,"minimum":1,"description":"Max records to return (1-100).","default":25,"title":"Limit"},"description":"Max records to return (1-100)."},{"name":"offset","in":"query","required":false,"schema":{"type":"integer","minimum":0,"description":"Records to skip, for pagination.","default":0,"title":"Offset"},"description":"Records to skip, for pagination."},{"name":"domain_type","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Level of government, e.g. Federal Agency, State, City, County or Tribal.","examples":["example"],"title":"Domain Type"},"description":"Level of government, e.g. Federal Agency, State, City, County or Tribal."},{"name":"agency","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Parent agency or department responsible for the domain.","examples":["example"],"title":"Agency"},"description":"Parent agency or department responsible for the domain."},{"name":"state","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"State or territory recorded for the registering organisation.","examples":["example"],"title":"State"},"description":"State or territory recorded for the registering organisation."},{"name":"X-API-Key","in":"header","required":true,"schema":{"type":"string","title":"X-Api-Key"}}],"responses":{"200":{"description":"A page of United States Government Domain Names records with pagination metadata.","content":{"application/json":{"schema":{},"example":{"data":{"items":[{"domain_name":"example","domain_type":"example","agency":"example","organization":"example","city":"example","state":"example"}],"total":1,"limit":25,"offset":0}}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/data/united-states-government-domain-names/search":{"get":{"tags":["Government Directory"],"summary":"Search United States Government Domain Names by organization","description":"Search United States Government Domain Names records by `organization` (partial, case-insensitive).\n\n**Example:** `GET /v1/data/united-states-government-domain-names/search?q=exa`","operationId":"search_endpoint_v1_data_united_states_government_domain_names_search_get","parameters":[{"name":"q","in":"query","required":true,"schema":{"type":"string","minLength":2,"maxLength":100,"description":"Case-insensitive partial match on organization.","examples":["exa"],"title":"Q"},"description":"Case-insensitive partial match on organization."},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":100,"minimum":1,"description":"Max records to return (1-100).","default":25,"title":"Limit"},"description":"Max records to return (1-100)."},{"name":"X-API-Key","in":"header","required":true,"schema":{"type":"string","title":"X-Api-Key"}}],"responses":{"200":{"description":"Matching United States Government Domain Names records.","content":{"application/json":{"schema":{},"example":{"data":{"items":[{"domain_name":"example","domain_type":"example","agency":"example","organization":"example","city":"example","state":"example"}]}}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/data/united-states-government-domain-names/{key}":{"get":{"tags":["Government Directory"],"summary":"Get one United States Government Domain Names record by domain_name","description":"Fetch a single United States Government Domain Names record by its `domain_name`.\n\n**Example:** `GET /v1/data/united-states-government-domain-names/example`","operationId":"get_endpoint_v1_data_united_states_government_domain_names__key__get","parameters":[{"name":"key","in":"path","required":true,"schema":{"type":"string","description":"The domain_name value to look up (case-insensitive).","examples":["example"],"title":"Key"},"description":"The domain_name value to look up (case-insensitive)."},{"name":"X-API-Key","in":"header","required":true,"schema":{"type":"string","title":"X-Api-Key"}}],"responses":{"200":{"description":"A single United States Government Domain Names record.","content":{"application/json":{"schema":{},"example":{"data":{"domain_name":"example","domain_type":"example","agency":"example","organization":"example","city":"example","state":"example"}}}}},"404":{"content":{"application/json":{"example":{"error":{"code":"NOT_FOUND","message":"No United States Government Domain Names record for '...'."}}}},"description":"Not Found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/data/united-states-leading-causes-death":{"get":{"tags":["Public Health"],"summary":"List United States Leading Causes of Death records","description":"List United States Leading Causes of Death records with optional filters and pagination.\n\n**Source:** Source: Centers for Disease Control and Prevention, National Center for Health Statistics (Public Domain (US Government Work)).\n\n**Fields returned:**\n- `year` (int) — Calendar year\n- `cause_code_name` (str) — Detailed NCHS 113 cause list name with ICD-10 codes\n- `cause_name` (str) — Plain cause of death name\n- `state` (str) — US state, District of Columbia or United States\n- `deaths` (int) — Number of deaths\n- `age_adjusted_death_rate` (float) — Age-adjusted deaths per 100,000 population\n\n**Example:** `GET /v1/data/united-states-leading-causes-death?limit=10&year=42`","operationId":"list_endpoint_v1_data_united_states_leading_causes_death_get","parameters":[{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":100,"minimum":1,"description":"Max records to return (1-100).","default":25,"title":"Limit"},"description":"Max records to return (1-100)."},{"name":"offset","in":"query","required":false,"schema":{"type":"integer","minimum":0,"description":"Records to skip, for pagination.","default":0,"title":"Offset"},"description":"Records to skip, for pagination."},{"name":"year","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Calendar year","examples":["42"],"title":"Year"},"description":"Calendar year"},{"name":"state","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"US state, District of Columbia or United States","examples":["example"],"title":"State"},"description":"US state, District of Columbia or United States"},{"name":"cause_name","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Plain cause of death name","examples":["example"],"title":"Cause Name"},"description":"Plain cause of death name"},{"name":"X-API-Key","in":"header","required":true,"schema":{"type":"string","title":"X-Api-Key"}}],"responses":{"200":{"description":"A page of United States Leading Causes of Death records with pagination metadata.","content":{"application/json":{"schema":{},"example":{"data":{"items":[{"year":42,"cause_code_name":"example","cause_name":"example","state":"example","deaths":42,"age_adjusted_death_rate":4.2}],"total":1,"limit":25,"offset":0}}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/data/united-states-leading-causes-death/search":{"get":{"tags":["Public Health"],"summary":"Search United States Leading Causes of Death by cause_name","description":"Search United States Leading Causes of Death records by `cause_name` (partial, case-insensitive).\n\n**Example:** `GET /v1/data/united-states-leading-causes-death/search?q=exa`","operationId":"search_endpoint_v1_data_united_states_leading_causes_death_search_get","parameters":[{"name":"q","in":"query","required":true,"schema":{"type":"string","minLength":2,"maxLength":100,"description":"Case-insensitive partial match on cause_name.","examples":["exa"],"title":"Q"},"description":"Case-insensitive partial match on cause_name."},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":100,"minimum":1,"description":"Max records to return (1-100).","default":25,"title":"Limit"},"description":"Max records to return (1-100)."},{"name":"X-API-Key","in":"header","required":true,"schema":{"type":"string","title":"X-Api-Key"}}],"responses":{"200":{"description":"Matching United States Leading Causes of Death records.","content":{"application/json":{"schema":{},"example":{"data":{"items":[{"year":42,"cause_code_name":"example","cause_name":"example","state":"example","deaths":42,"age_adjusted_death_rate":4.2}]}}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/data/united-states-leading-causes-death/{key}":{"get":{"tags":["Public Health"],"summary":"Get one United States Leading Causes of Death record by state","description":"Fetch a single United States Leading Causes of Death record by its `state`.\n\n**Example:** `GET /v1/data/united-states-leading-causes-death/example`","operationId":"get_endpoint_v1_data_united_states_leading_causes_death__key__get","parameters":[{"name":"key","in":"path","required":true,"schema":{"type":"string","description":"The state value to look up (case-insensitive).","examples":["example"],"title":"Key"},"description":"The state value to look up (case-insensitive)."},{"name":"X-API-Key","in":"header","required":true,"schema":{"type":"string","title":"X-Api-Key"}}],"responses":{"200":{"description":"A single United States Leading Causes of Death record.","content":{"application/json":{"schema":{},"example":{"data":{"year":42,"cause_code_name":"example","cause_name":"example","state":"example","deaths":42,"age_adjusted_death_rate":4.2}}}}},"404":{"content":{"application/json":{"example":{"error":{"code":"NOT_FOUND","message":"No United States Leading Causes of Death record for '...'."}}}},"description":"Not Found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/data/united-states-medical-device-catalogue":{"get":{"tags":["Medical Devices"],"summary":"List United States Medical Device Catalogue records","description":"List United States Medical Device Catalogue records with optional filters and pagination.\n\n**Source:** Source: U.S. Food and Drug Administration, openFDA (U.S. Public Domain (openFDA)).\n\n**Fields returned:**\n- `device_record_key` (str) — Unique identifier for the device record\n- `brand_name` (str) — Brand name the device is marketed under\n- `company_name` (str) — Company that labels or manufactures the device\n- `device_description` (str) — Short description of what the device is\n- `model_number` (str) — Version or model number\n- `catalog_number` (str) — Manufacturer catalogue number\n- `package_count` (int) — Number of devices in the base package\n- `is_single_use` (bool) — True when the device is labelled single use\n- `is_kit` (bool) — True when the record describes a kit\n- `has_lot_or_batch_number` (bool) — True when units carry a lot or batch number\n- `has_expiration_date` (bool) — True when units carry an expiry date\n- `mri_safety` (str) — Magnetic resonance imaging safety status\n- `distribution_status` (str) — Whether the device is in commercial distribution\n- `published_date` (date) — Date the record was published\n\n**Example:** `GET /v1/data/united-states-medical-device-catalogue?limit=10&company_name=example`","operationId":"list_endpoint_v1_data_united_states_medical_device_catalogue_get","parameters":[{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":100,"minimum":1,"description":"Max records to return (1-100).","default":25,"title":"Limit"},"description":"Max records to return (1-100)."},{"name":"offset","in":"query","required":false,"schema":{"type":"integer","minimum":0,"description":"Records to skip, for pagination.","default":0,"title":"Offset"},"description":"Records to skip, for pagination."},{"name":"company_name","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Company that labels or manufactures the device","examples":["example"],"title":"Company Name"},"description":"Company that labels or manufactures the device"},{"name":"distribution_status","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Whether the device is in commercial distribution","examples":["example"],"title":"Distribution Status"},"description":"Whether the device is in commercial distribution"},{"name":"is_single_use","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"True when the device is labelled single use","examples":["True"],"title":"Is Single Use"},"description":"True when the device is labelled single use"},{"name":"mri_safety","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Magnetic resonance imaging safety status","examples":["example"],"title":"Mri Safety"},"description":"Magnetic resonance imaging safety status"},{"name":"X-API-Key","in":"header","required":true,"schema":{"type":"string","title":"X-Api-Key"}}],"responses":{"200":{"description":"A page of United States Medical Device Catalogue records with pagination metadata.","content":{"application/json":{"schema":{},"example":{"data":{"items":[{"device_record_key":"example","brand_name":"example","company_name":"example","device_description":"example","model_number":"example","catalog_number":"example","package_count":42,"is_single_use":true,"is_kit":true,"has_lot_or_batch_number":true,"has_expiration_date":true,"mri_safety":"example","distribution_status":"example","published_date":"2026-01-01"}],"total":1,"limit":25,"offset":0}}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/data/united-states-medical-device-catalogue/search":{"get":{"tags":["Medical Devices"],"summary":"Search United States Medical Device Catalogue by brand_name","description":"Search United States Medical Device Catalogue records by `brand_name` (partial, case-insensitive).\n\n**Example:** `GET /v1/data/united-states-medical-device-catalogue/search?q=exa`","operationId":"search_endpoint_v1_data_united_states_medical_device_catalogue_search_get","parameters":[{"name":"q","in":"query","required":true,"schema":{"type":"string","minLength":2,"maxLength":100,"description":"Case-insensitive partial match on brand_name.","examples":["exa"],"title":"Q"},"description":"Case-insensitive partial match on brand_name."},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":100,"minimum":1,"description":"Max records to return (1-100).","default":25,"title":"Limit"},"description":"Max records to return (1-100)."},{"name":"X-API-Key","in":"header","required":true,"schema":{"type":"string","title":"X-Api-Key"}}],"responses":{"200":{"description":"Matching United States Medical Device Catalogue records.","content":{"application/json":{"schema":{},"example":{"data":{"items":[{"device_record_key":"example","brand_name":"example","company_name":"example","device_description":"example","model_number":"example","catalog_number":"example","package_count":42,"is_single_use":true,"is_kit":true,"has_lot_or_batch_number":true,"has_expiration_date":true,"mri_safety":"example","distribution_status":"example","published_date":"2026-01-01"}]}}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/data/united-states-medical-device-catalogue/{key}":{"get":{"tags":["Medical Devices"],"summary":"Get one United States Medical Device Catalogue record by device_record_key","description":"Fetch a single United States Medical Device Catalogue record by its `device_record_key`.\n\n**Example:** `GET /v1/data/united-states-medical-device-catalogue/example`","operationId":"get_endpoint_v1_data_united_states_medical_device_catalogue__key__get","parameters":[{"name":"key","in":"path","required":true,"schema":{"type":"string","description":"The device_record_key value to look up (case-insensitive).","examples":["example"],"title":"Key"},"description":"The device_record_key value to look up (case-insensitive)."},{"name":"X-API-Key","in":"header","required":true,"schema":{"type":"string","title":"X-Api-Key"}}],"responses":{"200":{"description":"A single United States Medical Device Catalogue record.","content":{"application/json":{"schema":{},"example":{"data":{"device_record_key":"example","brand_name":"example","company_name":"example","device_description":"example","model_number":"example","catalog_number":"example","package_count":42,"is_single_use":true,"is_kit":true,"has_lot_or_batch_number":true,"has_expiration_date":true,"mri_safety":"example","distribution_status":"example","published_date":"2026-01-01"}}}}},"404":{"content":{"application/json":{"example":{"error":{"code":"NOT_FOUND","message":"No United States Medical Device Catalogue record for '...'."}}}},"description":"Not Found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/data/united-states-medical-device-recalls":{"get":{"tags":["Medical Devices"],"summary":"List United States Medical Device Recalls records","description":"List United States Medical Device Recalls records with optional filters and pagination.\n\n**Source:** Source: openFDA, U.S. Food and Drug Administration. Not endorsed by the FDA. (Public domain (U.S. Government Work)).\n\n**Fields returned:**\n- `recall_number` (str) — FDA identifier for the recall event\n- `event_id` (str) — Identifier grouping related recall records\n- `status` (str) — Whether the recall is ongoing, completed or terminated\n- `classification` (str) — Risk class of the recall, Class I being most serious\n- `product_description` (str) — Description of the recalled device\n- `reason_for_recall` (str) — Why the device was recalled\n- `recalling_firm` (str) — Company conducting the recall\n- `firm_city` (str) — City of the recalling company\n- `firm_state` (str) — State of the recalling company\n- `firm_country` (str) — Country of the recalling company\n- `voluntary_or_mandated` (str) — Whether the recall was voluntary or FDA mandated\n- `distribution_pattern` (str) — Where the affected devices were distributed\n- `product_quantity` (str) — Quantity of product affected\n- `recall_initiation_date` (date) — Date the firm began the recall\n- `report_date` (date) — Date the recall was published by the FDA\n- `termination_date` (date) — Date the recall was terminated, if closed\n\n**Example:** `GET /v1/data/united-states-medical-device-recalls?limit=10&classification=example`","operationId":"list_endpoint_v1_data_united_states_medical_device_recalls_get","parameters":[{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":100,"minimum":1,"description":"Max records to return (1-100).","default":25,"title":"Limit"},"description":"Max records to return (1-100)."},{"name":"offset","in":"query","required":false,"schema":{"type":"integer","minimum":0,"description":"Records to skip, for pagination.","default":0,"title":"Offset"},"description":"Records to skip, for pagination."},{"name":"classification","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Risk class of the recall, Class I being most serious","examples":["example"],"title":"Classification"},"description":"Risk class of the recall, Class I being most serious"},{"name":"status","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Whether the recall is ongoing, completed or terminated","examples":["example"],"title":"Status"},"description":"Whether the recall is ongoing, completed or terminated"},{"name":"recalling_firm","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Company conducting the recall","examples":["example"],"title":"Recalling Firm"},"description":"Company conducting the recall"},{"name":"firm_state","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"State of the recalling company","examples":["example"],"title":"Firm State"},"description":"State of the recalling company"},{"name":"firm_country","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Country of the recalling company","examples":["example"],"title":"Firm Country"},"description":"Country of the recalling company"},{"name":"report_date","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Date the recall was published by the FDA","examples":["2026-01-01"],"title":"Report Date"},"description":"Date the recall was published by the FDA"},{"name":"X-API-Key","in":"header","required":true,"schema":{"type":"string","title":"X-Api-Key"}}],"responses":{"200":{"description":"A page of United States Medical Device Recalls records with pagination metadata.","content":{"application/json":{"schema":{},"example":{"data":{"items":[{"recall_number":"example","event_id":"example","status":"example","classification":"example","product_description":"example","reason_for_recall":"example","recalling_firm":"example","firm_city":"example","firm_state":"example","firm_country":"example","voluntary_or_mandated":"example","distribution_pattern":"example","product_quantity":"example","recall_initiation_date":"2026-01-01","report_date":"2026-01-01","termination_date":"2026-01-01"}],"total":1,"limit":25,"offset":0}}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/data/united-states-medical-device-recalls/search":{"get":{"tags":["Medical Devices"],"summary":"Search United States Medical Device Recalls by product_description","description":"Search United States Medical Device Recalls records by `product_description` (partial, case-insensitive).\n\n**Example:** `GET /v1/data/united-states-medical-device-recalls/search?q=exa`","operationId":"search_endpoint_v1_data_united_states_medical_device_recalls_search_get","parameters":[{"name":"q","in":"query","required":true,"schema":{"type":"string","minLength":2,"maxLength":100,"description":"Case-insensitive partial match on product_description.","examples":["exa"],"title":"Q"},"description":"Case-insensitive partial match on product_description."},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":100,"minimum":1,"description":"Max records to return (1-100).","default":25,"title":"Limit"},"description":"Max records to return (1-100)."},{"name":"X-API-Key","in":"header","required":true,"schema":{"type":"string","title":"X-Api-Key"}}],"responses":{"200":{"description":"Matching United States Medical Device Recalls records.","content":{"application/json":{"schema":{},"example":{"data":{"items":[{"recall_number":"example","event_id":"example","status":"example","classification":"example","product_description":"example","reason_for_recall":"example","recalling_firm":"example","firm_city":"example","firm_state":"example","firm_country":"example","voluntary_or_mandated":"example","distribution_pattern":"example","product_quantity":"example","recall_initiation_date":"2026-01-01","report_date":"2026-01-01","termination_date":"2026-01-01"}]}}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/data/united-states-medical-device-recalls/{key}":{"get":{"tags":["Medical Devices"],"summary":"Get one United States Medical Device Recalls record by recall_number","description":"Fetch a single United States Medical Device Recalls record by its `recall_number`.\n\n**Example:** `GET /v1/data/united-states-medical-device-recalls/example`","operationId":"get_endpoint_v1_data_united_states_medical_device_recalls__key__get","parameters":[{"name":"key","in":"path","required":true,"schema":{"type":"string","description":"The recall_number value to look up (case-insensitive).","examples":["example"],"title":"Key"},"description":"The recall_number value to look up (case-insensitive)."},{"name":"X-API-Key","in":"header","required":true,"schema":{"type":"string","title":"X-Api-Key"}}],"responses":{"200":{"description":"A single United States Medical Device Recalls record.","content":{"application/json":{"schema":{},"example":{"data":{"recall_number":"example","event_id":"example","status":"example","classification":"example","product_description":"example","reason_for_recall":"example","recalling_firm":"example","firm_city":"example","firm_state":"example","firm_country":"example","voluntary_or_mandated":"example","distribution_pattern":"example","product_quantity":"example","recall_initiation_date":"2026-01-01","report_date":"2026-01-01","termination_date":"2026-01-01"}}}}},"404":{"content":{"application/json":{"example":{"error":{"code":"NOT_FOUND","message":"No United States Medical Device Recalls record for '...'."}}}},"description":"Not Found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/data/united-states-severe-weather-alerts":{"get":{"tags":["Weather Alerts"],"summary":"List United States Severe Weather Alerts records","description":"List United States Severe Weather Alerts records with optional filters and pagination.\n\n**Source:** Source: NOAA / National Weather Service, api.weather.gov. (Public Domain (U.S. Government work, 17 U.S.C. 105)).\n\n**Fields returned:**\n- `alert_id` (str) — Unique National Weather Service alert identifier\n- `event` (str) — Alert type, e.g. Tornado Warning or Flood Watch\n- `headline` (str) — One-line human readable headline for the alert\n- `area_description` (str) — Counties, zones or regions covered by the alert\n- `severity` (str) — Extreme, Severe, Moderate, Minor or Unknown\n- `urgency` (str) — Immediate, Expected, Future, Past or Unknown\n- `certainty` (str) — Observed, Likely, Possible, Unlikely or Unknown\n- `status` (str) — Actual, Exercise, Test or Draft\n- `message_type` (str) — Alert, Update or Cancel\n- `sender_name` (str) — Issuing weather forecast office\n- `effective_at` (date) — When the alert takes effect\n- `expires_at` (date) — When the alert expires\n\n**Example:** `GET /v1/data/united-states-severe-weather-alerts?limit=10&event=example`","operationId":"list_endpoint_v1_data_united_states_severe_weather_alerts_get","parameters":[{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":100,"minimum":1,"description":"Max records to return (1-100).","default":25,"title":"Limit"},"description":"Max records to return (1-100)."},{"name":"offset","in":"query","required":false,"schema":{"type":"integer","minimum":0,"description":"Records to skip, for pagination.","default":0,"title":"Offset"},"description":"Records to skip, for pagination."},{"name":"event","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Alert type, e.g. Tornado Warning or Flood Watch","examples":["example"],"title":"Event"},"description":"Alert type, e.g. Tornado Warning or Flood Watch"},{"name":"severity","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Extreme, Severe, Moderate, Minor or Unknown","examples":["example"],"title":"Severity"},"description":"Extreme, Severe, Moderate, Minor or Unknown"},{"name":"urgency","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Immediate, Expected, Future, Past or Unknown","examples":["example"],"title":"Urgency"},"description":"Immediate, Expected, Future, Past or Unknown"},{"name":"status","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Actual, Exercise, Test or Draft","examples":["example"],"title":"Status"},"description":"Actual, Exercise, Test or Draft"},{"name":"sender_name","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Issuing weather forecast office","examples":["example"],"title":"Sender Name"},"description":"Issuing weather forecast office"},{"name":"X-API-Key","in":"header","required":true,"schema":{"type":"string","title":"X-Api-Key"}}],"responses":{"200":{"description":"A page of United States Severe Weather Alerts records with pagination metadata.","content":{"application/json":{"schema":{},"example":{"data":{"items":[{"alert_id":"example","event":"example","headline":"example","area_description":"example","severity":"example","urgency":"example","certainty":"example","status":"example","message_type":"example","sender_name":"example","effective_at":"2026-01-01","expires_at":"2026-01-01"}],"total":1,"limit":25,"offset":0}}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/data/united-states-severe-weather-alerts/search":{"get":{"tags":["Weather Alerts"],"summary":"Search United States Severe Weather Alerts by area_description","description":"Search United States Severe Weather Alerts records by `area_description` (partial, case-insensitive).\n\n**Example:** `GET /v1/data/united-states-severe-weather-alerts/search?q=exa`","operationId":"search_endpoint_v1_data_united_states_severe_weather_alerts_search_get","parameters":[{"name":"q","in":"query","required":true,"schema":{"type":"string","minLength":2,"maxLength":100,"description":"Case-insensitive partial match on area_description.","examples":["exa"],"title":"Q"},"description":"Case-insensitive partial match on area_description."},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":100,"minimum":1,"description":"Max records to return (1-100).","default":25,"title":"Limit"},"description":"Max records to return (1-100)."},{"name":"X-API-Key","in":"header","required":true,"schema":{"type":"string","title":"X-Api-Key"}}],"responses":{"200":{"description":"Matching United States Severe Weather Alerts records.","content":{"application/json":{"schema":{},"example":{"data":{"items":[{"alert_id":"example","event":"example","headline":"example","area_description":"example","severity":"example","urgency":"example","certainty":"example","status":"example","message_type":"example","sender_name":"example","effective_at":"2026-01-01","expires_at":"2026-01-01"}]}}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/data/united-states-severe-weather-alerts/{key}":{"get":{"tags":["Weather Alerts"],"summary":"Get one United States Severe Weather Alerts record by alert_id","description":"Fetch a single United States Severe Weather Alerts record by its `alert_id`.\n\n**Example:** `GET /v1/data/united-states-severe-weather-alerts/example`","operationId":"get_endpoint_v1_data_united_states_severe_weather_alerts__key__get","parameters":[{"name":"key","in":"path","required":true,"schema":{"type":"string","description":"The alert_id value to look up (case-insensitive).","examples":["example"],"title":"Key"},"description":"The alert_id value to look up (case-insensitive)."},{"name":"X-API-Key","in":"header","required":true,"schema":{"type":"string","title":"X-Api-Key"}}],"responses":{"200":{"description":"A single United States Severe Weather Alerts record.","content":{"application/json":{"schema":{},"example":{"data":{"alert_id":"example","event":"example","headline":"example","area_description":"example","severity":"example","urgency":"example","certainty":"example","status":"example","message_type":"example","sender_name":"example","effective_at":"2026-01-01","expires_at":"2026-01-01"}}}}},"404":{"content":{"application/json":{"example":{"error":{"code":"NOT_FOUND","message":"No United States Severe Weather Alerts record for '...'."}}}},"description":"Not Found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/data/united-states-vehicle-makes-directory":{"get":{"tags":["Vehicle Makes"],"summary":"List United States Vehicle Makes Directory records","description":"List United States Vehicle Makes Directory records with optional filters and pagination.\n\n**Source:** Source: U.S. Department of Transportation, National Highway Traffic Safety Administration (NHTSA), vPIC API (US Government Work (Public Domain)).\n\n**Fields returned:**\n- `make_id` (int) — NHTSA unique numeric identifier for the vehicle make\n- `make_name` (str) — Official vehicle make (brand) name\n\n**Example:** `GET /v1/data/united-states-vehicle-makes-directory?limit=10&make_name=example`","operationId":"list_endpoint_v1_data_united_states_vehicle_makes_directory_get","parameters":[{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":100,"minimum":1,"description":"Max records to return (1-100).","default":25,"title":"Limit"},"description":"Max records to return (1-100)."},{"name":"offset","in":"query","required":false,"schema":{"type":"integer","minimum":0,"description":"Records to skip, for pagination.","default":0,"title":"Offset"},"description":"Records to skip, for pagination."},{"name":"make_name","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Official vehicle make (brand) name","examples":["example"],"title":"Make Name"},"description":"Official vehicle make (brand) name"},{"name":"X-API-Key","in":"header","required":true,"schema":{"type":"string","title":"X-Api-Key"}}],"responses":{"200":{"description":"A page of United States Vehicle Makes Directory records with pagination metadata.","content":{"application/json":{"schema":{},"example":{"data":{"items":[{"make_id":42,"make_name":"example"}],"total":1,"limit":25,"offset":0}}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/data/united-states-vehicle-makes-directory/search":{"get":{"tags":["Vehicle Makes"],"summary":"Search United States Vehicle Makes Directory by make_name","description":"Search United States Vehicle Makes Directory records by `make_name` (partial, case-insensitive).\n\n**Example:** `GET /v1/data/united-states-vehicle-makes-directory/search?q=exa`","operationId":"search_endpoint_v1_data_united_states_vehicle_makes_directory_search_get","parameters":[{"name":"q","in":"query","required":true,"schema":{"type":"string","minLength":2,"maxLength":100,"description":"Case-insensitive partial match on make_name.","examples":["exa"],"title":"Q"},"description":"Case-insensitive partial match on make_name."},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":100,"minimum":1,"description":"Max records to return (1-100).","default":25,"title":"Limit"},"description":"Max records to return (1-100)."},{"name":"X-API-Key","in":"header","required":true,"schema":{"type":"string","title":"X-Api-Key"}}],"responses":{"200":{"description":"Matching United States Vehicle Makes Directory records.","content":{"application/json":{"schema":{},"example":{"data":{"items":[{"make_id":42,"make_name":"example"}]}}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/data/united-states-vehicle-makes-directory/{key}":{"get":{"tags":["Vehicle Makes"],"summary":"Get one United States Vehicle Makes Directory record by make_id","description":"Fetch a single United States Vehicle Makes Directory record by its `make_id`.\n\n**Example:** `GET /v1/data/united-states-vehicle-makes-directory/42`","operationId":"get_endpoint_v1_data_united_states_vehicle_makes_directory__key__get","parameters":[{"name":"key","in":"path","required":true,"schema":{"type":"string","description":"The make_id value to look up (case-insensitive).","examples":["42"],"title":"Key"},"description":"The make_id value to look up (case-insensitive)."},{"name":"X-API-Key","in":"header","required":true,"schema":{"type":"string","title":"X-Api-Key"}}],"responses":{"200":{"description":"A single United States Vehicle Makes Directory record.","content":{"application/json":{"schema":{},"example":{"data":{"make_id":42,"make_name":"example"}}}}},"404":{"content":{"application/json":{"example":{"error":{"code":"NOT_FOUND","message":"No United States Vehicle Makes Directory record for '...'."}}}},"description":"Not Found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/data/washington-state-electric-vehicle-registrations":{"get":{"tags":["Electric Vehicles"],"summary":"List Washington State Electric Vehicle Registrations records","description":"List Washington State Electric Vehicle Registrations records with optional filters and pagination.\n\n**Source:** Washington State Department of Licensing, Electric Vehicle Population Data, via data.wa.gov (Washington State open data (data.wa.gov terms of use)).\n\n**Fields returned:**\n- `vin_prefix` (str) — First 10 characters of the vehicle identification number (not a full VIN)\n- `county` (str) — County where the vehicle is registered\n- `city` (str) — City where the vehicle is registered\n- `state` (str) — State of registration\n- `postal_code` (str) — Postal code of registration area\n- `model_year` (int) — Vehicle model year\n- `make` (str) — Vehicle manufacturer\n- `model` (str) — Vehicle model\n- `electric_vehicle_type` (str) — Battery Electric Vehicle (BEV) or Plug-in Hybrid Electric Vehicle (PHEV)\n- `clean_fuel_eligibility` (str) — Clean Alternative Fuel Vehicle eligibility status\n- `electric_range` (int) — Rated all-electric range in miles (0 where not yet researched)\n- `base_msrp` (float) — Lowest manufacturer suggested retail price for the model (0 where unknown)\n- `legislative_district` (int) — Washington State legislative district\n- `dol_vehicle_id` (str) — Unique Department of Licensing vehicle record identifier\n- `vehicle_location` (str) — Approximate centre point of the postal code as a WKT POINT\n- `electric_utility` (str) — Electric utility serving the registration area\n- `census_tract` (str) — 2020 census tract identifier\n\n**Example:** `GET /v1/data/washington-state-electric-vehicle-registrations?limit=10&make=example`","operationId":"list_endpoint_v1_data_washington_state_electric_vehicle_registrations_get","parameters":[{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":100,"minimum":1,"description":"Max records to return (1-100).","default":25,"title":"Limit"},"description":"Max records to return (1-100)."},{"name":"offset","in":"query","required":false,"schema":{"type":"integer","minimum":0,"description":"Records to skip, for pagination.","default":0,"title":"Offset"},"description":"Records to skip, for pagination."},{"name":"make","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Vehicle manufacturer","examples":["example"],"title":"Make"},"description":"Vehicle manufacturer"},{"name":"model_year","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Vehicle model year","examples":["42"],"title":"Model Year"},"description":"Vehicle model year"},{"name":"county","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"County where the vehicle is registered","examples":["example"],"title":"County"},"description":"County where the vehicle is registered"},{"name":"electric_vehicle_type","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Battery Electric Vehicle (BEV) or Plug-in Hybrid Electric Vehicle (PHEV)","examples":["example"],"title":"Electric Vehicle Type"},"description":"Battery Electric Vehicle (BEV) or Plug-in Hybrid Electric Vehicle (PHEV)"},{"name":"electric_utility","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Electric utility serving the registration area","examples":["example"],"title":"Electric Utility"},"description":"Electric utility serving the registration area"},{"name":"X-API-Key","in":"header","required":true,"schema":{"type":"string","title":"X-Api-Key"}}],"responses":{"200":{"description":"A page of Washington State Electric Vehicle Registrations records with pagination metadata.","content":{"application/json":{"schema":{},"example":{"data":{"items":[{"vin_prefix":"example","county":"example","city":"example","state":"example","postal_code":"example","model_year":42,"make":"example","model":"example","electric_vehicle_type":"example","clean_fuel_eligibility":"example","electric_range":42,"base_msrp":4.2,"legislative_district":42,"dol_vehicle_id":"example","vehicle_location":"example","electric_utility":"example","census_tract":"example"}],"total":1,"limit":25,"offset":0}}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/data/washington-state-electric-vehicle-registrations/search":{"get":{"tags":["Electric Vehicles"],"summary":"Search Washington State Electric Vehicle Registrations by model","description":"Search Washington State Electric Vehicle Registrations records by `model` (partial, case-insensitive).\n\n**Example:** `GET /v1/data/washington-state-electric-vehicle-registrations/search?q=exa`","operationId":"search_endpoint_v1_data_washington_state_electric_vehicle_registrations_search_get","parameters":[{"name":"q","in":"query","required":true,"schema":{"type":"string","minLength":2,"maxLength":100,"description":"Case-insensitive partial match on model.","examples":["exa"],"title":"Q"},"description":"Case-insensitive partial match on model."},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":100,"minimum":1,"description":"Max records to return (1-100).","default":25,"title":"Limit"},"description":"Max records to return (1-100)."},{"name":"X-API-Key","in":"header","required":true,"schema":{"type":"string","title":"X-Api-Key"}}],"responses":{"200":{"description":"Matching Washington State Electric Vehicle Registrations records.","content":{"application/json":{"schema":{},"example":{"data":{"items":[{"vin_prefix":"example","county":"example","city":"example","state":"example","postal_code":"example","model_year":42,"make":"example","model":"example","electric_vehicle_type":"example","clean_fuel_eligibility":"example","electric_range":42,"base_msrp":4.2,"legislative_district":42,"dol_vehicle_id":"example","vehicle_location":"example","electric_utility":"example","census_tract":"example"}]}}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/data/washington-state-electric-vehicle-registrations/{key}":{"get":{"tags":["Electric Vehicles"],"summary":"Get one Washington State Electric Vehicle Registrations record by dol_vehicle_id","description":"Fetch a single Washington State Electric Vehicle Registrations record by its `dol_vehicle_id`.\n\n**Example:** `GET /v1/data/washington-state-electric-vehicle-registrations/example`","operationId":"get_endpoint_v1_data_washington_state_electric_vehicle_registrations__key__get","parameters":[{"name":"key","in":"path","required":true,"schema":{"type":"string","description":"The dol_vehicle_id value to look up (case-insensitive).","examples":["example"],"title":"Key"},"description":"The dol_vehicle_id value to look up (case-insensitive)."},{"name":"X-API-Key","in":"header","required":true,"schema":{"type":"string","title":"X-Api-Key"}}],"responses":{"200":{"description":"A single Washington State Electric Vehicle Registrations record.","content":{"application/json":{"schema":{},"example":{"data":{"vin_prefix":"example","county":"example","city":"example","state":"example","postal_code":"example","model_year":42,"make":"example","model":"example","electric_vehicle_type":"example","clean_fuel_eligibility":"example","electric_range":42,"base_msrp":4.2,"legislative_district":42,"dol_vehicle_id":"example","vehicle_location":"example","electric_utility":"example","census_tract":"example"}}}}},"404":{"content":{"application/json":{"example":{"error":{"code":"NOT_FOUND","message":"No Washington State Electric Vehicle Registrations record for '...'."}}}},"description":"Not Found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/data/world-currency-codes":{"get":{"tags":["Currency Codes"],"summary":"List World Currency Codes records","description":"List World Currency Codes records with optional filters and pagination.\n\n**Source:** Currency code data from the Frictionless Data core datasets (github.com/datasets/currency-codes), derived from the ISO 4217 maintenance agency list. (ODC PDDL 1.0).\n\n**Fields returned:**\n- `entity` (str) — Country or territory that uses the currency\n- `currency` (str) — Currency name\n- `alphabetic_code` (str) — Three-letter currency code, e.g. AUD\n- `numeric_code` (str) — Three-digit numeric currency code\n- `minor_unit` (str) — Number of decimal places used for the currency\n- `withdrawal_date` (str) — Date the currency was withdrawn, if retired\n\n**Example:** `GET /v1/data/world-currency-codes?limit=10&entity=example`","operationId":"list_endpoint_v1_data_world_currency_codes_get","parameters":[{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":100,"minimum":1,"description":"Max records to return (1-100).","default":25,"title":"Limit"},"description":"Max records to return (1-100)."},{"name":"offset","in":"query","required":false,"schema":{"type":"integer","minimum":0,"description":"Records to skip, for pagination.","default":0,"title":"Offset"},"description":"Records to skip, for pagination."},{"name":"entity","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Country or territory that uses the currency","examples":["example"],"title":"Entity"},"description":"Country or territory that uses the currency"},{"name":"alphabetic_code","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Three-letter currency code, e.g. AUD","examples":["example"],"title":"Alphabetic Code"},"description":"Three-letter currency code, e.g. AUD"},{"name":"numeric_code","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Three-digit numeric currency code","examples":["example"],"title":"Numeric Code"},"description":"Three-digit numeric currency code"},{"name":"X-API-Key","in":"header","required":true,"schema":{"type":"string","title":"X-Api-Key"}}],"responses":{"200":{"description":"A page of World Currency Codes records with pagination metadata.","content":{"application/json":{"schema":{},"example":{"data":{"items":[{"entity":"example","currency":"example","alphabetic_code":"example","numeric_code":"example","minor_unit":"example","withdrawal_date":"example"}],"total":1,"limit":25,"offset":0}}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/data/world-currency-codes/search":{"get":{"tags":["Currency Codes"],"summary":"Search World Currency Codes by currency","description":"Search World Currency Codes records by `currency` (partial, case-insensitive).\n\n**Example:** `GET /v1/data/world-currency-codes/search?q=exa`","operationId":"search_endpoint_v1_data_world_currency_codes_search_get","parameters":[{"name":"q","in":"query","required":true,"schema":{"type":"string","minLength":2,"maxLength":100,"description":"Case-insensitive partial match on currency.","examples":["exa"],"title":"Q"},"description":"Case-insensitive partial match on currency."},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":100,"minimum":1,"description":"Max records to return (1-100).","default":25,"title":"Limit"},"description":"Max records to return (1-100)."},{"name":"X-API-Key","in":"header","required":true,"schema":{"type":"string","title":"X-Api-Key"}}],"responses":{"200":{"description":"Matching World Currency Codes records.","content":{"application/json":{"schema":{},"example":{"data":{"items":[{"entity":"example","currency":"example","alphabetic_code":"example","numeric_code":"example","minor_unit":"example","withdrawal_date":"example"}]}}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/data/world-currency-codes/{key}":{"get":{"tags":["Currency Codes"],"summary":"Get one World Currency Codes record by alphabetic_code","description":"Fetch a single World Currency Codes record by its `alphabetic_code`.\n\n**Example:** `GET /v1/data/world-currency-codes/example`","operationId":"get_endpoint_v1_data_world_currency_codes__key__get","parameters":[{"name":"key","in":"path","required":true,"schema":{"type":"string","description":"The alphabetic_code value to look up (case-insensitive).","examples":["example"],"title":"Key"},"description":"The alphabetic_code value to look up (case-insensitive)."},{"name":"X-API-Key","in":"header","required":true,"schema":{"type":"string","title":"X-Api-Key"}}],"responses":{"200":{"description":"A single World Currency Codes record.","content":{"application/json":{"schema":{},"example":{"data":{"entity":"example","currency":"example","alphabetic_code":"example","numeric_code":"example","minor_unit":"example","withdrawal_date":"example"}}}}},"404":{"content":{"application/json":{"example":{"error":{"code":"NOT_FOUND","message":"No World Currency Codes record for '...'."}}}},"description":"Not Found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/data/world-language-codes":{"get":{"tags":["Languages"],"summary":"List World Language Codes records","description":"List World Language Codes records with optional filters and pagination.\n\n**Source:** Language code data from the datasets/language-codes project (github.com/datasets), based on ISO 639 lists published by the Library of Congress (ODC-PDDL-1.0).\n\n**Fields returned:**\n- `alpha2` (str) — ISO 639-1 two-letter language code\n- `english` (str) — English name of the language\n\n**Example:** `GET /v1/data/world-language-codes?limit=10`","operationId":"list_endpoint_v1_data_world_language_codes_get","parameters":[{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":100,"minimum":1,"description":"Max records to return (1-100).","default":25,"title":"Limit"},"description":"Max records to return (1-100)."},{"name":"offset","in":"query","required":false,"schema":{"type":"integer","minimum":0,"description":"Records to skip, for pagination.","default":0,"title":"Offset"},"description":"Records to skip, for pagination."},{"name":"X-API-Key","in":"header","required":true,"schema":{"type":"string","title":"X-Api-Key"}}],"responses":{"200":{"description":"A page of World Language Codes records with pagination metadata.","content":{"application/json":{"schema":{},"example":{"data":{"items":[{"alpha2":"example","english":"example"}],"total":1,"limit":25,"offset":0}}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/data/world-language-codes/search":{"get":{"tags":["Languages"],"summary":"Search World Language Codes by english","description":"Search World Language Codes records by `english` (partial, case-insensitive).\n\n**Example:** `GET /v1/data/world-language-codes/search?q=exa`","operationId":"search_endpoint_v1_data_world_language_codes_search_get","parameters":[{"name":"q","in":"query","required":true,"schema":{"type":"string","minLength":2,"maxLength":100,"description":"Case-insensitive partial match on english.","examples":["exa"],"title":"Q"},"description":"Case-insensitive partial match on english."},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":100,"minimum":1,"description":"Max records to return (1-100).","default":25,"title":"Limit"},"description":"Max records to return (1-100)."},{"name":"X-API-Key","in":"header","required":true,"schema":{"type":"string","title":"X-Api-Key"}}],"responses":{"200":{"description":"Matching World Language Codes records.","content":{"application/json":{"schema":{},"example":{"data":{"items":[{"alpha2":"example","english":"example"}]}}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/data/world-language-codes/{key}":{"get":{"tags":["Languages"],"summary":"Get one World Language Codes record by alpha2","description":"Fetch a single World Language Codes record by its `alpha2`.\n\n**Example:** `GET /v1/data/world-language-codes/example`","operationId":"get_endpoint_v1_data_world_language_codes__key__get","parameters":[{"name":"key","in":"path","required":true,"schema":{"type":"string","description":"The alpha2 value to look up (case-insensitive).","examples":["example"],"title":"Key"},"description":"The alpha2 value to look up (case-insensitive)."},{"name":"X-API-Key","in":"header","required":true,"schema":{"type":"string","title":"X-Api-Key"}}],"responses":{"200":{"description":"A single World Language Codes record.","content":{"application/json":{"schema":{},"example":{"data":{"alpha2":"example","english":"example"}}}}},"404":{"content":{"application/json":{"example":{"error":{"code":"NOT_FOUND","message":"No World Language Codes record for '...'."}}}},"description":"Not Found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}}},"components":{"schemas":{"ApiKeyOut":{"properties":{"key_prefix":{"type":"string","title":"Key Prefix"},"name":{"type":"string","title":"Name"},"tier":{"type":"string","title":"Tier"},"daily_limit":{"type":"integer","title":"Daily Limit"},"is_active":{"type":"boolean","title":"Is Active"},"created_at":{"type":"string","format":"date-time","title":"Created At"}},"type":"object","required":["key_prefix","name","tier","daily_limit","is_active","created_at"],"title":"ApiKeyOut"},"ApiResponse_CheckoutResponse_":{"properties":{"data":{"$ref":"#/components/schemas/CheckoutResponse"},"meta":{"$ref":"#/components/schemas/Meta"}},"type":"object","required":["data"],"title":"ApiResponse[CheckoutResponse]"},"ApiResponse_PortalResponse_":{"properties":{"data":{"$ref":"#/components/schemas/PortalResponse"},"meta":{"$ref":"#/components/schemas/Meta"}},"type":"object","required":["data"],"title":"ApiResponse[PortalResponse]"},"ApiResponse_RegisterResponse_":{"properties":{"data":{"$ref":"#/components/schemas/RegisterResponse"},"meta":{"$ref":"#/components/schemas/Meta"}},"type":"object","required":["data"],"title":"ApiResponse[RegisterResponse]"},"ApiResponse_SubscriptionOut_":{"properties":{"data":{"$ref":"#/components/schemas/SubscriptionOut"},"meta":{"$ref":"#/components/schemas/Meta"}},"type":"object","required":["data"],"title":"ApiResponse[SubscriptionOut]"},"ApiResponse_UsageDashboard_":{"properties":{"data":{"$ref":"#/components/schemas/UsageDashboard"},"meta":{"$ref":"#/components/schemas/Meta"}},"type":"object","required":["data"],"title":"ApiResponse[UsageDashboard]"},"ApiResponse_dict_":{"properties":{"data":{"additionalProperties":true,"type":"object","title":"Data"},"meta":{"$ref":"#/components/schemas/Meta"}},"type":"object","required":["data"],"title":"ApiResponse[dict]"},"ApiResponse_list_ApiKeyOut__":{"properties":{"data":{"items":{"$ref":"#/components/schemas/ApiKeyOut"},"type":"array","title":"Data"},"meta":{"$ref":"#/components/schemas/Meta"}},"type":"object","required":["data"],"title":"ApiResponse[list[ApiKeyOut]]"},"ApiResponse_list_InvoiceOut__":{"properties":{"data":{"items":{"$ref":"#/components/schemas/InvoiceOut"},"type":"array","title":"Data"},"meta":{"$ref":"#/components/schemas/Meta"}},"type":"object","required":["data"],"title":"ApiResponse[list[InvoiceOut]]"},"CheckoutResponse":{"properties":{"checkout_url":{"type":"string","title":"Checkout Url"}},"type":"object","required":["checkout_url"],"title":"CheckoutResponse"},"CreateKeyRequest":{"properties":{"name":{"type":"string","title":"Name","default":"Default"}},"type":"object","title":"CreateKeyRequest"},"EndpointUsage":{"properties":{"endpoint":{"type":"string","title":"Endpoint"},"count":{"type":"integer","title":"Count"}},"type":"object","required":["endpoint","count"],"title":"EndpointUsage"},"HTTPValidationError":{"properties":{"detail":{"items":{"$ref":"#/components/schemas/ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"},"InvoiceOut":{"properties":{"id":{"type":"string","title":"Id"},"amount_due":{"type":"integer","title":"Amount Due"},"currency":{"type":"string","title":"Currency"},"status":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Status"},"created":{"type":"string","format":"date-time","title":"Created"},"hosted_invoice_url":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Hosted Invoice Url"},"pdf_url":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Pdf Url"}},"type":"object","required":["id","amount_due","currency","status","created"],"title":"InvoiceOut"},"Meta":{"properties":{"timestamp":{"type":"string","format":"date-time","title":"Timestamp"},"source":{"type":"string","title":"Source","default":"aristocles-api"},"version":{"type":"string","title":"Version","default":"1.0"}},"type":"object","title":"Meta"},"PortalResponse":{"properties":{"portal_url":{"type":"string","title":"Portal Url"}},"type":"object","required":["portal_url"],"title":"PortalResponse"},"RegisterRequest":{"properties":{"email":{"type":"string","format":"email","title":"Email"},"name":{"type":"string","title":"Name"}},"type":"object","required":["email","name"],"title":"RegisterRequest"},"RegisterResponse":{"properties":{"api_key":{"type":"string","title":"Api Key"},"email":{"type":"string","title":"Email"},"tier":{"type":"string","title":"Tier"},"daily_limit":{"type":"integer","title":"Daily Limit"}},"type":"object","required":["api_key","email","tier","daily_limit"],"title":"RegisterResponse"},"SubscriptionOut":{"properties":{"tier":{"type":"string","title":"Tier"},"status":{"type":"string","title":"Status"},"current_period_start":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Current Period Start"},"current_period_end":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Current Period End"},"stripe_subscription_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Stripe Subscription Id"}},"type":"object","required":["tier","status"],"title":"SubscriptionOut"},"UsageDashboard":{"properties":{"tier":{"type":"string","title":"Tier"},"daily_limit":{"type":"integer","title":"Daily Limit"},"requests_today":{"type":"integer","title":"Requests Today"},"remaining":{"type":"integer","title":"Remaining"},"endpoints":{"items":{"$ref":"#/components/schemas/EndpointUsage"},"type":"array","title":"Endpoints"}},"type":"object","required":["tier","daily_limit","requests_today","remaining","endpoints"],"title":"UsageDashboard"},"ValidationError":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array","title":"Location"},"msg":{"type":"string","title":"Message"},"type":{"type":"string","title":"Error Type"},"input":{"title":"Input"},"ctx":{"type":"object","title":"Context"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"}}},"tags":[{"name":"Getting Started","description":"Discovery endpoint — returns all available slugs, example calls, coverage, and your account limits. Start here."},{"name":"Subscription Pricing","description":"Real-time pricing for 50+ SaaS and streaming services across AU, US, UK, CA, NZ. Includes price history, alternatives, and trend data."},{"name":"Contractor / Trade Pricing","description":"Job pricing for plumbers, electricians, painters, and 7 other trades across 5 countries — by state, region, and postcode."},{"name":"PBS Drug Pricing","description":"Australian Pharmaceutical Benefits Scheme pricing for 14,000+ medications. Returns government benefit price, patient copayment (general and concessional), and safety net thresholds. Updated monthly."},{"name":"Rental Prices","description":"Median weekly rent by suburb, postcode, bedroom count, and property type across Australia. Quarterly data back to 2000. Current coverage: VIC (146 suburbs)."},{"name":"RBA Economic Data","description":"Reserve Bank of Australia statistical data — cash rate, AUD exchange rates, CPI inflation, mortgage rates, and credit aggregates. Source: RBA (CC BY 4.0). Updated monthly."},{"name":"Auth","description":"API key registration and management."},{"name":"Billing","description":"Subscription management and usage billing via Stripe."},{"name":"Usage","description":"Query your daily API usage and remaining quota."},{"name":"Health","description":"Service health check."},{"name":"Geospatial","description":"Provides a lookup for all Australian postcodes, mapping them to suburbs, states, and precise latitude/longitude coordinates. This is foundational data for any app with address forms, shipping calculators, or location-based services. Source: Based on data from Matthew Proctor and contributors. Licence: CC BY 4.0. Base path: /v1/data/australian-postcodes-geolocation. Requires an API key (X-API-Key)."},{"name":"Public Holidays","description":"Provides the date, name, and jurisdiction for every public holiday in Australia. Crucial for logistics and delivery scheduling, payroll systems, and retail platforms planning for sales and staffing. Source: Department of the Prime Minister and Cabinet. Licence: CC BY 4.0. Base path: /v1/data/australian-public-holidays. Requires an API key (X-API-Key)."},{"name":"Exoplanets","description":"A catalogue of all confirmed exoplanets with their host star, discovery year and method, orbital period, radius, mass, temperature and distance from Earth. Education platforms, science apps, researchers and AI tutors use it to explore and explain planetary discoveries. Source: This research has made use of the NASA Exoplanet Archive, which is operated by the California Institute of Technology, under contract with NASA.. Licence: Public domain (NASA data, free to use). Base path: /v1/data/confirmed-exoplanets-catalogue. Requires an API key (X-API-Key)."},{"name":"Utilities","description":"Provides a simple, accurate mapping between countries and their international telephone calling codes (e.g., +61 for Australia). This foundational dataset is essential for any application that needs to validate, format, or identify the origin of user-provided phone numbers. Source: DataHub.io, country-codes. Licence: ODbL. Base path: /v1/data/country-calling-codes. Requires an API key (X-API-Key)."},{"name":"Emoji","description":"A reference catalogue of standard emoji characters, each with a plain-English description, category grouping, and the Unicode and iOS versions that introduced it. Used by chat apps, social tools, keyboards, and AI agents that need to interpret, search, or suggest emoji. Source: Emoji data from GitHub gemoji (MIT License). Licence: MIT. Base path: /v1/data/emoji-directory. Requires an API key (X-API-Key)."},{"name":"Transportation","description":"Contains location, type, and identifier data for tens of thousands of airports globally. Essential for travel tech startups, logistics companies, and any AI agent planning travel or analyzing transportation networks. Source: Data provided by OurAirports. Licence: Public Domain. Base path: /v1/data/global-airport-locations. Requires an API key (X-API-Key)."},{"name":"Cities","description":"A reference directory of cities and towns worldwide, each with its country, first-level subdivision (state, province or region) and GeoNames identifier. Developers use it for location autocomplete, address normalisation, and giving AI agents a reliable way to resolve place names to countries. Source: Data from GeoNames (geonames.org) via the datasets/world-cities project, licensed CC BY 4.0. Licence: CC BY 4.0. Base path: /v1/data/global-cities-directory. Requires an API key (X-API-Key)."},{"name":"Geopolitical","description":"A comprehensive dataset containing key information for over 250 countries and territories. Indispensable for startups building international apps, logistics software, or AI agents requiring global context. Source: Data provided by Restcountries. Licence: ISC License. Base path: /v1/data/global-country-information. Requires an API key (X-API-Key)."},{"name":"Currency Exchange Rates","description":"A dated table of official foreign currency exchange rates published by the US Treasury, covering every currency the US government transacts in. Each row gives a country, its currency, the effective date and the rate used to convert that currency into US dollars. Finance, accounting, invoicing and cross-border commerce teams use it as an auditable, government-sourced alternative to commercial FX feeds. Source: Source: U.S. Department of the Treasury, Fiscal Data (fiscaldata.treasury.gov). Licence: Public domain (US Government work, free to use per Fiscal Data licence). Base path: /v1/data/global-currency-exchange-rates. Requires an API key (X-API-Key)."},{"name":"Health & Food","description":"Provides detailed data on macronutrients, micronutrients, vitamins, and minerals for a vast array of food items. It is the definitive source for building nutrition-aware applications. Source: Source: U.S. Department of Agriculture, Agricultural Research Service.. Licence: Public Domain (US Government Work). Base path: /v1/data/global-food-nutrient-database. Requires an API key (X-API-Key)."},{"name":"Gross Domestic Product","description":"Gross domestic product at current US dollar prices for every country and regional aggregate, one row per country per year. The data comes from the World Bank's World Development Indicators, the standard reference series for cross-country economic comparison. Analysts, market-sizing tools and AI research agents use it to rank markets, normalise metrics per unit of economy and build country scoring models. Source: Source: World Bank, World Development Indicators (CC BY 4.0). Licence: CC BY 4.0. Base path: /v1/data/global-gross-domestic-product. Requires an API key (X-API-Key)."},{"name":"Energy & Climate","description":"An open-source dataset from the World Resources Institute listing over 35,000 power plants. It is essential for energy market analysts, renewable energy startups, and logistics companies optimizing for energy resources and carbon footprint. Source: World Resources Institute. 2021. Global Power Plant Database. Published on Resource Watch; http://resourcewatch.org/. Licence: CC BY 4.0. Base path: /v1/data/global-power-plant-database. Requires an API key (X-API-Key)."},{"name":"Sea Level","description":"Annual global mean sea level change compiled by the US Environmental Protection Agency from CSIRO reconstructions and NOAA satellite measurements, with error bounds. Climate-risk, insurance, property and ESG platforms use it for coastal risk context and reporting. Source: US EPA Climate Change Indicators (CSIRO and NOAA data), packaged by the Open Knowledge Foundation datasets project. Licence: ODC-PDDL-1.0. Base path: /v1/data/global-sea-level-rise. Requires an API key (X-API-Key)."},{"name":"Geoscience & Environment","description":"Provides magnitude, location, depth, and impact metadata for major earthquakes worldwide. Critical data for insurance, reinsurance, disaster response organizations, and global supply chain risk management. Source: U.S. Geological Survey. Licence: Public Domain. Base path: /v1/data/global-significant-earthquakes. Requires an API key (X-API-Key)."},{"name":"Reference","description":"Provides a developer-friendly list of global time zones, including abbreviation, UTC offset, and Daylight Saving Time (DST) status. This is a fundamental reference dataset for any application that needs to handle users in multiple geographic locations. Source: Denis Filipenko (https://github.com/dmfilipenko/timezones.json). Licence: MIT. Base path: /v1/data/global-time-zones. Requires an API key (X-API-Key)."},{"name":"Volcanic Eruptions","description":"The long-running record of significant volcanic eruptions maintained by the United States national geophysical data centre, covering events from antiquity to the present. Each row gives the volcano name, date, coordinates, elevation, explosivity index and recorded human and economic impact. Insurers, travel-risk platforms and hazard modellers use it as a baseline for eruption frequency and severity. Source: Source: NOAA National Centers for Environmental Information, Significant Volcanic Eruption Database (public domain).. Licence: Public Domain (U.S. Government Work). Base path: /v1/data/global-volcanic-eruptions. Requires an API key (X-API-Key)."},{"name":"Aviation","description":"Provides a comprehensive directory of the world's airports and airlines, including their standard IATA and ICAO codes. This is foundational data for any travel-tech, logistics, or flight tracking application, enabling mapping of routes and identification of carriers and locations. Source: DataHub, Airport Codes. Licence: ODbL. Base path: /v1/data/international-airline-airport-codes. Requires an API key (X-API-Key)."},{"name":"Cybersecurity","description":"A continuously updated catalogue of software and hardware vulnerabilities with confirmed real-world exploitation, each with its identifier, affected vendor and product, the required remediation action and a federal remediation deadline. It is the de-facto global prioritisation list for patching. Security vendors, managed service providers, compliance platforms and autonomous security agents all consume it. Source: Source: Cybersecurity and Infrastructure Security Agency (CISA), Known Exploited Vulnerabilities Catalog.. Licence: Public Domain (U.S. Government Work). Base path: /v1/data/known-exploited-software-vulnerabilities. Requires an API key (X-API-Key)."},{"name":"Asteroid Approaches","description":"Computed close-approach events for near-Earth objects from NASA's Jet Propulsion Laboratory, covering the coming year within a defined distance threshold. Each row gives the object designation, approach time, nominal and minimum distance, relative velocity and brightness. Space-sector tools, science media and educational products use it to show what is passing by and when. Source: Data courtesy NASA/JPL-Caltech, Center for Near-Earth Object Studies Close-Approach Data API.. Licence: Public Domain (U.S. Government Work). Base path: /v1/data/near-earth-asteroid-approaches. Requires an API key (X-API-Key)."},{"name":"Stock Market Indices","description":"A reference list of every company currently in the S&P 500 index, with ticker symbol, company name, industry sector and sub-industry, headquarters location, date added to the index, SEC CIK number and founding year. Fintech startups, trading bots, portfolio tools and AI research agents use it to screen large-cap US equities and map tickers to sectors. Source: S&P 500 constituents data from the datasets/s-and-p-500-companies project (github.com/datasets). Licence: ODC-PDDL-1.0. Base path: /v1/data/s-p-500-company-constituents. Requires an API key (X-API-Key)."},{"name":"Space Weather","description":"Minute-by-minute estimated planetary geomagnetic activity readings published by the United States space weather forecasting service. Each record is a timestamped disturbance level used to judge the severity of geomagnetic storms. Source: Source: NOAA Space Weather Prediction Center. Licence: Public domain (U.S. Government work). Base path: /v1/data/space-weather-geomagnetic-activity. Requires an API key (X-API-Key)."},{"name":"Market Volatility","description":"Daily history of the CBOE Volatility Index (VIX), which measures expected 30-day volatility of the S&P 500 implied by options prices. Fintech startups, trading bots, risk dashboards and AI finance agents use it to gauge market stress and backtest strategies. Source: VIX data from Cboe Global Markets, packaged by the Open Knowledge Foundation datasets project. Licence: ODC-PDDL-1.0. Base path: /v1/data/stock-market-volatility-index. Requires an API key (X-API-Key)."},{"name":"Product Recalls","description":"A catalogue of consumer product recalls published by the U.S. Consumer Product Safety Commission, covering toys, appliances, furniture, electronics, tools and other household goods. Each record includes the recall number, date, title, hazard description and a link to the official recall notice. Marketplaces, retailers, insurers and supply-chain agents use it to pull unsafe products from listings and warn customers. Source: Source: U.S. Consumer Product Safety Commission (CPSC), SaferProducts.gov Recalls API.. Licence: Public Domain (U.S. Government work, 17 U.S.C. 105). Base path: /v1/data/united-states-consumer-product-recalls. Requires an API key (X-API-Key)."},{"name":"Drug Products","description":"The national directory of finished and unfinished drug products, listing each product's identifying code, brand and generic names, dosage form, labeller and marketing category. It is reference data about products, not about patients or prescriptions. Health-tech products, pharmacy tools and clinical AI agents use it to resolve a drug name to a canonical product record. Source: Source: openFDA, U.S. Food and Drug Administration. Not for clinical use.. Licence: Public domain (CC0, US Government work). Base path: /v1/data/united-states-drug-product-directory. Requires an API key (X-API-Key)."},{"name":"Drug Shortages","description":"Records of drug shortages reported to the US Food and Drug Administration, including the generic drug name, manufacturer, dosage form, presentation, shortage status, availability notes and reason for the shortage. Pharmacies, health-tech startups, supply-chain analysts and clinical AI agents use it to flag unavailable medicines and suggest alternatives. Source: Data from openFDA, U.S. Food and Drug Administration. FDA does not endorse this product.. Licence: CC0 1.0 (US Government public domain). Base path: /v1/data/united-states-drug-shortages. Requires an API key (X-API-Key)."},{"name":"Government Regulations","description":"The Federal Register is the official daily journal of the United States government, containing proposed rules, final rules, presidential documents and public notices from every federal agency. This feed returns the most recent published documents with title, type, abstract, publication date and links to the official HTML and PDF versions. Compliance teams, legal tech products and regulatory-monitoring AI agents use it to detect rule changes the day they are published. Source: Source: Federal Register, Office of the Federal Register, U.S. National Archives and Records Administration.. Licence: Public Domain (U.S. Government work, 17 U.S.C. 105). Base path: /v1/data/united-states-federal-register-documents. Requires an API key (X-API-Key)."},{"name":"Food Recalls","description":"Food recall and enforcement records covering the recalled product, the reason for the recall, the hazard classification, distribution area, and the firm and dates involved. Records are business and product level, not consumer level. Bought by grocery, food-service and supply-chain platforms that must catch an affected product before it reaches a shelf or a menu. Source: Data courtesy of openFDA, U.S. Food and Drug Administration. Not endorsed by the FDA.. Licence: Public domain (U.S. Government work), openFDA terms of service. Base path: /v1/data/united-states-food-recalls. Requires an API key (X-API-Key)."},{"name":"Government Directory","description":"The authoritative register of all registered .gov domain names, published by the US Cybersecurity and Infrastructure Security Agency. Each row gives the domain, whether it belongs to a federal, state, city, county or tribal body, and the owning agency and organisation. It is the ground truth for deciding whether a US government web address is genuine. Source: Source: Cybersecurity and Infrastructure Security Agency (CISA), .gov Program - dotgov-data.. Licence: Public Domain (U.S. Government Work, CC0 1.0). Base path: /v1/data/united-states-government-domain-names. Requires an API key (X-API-Key)."},{"name":"Public Health","description":"Aggregate annual death counts and age-adjusted death rates for the leading causes of death across all 50 states, DC and the nation, from 1999 onward. Health-tech startups, insurers, public-health researchers and AI health assistants use it for benchmarking and context. Source: Source: Centers for Disease Control and Prevention, National Center for Health Statistics. Licence: Public Domain (US Government Work). Base path: /v1/data/united-states-leading-causes-death. Requires an API key (X-API-Key)."},{"name":"Medical Devices","description":"The device identification records behind every medical device distributed in the United States, covering brand name, manufacturer, model and catalogue number, package counts, single-use and sterilisation flags, and imaging safety status. Hospital procurement tools, medical supply marketplaces and clinical AI agents use it to resolve a device label into a clean, structured product record. Source: Source: U.S. Food and Drug Administration, openFDA. Licence: U.S. Public Domain (openFDA). Base path: /v1/data/united-states-medical-device-catalogue. Requires an API key (X-API-Key)."},{"name":"Weather Alerts","description":"Active public weather alerts issued by the U.S. National Weather Service, including tornado, hurricane, flood, winter storm, red flag and extreme heat warnings. Each alert carries the event type, affected area description, severity, urgency, certainty and the time window it applies to. Logistics platforms, insurers, field-service schedulers and operations agents use it to reroute work and warn staff before conditions hit. Source: Source: NOAA / National Weather Service, api.weather.gov.. Licence: Public Domain (U.S. Government work, 17 U.S.C. 105). Base path: /v1/data/united-states-severe-weather-alerts. Requires an API key (X-API-Key)."},{"name":"Vehicle Makes","description":"The official list of vehicle makes (brands) recognised by the US National Highway Traffic Safety Administration's Vehicle Product Information Catalog, each with a stable numeric make ID. It is the reference table behind VIN decoding, recall lookups and vehicle data normalisation. Insurers, auto marketplaces, fleet platforms and car-related AI agents use it to standardise messy brand names. Source: Source: U.S. Department of Transportation, National Highway Traffic Safety Administration (NHTSA), vPIC API. Licence: US Government Work (Public Domain). Base path: /v1/data/united-states-vehicle-makes-directory. Requires an API key (X-API-Key)."},{"name":"Electric Vehicles","description":"A vehicle-level register of all battery electric and plug-in hybrid vehicles currently registered with the Washington State Department of Licensing, including make, model, model year, electric range, county, city and electric utility. EV makers, charging network planners, utilities and market analysts use it to track adoption and plan infrastructure. Source: Washington State Department of Licensing, Electric Vehicle Population Data, via data.wa.gov. Licence: Washington State open data (data.wa.gov terms of use). Base path: /v1/data/washington-state-electric-vehicle-registrations. Requires an API key (X-API-Key)."},{"name":"Currency Codes","description":"The international reference list of currency codes, showing which countries and territories use each currency, its alphabetic and numeric code, the number of minor units (decimal places), and any withdrawal date for retired currencies. Payment, fintech, e-commerce and accounting teams need it to validate, format and convert monetary amounts correctly. Source: Currency code data from the Frictionless Data core datasets (github.com/datasets/currency-codes), derived from the ISO 4217 maintenance agency list.. Licence: ODC PDDL 1.0. Base path: /v1/data/world-currency-codes. Requires an API key (X-API-Key)."},{"name":"Languages","description":"The ISO 639-1 list of two-letter language codes mapped to their English language names. Developers use it for localisation, translation pipelines, content tagging and letting AI agents validate or convert language identifiers. Source: Language code data from the datasets/language-codes project (github.com/datasets), based on ISO 639 lists published by the Library of Congress. Licence: ODC-PDDL-1.0. Base path: /v1/data/world-language-codes. Requires an API key (X-API-Key)."}]}