{"openapi":"3.1.0","info":{"title":"UKDataAPI","version":"3.0.0","description":"UK government data intelligence platform. 22 enriched endpoints with proprietary scoring from 400+ official UK sources.","contact":{"email":"jackmmaher@gmail.com"}},"servers":[{"url":"https://www.ukdatapi.com/api/v1"}],"security":[{"bearerAuth":[]}],"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer","description":"API key starting with ukd_live_"}}},"paths":{"/entity/{identifier}":{"get":{"operationId":"getEntity","summary":"Company intelligence with Corporate Distress Score","description":"Look up a UK company by number or name. Returns profile, officers, PSCs, filings, charges, regulatory status, and proprietary Distress Score (0-100).","parameters":[{"name":"identifier","in":"path","required":true,"schema":{"type":"string"},"description":"Company number (e.g., 00000006) or company name"},{"name":"depth","in":"query","schema":{"type":"string","enum":["summary","standard","full"],"default":"standard"},"description":"Level of detail. Credits: summary=2, standard=8, full=16"},{"name":"include","in":"query","schema":{"type":"string"},"description":"Comma-separated sections to include"}],"responses":{"200":{"description":"Entity data with distress score"},"401":{"description":"Invalid API key"},"402":{"description":"Insufficient credits"}}}},"/location/{postcode}":{"get":{"operationId":"getLocation","summary":"Area profiling — demographics, crime, flood, services","description":"Profile any UK postcode. Returns admin hierarchy, crime stats, flood risk, food hygiene, labour market, health indicators.","parameters":[{"name":"postcode","in":"path","required":true,"schema":{"type":"string"},"description":"Full UK postcode (e.g., SW1A 1AA)"},{"name":"depth","in":"query","schema":{"type":"string","enum":["summary","standard","full"],"default":"standard"},"description":"Credits: summary=2, standard=10, full=20"},{"name":"radius_m","in":"query","schema":{"type":"integer","default":1000},"description":"Search radius in meters"}],"responses":{"200":{"description":"Location profile data"}}}},"/property/{postcode}":{"get":{"operationId":"getProperty","summary":"Property due diligence — prices, EPC, planning, risk","description":"Property intelligence: price history, EPC energy profile, planning constraints, Environmental Risk Score.","parameters":[{"name":"postcode","in":"path","required":true,"schema":{"type":"string"}},{"name":"depth","in":"query","schema":{"type":"string","enum":["summary","standard","full"],"default":"standard"},"description":"Credits: summary=5, standard=15, full=30"}],"responses":{"200":{"description":"Property intelligence data"}}}},"/report/entity/{identifier}":{"get":{"operationId":"getDueDiligenceReport","summary":"Synthesized due diligence verdict","description":"Opinionated company assessment: PROCEED / PROCEED_WITH_CAUTION / ENHANCED_DUE_DILIGENCE / DO_NOT_ENGAGE. Includes red/green flags. 25 credits.","parameters":[{"name":"identifier","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Due diligence report"}}}},"/environment/{postcode}":{"get":{"operationId":"getEnvironment","summary":"Environmental Risk Score (0-100)","description":"Multi-factor environmental risk: flood, geology, radon, water quality, air quality.","parameters":[{"name":"postcode","in":"path","required":true,"schema":{"type":"string"}},{"name":"depth","in":"query","schema":{"type":"string","enum":["summary","standard","full"],"default":"standard"},"description":"Credits: summary=4, standard=12, full=24"}],"responses":{"200":{"description":"Environmental risk data"}}}},"/planning/{postcode}":{"get":{"operationId":"getPlanning","summary":"Planning intelligence with Development Score (0-100)","description":"Planning applications with status breakdown, constraints (conservation area names, Article 4 direction names), flood risk, listed buildings, Green Belt, brownfield, council performance with portal URL, environmental designations, and proprietary Planning Development Score.","parameters":[{"name":"postcode","in":"path","required":true,"schema":{"type":"string"},"description":"Full UK postcode (e.g., SW1A 1AA)"},{"name":"depth","in":"query","schema":{"type":"string","enum":["summary","standard","full"],"default":"standard"},"description":"Credits: summary=4, standard=12, full=24"}],"responses":{"200":{"description":"Planning intelligence data with development score"},"401":{"description":"Invalid API key"},"402":{"description":"Insufficient credits"}}}},"/market/{postcode}":{"get":{"operationId":"getMarket","summary":"Market sizing with opportunity score","description":"Market opportunity analysis: labour market, property context, competitor density, TAM estimate.","parameters":[{"name":"postcode","in":"path","required":true,"schema":{"type":"string"}},{"name":"sector","in":"query","schema":{"type":"string"},"description":"Business sector for competitor search"},{"name":"depth","in":"query","schema":{"type":"string","enum":["summary","standard","full"],"default":"standard"},"description":"Credits: summary=5, standard=15, full=30"}],"responses":{"200":{"description":"Market sizing data"}}}},"/trade/{commodity}":{"get":{"operationId":"getTrade","summary":"UK import duty rates with Tariff Impact Score (0-100)","description":"Commodity duty rates, preferential rates, quotas from HMRC Trade Tariff, and proprietary Tariff Impact Score (0-100, rated FAVOURABLE to PROHIBITIVE). 10 credits.","parameters":[{"name":"commodity","in":"path","required":true,"schema":{"type":"string"},"description":"Commodity code or product description"}],"responses":{"200":{"description":"Trade tariff data"}}}},"/education/{postcode}":{"get":{"operationId":"getEducation","summary":"Schools with Ofsted ratings","description":"Schools near a postcode with Ofsted ratings, type, phase, pupil counts.","parameters":[{"name":"postcode","in":"path","required":true,"schema":{"type":"string"}},{"name":"depth","in":"query","schema":{"type":"string","enum":["summary","standard","full"],"default":"standard"},"description":"Credits: summary=3, standard=8, full=16"},{"name":"phase","in":"query","schema":{"type":"string"},"description":"Filter: primary, secondary"}],"responses":{"200":{"description":"Education data"}}}},"/transport/{postcode}":{"get":{"operationId":"getTransport","summary":"Transport connectivity scoring","description":"Nearest stations, bus stops, connectivity score.","parameters":[{"name":"postcode","in":"path","required":true,"schema":{"type":"string"}},{"name":"depth","in":"query","schema":{"type":"string","enum":["summary","standard","full"],"default":"standard"},"description":"Credits: summary=3, standard=8, full=16"}],"responses":{"200":{"description":"Transport data"}}}},"/vehicle/{registration}":{"get":{"operationId":"getVehicle","summary":"MOT history with Vehicle Health Assessment (0-100)","description":"Full MOT test history, mileage trend, advisories, failures, structured Vehicle Health Assessment (0-100, rated EXCELLENT/GOOD/FAIR/POOR/CRITICAL), and mileage anomaly detection with severity grading (none/minor/major). 6 credits.","parameters":[{"name":"registration","in":"path","required":true,"schema":{"type":"string"},"description":"Vehicle registration (e.g., AB12CDE)"}],"responses":{"200":{"description":"Vehicle MOT data"}}}},"/health/{postcode}":{"get":{"operationId":"getHealth","summary":"Healthcare landscape with Health Service Quality Score (0-100)","description":"Health indicators, CQC care provider ratings, GP prescribing patterns, and Health Service Quality Score (0-100, rated EXCELLENT/GOOD/MODERATE/POOR/INADEQUATE).","parameters":[{"name":"postcode","in":"path","required":true,"schema":{"type":"string"}},{"name":"depth","in":"query","schema":{"type":"string","enum":["summary","standard","full"],"default":"standard"},"description":"Credits: summary=4, standard=12, full=24"}],"responses":{"200":{"description":"Health data"}}}},"/energy/{postcode}":{"get":{"operationId":"getEnergy","summary":"Energy & ESG Score (0-100)","description":"Grid carbon intensity, generation mix, local EPC efficiency, and expanded ESG Assessment Score (0-100, rated STRONG/GOOD/MODERATE/WEAK/POOR) with component breakdown.","parameters":[{"name":"postcode","in":"path","required":true,"schema":{"type":"string"}},{"name":"depth","in":"query","schema":{"type":"string","enum":["summary","standard","full"],"default":"standard"},"description":"Credits: summary=4, standard=12, full=24"}],"responses":{"200":{"description":"Energy and ESG data"}}}},"/legal/{query}":{"get":{"operationId":"getLegal","summary":"UK legislation with Regulatory Relevance Score (0-100)","description":"Search UK legislation and current Parliamentary bills, with Regulatory Relevance Score (0-100, rated HIGHLY_REGULATED/REGULATED/MODERATE/LIGHTLY_REGULATED/MINIMAL). 10 credits.","parameters":[{"name":"query","in":"path","required":true,"schema":{"type":"string"},"description":"Search term (e.g., data protection)"}],"responses":{"200":{"description":"Legal data"}}}},"/tenders":{"get":{"operationId":"getTenders","summary":"Government procurement with Procurement Opportunity Score (0-100)","description":"Open tenders, awarded contracts, buyer profiles, and Procurement Opportunity Score (0-100, rated EXCELLENT/STRONG/MODERATE/LIMITED/POOR). 10 credits.","parameters":[{"name":"sector","in":"query","schema":{"type":"string"},"description":"Business sector keyword"},{"name":"region","in":"query","schema":{"type":"string"},"description":"Geographic region"}],"responses":{"200":{"description":"Tender data"}}}},"/demographics/{postcode}":{"get":{"operationId":"getDemographics","summary":"Census & deprivation with Spending Power Index","description":"Census 2021 population, tenure, economic activity, IMD deprivation, Consumer Spending Power Index (0-100).","parameters":[{"name":"postcode","in":"path","required":true,"schema":{"type":"string"},"description":"Full UK postcode (e.g., SW1A 1AA)"},{"name":"depth","in":"query","schema":{"type":"string","enum":["summary","standard","full"],"default":"standard"},"description":"Credits: summary=4, standard=12, full=24"}],"responses":{"200":{"description":"Demographics data with spending power score"},"401":{"description":"Invalid API key"},"402":{"description":"Insufficient credits"}}}},"/innovation/{identifier}":{"get":{"operationId":"getInnovation","summary":"IP & Innovation Score (0-100)","description":"Patent portfolio, UKRI research grants, R&D indicators, Innovation Score.","parameters":[{"name":"identifier","in":"path","required":true,"schema":{"type":"string"},"description":"Company number or name"},{"name":"depth","in":"query","schema":{"type":"string","enum":["summary","standard","full"],"default":"standard"},"description":"Credits: summary=4, standard=12, full=24"}],"responses":{"200":{"description":"Innovation intelligence data"},"401":{"description":"Invalid API key"},"402":{"description":"Insufficient credits"}}}},"/funding/{query}":{"get":{"operationId":"getFunding","summary":"Grant & funding matching with opportunity score","description":"Matching grants, UKRI research projects, government contracts, Funding Opportunity Score (0-100).","parameters":[{"name":"query","in":"path","required":true,"schema":{"type":"string"},"description":"Search query (e.g., clean energy, AI)"},{"name":"depth","in":"query","schema":{"type":"string","enum":["summary","standard","full"],"default":"standard"},"description":"Credits: summary=4, standard=10, full=20"}],"responses":{"200":{"description":"Funding opportunity data"},"401":{"description":"Invalid API key"},"402":{"description":"Insufficient credits"}}}},"/director/{name_or_id}":{"get":{"operationId":"getDirector","summary":"Director network intelligence with risk score","description":"Director search, company portfolio, disqualification check, Gazette notices, Director Risk Score (0-100).","parameters":[{"name":"name_or_id","in":"path","required":true,"schema":{"type":"string"},"description":"Director name or Companies House officer ID"},{"name":"depth","in":"query","schema":{"type":"string","enum":["summary","standard","full"],"default":"standard"},"description":"Credits: summary=5, standard=15, full=30"}],"responses":{"200":{"description":"Director intelligence data with risk score"},"401":{"description":"Invalid API key"},"402":{"description":"Insufficient credits"}}}},"/political/{postcode}":{"get":{"operationId":"getPolitical","summary":"Constituency & political profile","description":"Current MP, party, petitions with local signatures, Political Engagement Index.","parameters":[{"name":"postcode","in":"path","required":true,"schema":{"type":"string"},"description":"Full UK postcode (e.g., SW1A 1AA)"},{"name":"depth","in":"query","schema":{"type":"string","enum":["summary","standard","full"],"default":"standard"},"description":"Credits: summary=3, standard=8, full=16"}],"responses":{"200":{"description":"Political profile data"},"401":{"description":"Invalid API key"},"402":{"description":"Insufficient credits"}}}},"/connectivity/{postcode}":{"get":{"operationId":"getConnectivity","summary":"Digital Readiness Score (0-100)","description":"Broadband speeds, FTTP/FTTC availability, mobile 4G coverage by operator, and Digital Readiness Score.","parameters":[{"name":"postcode","in":"path","required":true,"schema":{"type":"string"},"description":"Full UK postcode (e.g., SW1A 1AA)"},{"name":"depth","in":"query","schema":{"type":"string","enum":["summary","standard","full"],"default":"standard"},"description":"Credits: summary=4, standard=10, full=20"}],"responses":{"200":{"description":"Connectivity data with digital readiness score"},"401":{"description":"Invalid API key"},"402":{"description":"Insufficient credits"}}}},"/water/{postcode}":{"get":{"operationId":"getWater","summary":"Water Quality Score (0-100)","description":"Storm overflows, bathing water, ecological status, Ofwat company performance, and Water Quality Score.","parameters":[{"name":"postcode","in":"path","required":true,"schema":{"type":"string"},"description":"Full UK postcode (e.g., SW1A 1AA)"},{"name":"depth","in":"query","schema":{"type":"string","enum":["summary","standard","full"],"default":"standard"},"description":"Credits: summary=4, standard=12, full=24"}],"responses":{"200":{"description":"Water quality data with score"},"401":{"description":"Invalid API key"},"402":{"description":"Insufficient credits"}}}}}}