{"openapi":"3.1.0","info":{"title":"TEOS Transmuter Tollbooth","description":"Metered access to refined corporate-distress intelligence. Each domain is a router under /api/v1/. Access is metered through the RapidAPI marketplace. The corpus is served read-only.","contact":{"name":"TEOS Data"},"license":{"name":"Commercial -- metered API access"},"version":"v1"},"paths":{"/health":{"get":{"tags":["meta"],"summary":"Liveness probe (no auth)","operationId":"health_health_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}}}}},"/api/v1/warn/notices":{"get":{"tags":["warn"],"summary":"Query WARN layoff/closure notices","operationId":"notices_api_v1_warn_notices_get","parameters":[{"name":"state","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"2-letter state filter, e.g. CA","title":"State"},"description":"2-letter state filter, e.g. CA"},{"name":"company","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Case-insensitive substring on company name","title":"Company"},"description":"Case-insensitive substring on company name"},{"name":"start_date","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"effective_date >= YYYY-MM-DD","title":"Start Date"},"description":"effective_date >= YYYY-MM-DD"},{"name":"end_date","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"effective_date <= YYYY-MM-DD","title":"End Date"},"description":"effective_date <= YYYY-MM-DD"},{"name":"location","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Case-insensitive substring on county/location","title":"Location"},"description":"Case-insensitive substring on county/location"},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":1000,"minimum":1,"default":100,"title":"Limit"}},{"name":"offset","in":"query","required":false,"schema":{"type":"integer","minimum":0,"default":0,"title":"Offset"}},{"name":"X-RapidAPI-Proxy-Secret","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Rapidapi-Proxy-Secret"}},{"name":"authorization","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Authorization"}},{"name":"X-API-Key","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Api-Key"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NoticesResponse"}}}},"402":{"description":"Payment required -- no gateway wristband and no valid capability token. Body carries the checkout URL."},"403":{"description":"Key is valid but scoped to a different module"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/warn/stats":{"get":{"tags":["warn"],"summary":"Corpus coverage by state","operationId":"stats_api_v1_warn_stats_get","parameters":[{"name":"X-RapidAPI-Proxy-Secret","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Rapidapi-Proxy-Secret"}},{"name":"authorization","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Authorization"}},{"name":"X-API-Key","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Api-Key"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StatsResponse"}}}},"402":{"description":"Payment required -- no gateway wristband and no valid capability token. Body carries the checkout URL."},"403":{"description":"Key is valid but scoped to a different module"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/toll/claim":{"get":{"tags":["toll"],"summary":"Collect the corpus slice you are entitled to","operationId":"claim_toll_claim_get","parameters":[{"name":"session_id","in":"query","required":true,"schema":{"type":"string","minLength":8,"maxLength":255,"description":"Stripe Checkout Session id (cs_...), or the Subscription id (sub_...) for a subscription created outside Checkout, which has no session","title":"Session Id"},"description":"Stripe Checkout Session id (cs_...), or the Subscription id (sub_...) for a subscription created outside Checkout, which has no session"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/faa/aircraft/{n_number}":{"get":{"tags":["faa"],"summary":"Aircraft registration by tail number","operationId":"aircraft_api_v1_faa_aircraft__n_number__get","parameters":[{"name":"n_number","in":"path","required":true,"schema":{"type":"string","title":"N Number"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AircraftRecord"}}}},"402":{"description":"Dataset not yet provisioned (private beta)"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/faa/aircraft":{"get":{"tags":["faa"],"summary":"Search the aircraft registry","operationId":"search_aircraft_api_v1_faa_aircraft_get","parameters":[{"name":"registrant_name","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Registrant Name"}},{"name":"state","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"2-letter state","title":"State"},"description":"2-letter state"},{"name":"manufacturer","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Manufacturer"}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":1000,"minimum":1,"default":100,"title":"Limit"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/AircraftRecord"},"title":"Response Search Aircraft Api V1 Faa Aircraft Get"}}}},"402":{"description":"Dataset not yet provisioned (private beta)"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/fcc/licenses":{"get":{"tags":["fcc"],"summary":"Search spectrum licences","operationId":"licenses_api_v1_fcc_licenses_get","parameters":[{"name":"callsign","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Callsign"}},{"name":"licensee_name","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Licensee Name"}},{"name":"state","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"2-letter state","title":"State"},"description":"2-letter state"},{"name":"service","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Service"}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":1000,"minimum":1,"default":100,"title":"Limit"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/FccLicense"},"title":"Response Licenses Api V1 Fcc Licenses Get"}}}},"402":{"description":"Dataset not yet provisioned (private beta)"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/fcc/licenses/{callsign}":{"get":{"tags":["fcc"],"summary":"Licence by callsign","operationId":"licence_api_v1_fcc_licenses__callsign__get","parameters":[{"name":"callsign","in":"path","required":true,"schema":{"type":"string","title":"Callsign"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FccLicense"}}}},"402":{"description":"Dataset not yet provisioned (private beta)"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/nppes/providers/{npi}":{"get":{"tags":["nppes"],"summary":"Provider by NPI","operationId":"provider_api_v1_nppes_providers__npi__get","parameters":[{"name":"npi","in":"path","required":true,"schema":{"type":"string","title":"Npi"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NppesProvider"}}}},"402":{"description":"Dataset not yet provisioned (private beta)"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/nppes/providers":{"get":{"tags":["nppes"],"summary":"Search the provider registry","operationId":"search_providers_api_v1_nppes_providers_get","parameters":[{"name":"name","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Name"}},{"name":"state","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"2-letter state","title":"State"},"description":"2-letter state"},{"name":"taxonomy","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Taxonomy"}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":1000,"minimum":1,"default":100,"title":"Limit"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/NppesProvider"},"title":"Response Search Providers Api V1 Nppes Providers Get"}}}},"402":{"description":"Dataset not yet provisioned (private beta)"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/fda/shortages":{"get":{"tags":["fda"],"summary":"Query FDA drug shortages","operationId":"shortages_api_v1_fda_shortages_get","parameters":[{"name":"status","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Current | Resolved","title":"Status"},"description":"Current | Resolved"},{"name":"company","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Substring on manufacturer","title":"Company"},"description":"Substring on manufacturer"},{"name":"generic_name","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Generic Name"}},{"name":"ndc_code","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Exact NDC match","title":"Ndc Code"},"description":"Exact NDC match"},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":1000,"minimum":1,"default":100,"title":"Limit"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Shortage"},"title":"Response Shortages Api V1 Fda Shortages Get"}}}},"402":{"description":"Dataset not yet provisioned (private beta)"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/usda/terminal":{"get":{"tags":["usda"],"summary":"Query terminal market prices","operationId":"terminal_api_v1_usda_terminal_get","parameters":[{"name":"market","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"e.g. Los Angeles","title":"Market"},"description":"e.g. Los Angeles"},{"name":"commodity","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Commodity"}},{"name":"variety","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Variety"}},{"name":"start_date","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"report_date >= YYYY-MM-DD","title":"Start Date"},"description":"report_date >= YYYY-MM-DD"},{"name":"end_date","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"report_date <= YYYY-MM-DD","title":"End Date"},"description":"report_date <= YYYY-MM-DD"},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":1000,"minimum":1,"default":100,"title":"Limit"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Price"},"title":"Response Terminal Api V1 Usda Terminal Get"}}}},"402":{"description":"Dataset not yet provisioned (private beta)"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/cbp/waits":{"get":{"tags":["cbp"],"summary":"Query border wait times","operationId":"waits_api_v1_cbp_waits_get","parameters":[{"name":"port_name","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Substring, e.g. Laredo","title":"Port Name"},"description":"Substring, e.g. Laredo"},{"name":"traffic_type","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"commercial | passenger | pedestrian","title":"Traffic Type"},"description":"commercial | passenger | pedestrian"},{"name":"max_wait","in":"query","required":false,"schema":{"anyOf":[{"type":"integer"},{"type":"null"}],"description":"Only rows with wait_time_minutes <= this","title":"Max Wait"},"description":"Only rows with wait_time_minutes <= this"},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":1000,"minimum":1,"default":100,"title":"Limit"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Wait"},"title":"Response Waits Api V1 Cbp Waits Get"}}}},"402":{"description":"Dataset not yet provisioned (private beta)"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}}},"components":{"schemas":{"AircraftRecord":{"properties":{"n_number":{"type":"string","title":"N Number","description":"US tail number, e.g. N628TS"},"serial_number":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Serial Number"},"manufacturer":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Manufacturer"},"model":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Model"},"year_manufactured":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Year Manufactured"},"registrant_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Registrant Name"},"registrant_state":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Registrant State","description":"2-letter state"},"airworthiness_date":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Airworthiness Date","description":"YYYY-MM-DD"},"status":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Status"}},"type":"object","required":["n_number"],"title":"AircraftRecord","description":"FAA Civil Aviation Registry, normalized."},"FccLicense":{"properties":{"callsign":{"type":"string","title":"Callsign"},"licensee_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Licensee Name"},"service":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Service","description":"Radio service code"},"status":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Status"},"grant_date":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Grant Date","description":"YYYY-MM-DD"},"expiration_date":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Expiration Date","description":"YYYY-MM-DD"},"state":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"State"}},"type":"object","required":["callsign"],"title":"FccLicense","description":"FCC Universal Licensing System, normalized."},"HTTPValidationError":{"properties":{"detail":{"items":{"$ref":"#/components/schemas/ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"},"Notice":{"properties":{"state":{"type":"string","title":"State","description":"USPS 2-letter state code","examples":["CA"]},"company_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Company Name","examples":["Republic National Distributing"]},"employees_impacted":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Employees Impacted","examples":[104]},"effective_date":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Effective Date","description":"ISO date the layoff/closure takes effect","examples":["2025-09-02"]},"notice_date":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Notice Date","description":"ISO date the WARN notice was filed (lead-time signal)","examples":["2025-07-01"]},"location":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Location","description":"County-level location","examples":["Alameda County"]},"layoff_type":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Layoff Type","examples":["Closure Permanent"]},"raw_source_file":{"type":"string","title":"Raw Source File","description":"Stable provenance key for the source artifact"}},"type":"object","required":["state","raw_source_file"],"title":"Notice"},"NoticesResponse":{"properties":{"count":{"type":"integer","title":"Count"},"query":{"additionalProperties":true,"type":"object","title":"Query"},"notices":{"items":{"$ref":"#/components/schemas/Notice"},"type":"array","title":"Notices"}},"type":"object","required":["count","query","notices"],"title":"NoticesResponse"},"NppesProvider":{"properties":{"npi":{"type":"string","title":"Npi","description":"10-digit National Provider Identifier"},"entity_type":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Entity Type","description":"individual | organization"},"name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Name"},"primary_taxonomy":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Primary Taxonomy"},"city":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"City"},"state":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"State"},"enumeration_date":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Enumeration Date","description":"YYYY-MM-DD"},"status":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Status"}},"type":"object","required":["npi"],"title":"NppesProvider","description":"NPPES NPI Registry, normalized."},"Price":{"properties":{"report_date":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Report Date","description":"USDA report date, ISO"},"market":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Market"},"commodity":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Commodity"},"variety":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Variety"},"package_type":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Package Type"},"price_low":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Price Low","description":"Low of the band, USD"},"price_high":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Price High","description":"High of the band, USD"}},"type":"object","title":"Price","description":"USDA terminal market prices -- shape as advertised on the storefront."},"Shortage":{"properties":{"ndc_code":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Ndc Code","description":"National Drug Code"},"generic_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Generic Name"},"company":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Company"},"status":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Status","description":"Current | Resolved"},"reason":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Reason"},"recovery_date":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Recovery Date","description":"Estimated recovery, ISO date"}},"type":"object","title":"Shortage","description":"FDA drug shortages -- shape as advertised on the storefront."},"StateCoverage":{"properties":{"state":{"type":"string","title":"State"},"notices":{"type":"integer","title":"Notices"},"latest_effective_date":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Latest Effective Date"}},"type":"object","required":["state","notices"],"title":"StateCoverage"},"StatsResponse":{"properties":{"total":{"type":"integer","title":"Total"},"states":{"items":{"$ref":"#/components/schemas/StateCoverage"},"type":"array","title":"States"}},"type":"object","required":["total","states"],"title":"StatsResponse"},"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"},"Wait":{"properties":{"measured_at":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Measured At","description":"Observation ts, ISO 8601 UTC"},"port_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Port Name"},"traffic_type":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Traffic Type","description":"commercial | passenger | pedestrian"},"wait_time_minutes":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Wait Time Minutes"},"open_lanes":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Open Lanes"}},"type":"object","title":"Wait","description":"CBP border wait times -- shape as advertised on the storefront."}}}}