{"openapi":"3.1.0","info":{"title":"Bradshaw API","description":"\nRead-only access to the Bradshaw funding database: UK private-company share allotments read from Companies House SH01\nfilings, with the arithmetic behind every number and a link to the filing page.\n\n**Authentication.** Send the key as `Authorization: Bearer bk_live_...` (or an `X-API-Key` header). Create and revoke keys\nunder Account, API keys. A key is shown once and only its hash is stored.\n\n**Conventions.** Responses are `{\"api_version\": \"1\", \"data\": ..., \"meta\": {\"data_to\", \"build_id\"}}`. Money is a JSON number in\nthe `currency` beside it (GBP unless stated). Dates are ISO 8601. A value that is not in the database is `null`; nothing is\nguessed or corrected, figures are as filed. Every round carries `filing_url` and `working`. Lists take the same filters as the\napp, are paged with `page` and `per` (up to 100), and return `meta.total` and `next` / `prev` links. A filter the API does not\nrecognise is a 400, never ignored.\n\n**Also available as MCP.** The same reads are offered to AI assistants as tools at `/mcp` (streamable HTTP, same key, same\nquota, one tool call counts as one API call).\n\n**Limits.** Each key may make 10 requests a second (bursts of 20); beyond that the API answers 429 `rate_limited` with\n`Retry-After: 60`. Each organisation has a monthly allowance of calls from its plan; a successful call counts once, an error\nnever does. When the allowance is used the API answers 429 `quota_exceeded` with `Retry-After` set to the seconds until the\nUTC month resets; with no plan it answers 402. Every response carries `X-RateLimit-Limit` (bucket size),\n`X-RateLimit-Remaining`, `X-Quota-Limit` and `X-Quota-Remaining`.\n\n**Errors** are `{\"error\": {\"code\": \"...\", \"message\": \"...\"}}`: 400 invalid_parameter, 401 missing_key / invalid_key /\nrevoked_key, 402 no_plan / api_not_included / trial_ended, 404 not_found, 429 rate_limited / quota_exceeded,\n503 data_unavailable.\n","version":"1"},"paths":{"/":{"get":{"summary":"API index","description":"Unauthenticated status index for monitors and discovery. Returns the API name, version, docs URL and status.","operationId":"api_index__get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}}}}},"/companies/{number}":{"get":{"summary":"One company","description":"Company facts, every priced round we can read (small ones too, the Company X-ray rule) with its working and filing link, the latest financials, corporate holders (no individuals) and website fields.","operationId":"get_company_companies__number__get","security":[{"HTTPBearer":[]},{"APIKeyHeader":[]}],"parameters":[{"name":"number","in":"path","required":true,"schema":{"type":"string","title":"Number"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CompanyResponse"}}}},"400":{"description":"A parameter the vocabulary does not accept (code invalid_parameter).","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, unknown or revoked key (missing_key, invalid_key, revoked_key).","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"402":{"description":"No plan or no API calls on the plan (no_plan, api_not_included, trial_ended).","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No company with that number.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"429":{"description":"Per-key rate limit (rate_limited, Retry-After 60) or monthly quota used (quota_exceeded, Retry-After until the UTC month resets).","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/companies":{"get":{"summary":"Search and filter companies","description":"Companies matching the shared filter vocabulary, most priced rounds first. Paged with `page` and `per` (25, 50 or 100); `meta.next` / `meta.prev` are relative URLs.","operationId":"list_companies_companies_get","security":[{"HTTPBearer":[]},{"APIKeyHeader":[]}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CompaniesResponse"}}}},"400":{"description":"A parameter the vocabulary does not accept (code invalid_parameter).","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, unknown or revoked key (missing_key, invalid_key, revoked_key).","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"402":{"description":"No plan or no API calls on the plan (no_plan, api_not_included, trial_ended).","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"Unknown company number, investor key or path (not_found).","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"429":{"description":"Per-key rate limit (rate_limited, Retry-After 60) or monthly quota used (quota_exceeded, Retry-After until the UTC month resets).","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"parameters":[{"name":"q","in":"query","required":false,"description":"Company name, trading name or number.","schema":{"type":"string"}},{"name":"status","in":"query","required":false,"description":"active, dissolved, liquidation, administration, receivership, voluntary-arrangement.","schema":{"type":"string"},"example":"active"},{"name":"sector","in":"query","required":false,"description":"Sector slug(s).","schema":{"type":"string"},"example":"deep-tech-and-hardware"},{"name":"region","in":"query","required":false,"description":"Region slug(s).","schema":{"type":"string"},"example":"scotland"},{"name":"ceremonial_county","in":"query","required":false,"description":"Ceremonial county slug(s) from the geography seed.","schema":{"type":"string"},"example":"greater-manchester"},{"name":"constituency","in":"query","required":false,"description":"Parliamentary constituency slug(s).","schema":{"type":"string"},"example":"manchester-central"},{"name":"local_authority","in":"query","required":false,"description":"Local authority slug(s).","schema":{"type":"string"},"example":"manchester"},{"name":"postcode","in":"query","required":false,"description":"Postcode or outward-code prefix (spaces ignored).","schema":{"type":"string"},"example":"m1"},{"name":"inc","in":"query","required":false,"description":"Incorporated window: 12m or from..to.","schema":{"type":"string"},"example":"2020-01-01.."},{"name":"rounds","in":"query","required":false,"description":"Number of priced rounds as a range.","schema":{"type":"string"},"example":"2.."},{"name":"last","in":"query","required":false,"description":"Window of the last round.","schema":{"type":"string"},"example":"12m"},{"name":"raised","in":"query","required":false,"description":"Total raised in pounds as a range.","schema":{"type":"string"},"example":"1m.."},{"name":"net_assets","in":"query","required":false,"description":"Net assets in pounds as a range.","schema":{"type":"string"}},{"name":"employees","in":"query","required":false,"description":"Average employees as a range.","schema":{"type":"string"}},{"name":"accounts_size","in":"query","required":false,"description":"large (full or group accounts), medium or small (small and micro), comma separated.","schema":{"type":"string"},"example":"large,medium"},{"name":"turnover_band","in":"query","required":false,"description":"Turnover band of the latest filed accounts, pounds only: under-1m, 1m-10m, 10m-50m, 50m-250m, over-250m (comma separated, any of).","schema":{"type":"string"},"example":"50m-250m,over-250m"},{"name":"employees_band","in":"query","required":false,"description":"Average employees band of the latest filed accounts: 1-9, 10-49, 50-249, 250-999, 1000-plus (comma separated, any of).","schema":{"type":"string"},"example":"250-999,1000-plus"},{"name":"grant","in":"query","required":false,"description":"yes or no: holds public grants.","schema":{"type":"string"}},{"name":"corp_investor","in":"query","required":false,"description":"yes or no: has a corporate shareholder on the PSC register.","schema":{"type":"string"}},{"name":"company_class","in":"query","required":false,"description":"public, vehicle, subsidiary or independent (comma separated). Default: all classes.","schema":{"type":"string"},"example":"independent"},{"name":"sort","in":"query","required":false,"description":"rounds (default, most first), name, inc, last or raised; a leading - sorts descending.","schema":{"type":"string"},"example":"-raised"},{"name":"page","in":"query","required":false,"description":"Page number, from 1.","schema":{"type":"string"},"example":"1"},{"name":"per","in":"query","required":false,"description":"Rows per page: 25 (default), 50 or 100.","schema":{"type":"string"},"example":"50"}]}},"/rounds":{"get":{"summary":"Quality rounds","description":"Priced GBP rounds with confidence 0.5 or more and at least 100,000 raised, newest filed first. Unlike the Rounds page, no default window is applied: add `filed=90d` for one. Paged with `page` and `per` (25, 50 or 100).","operationId":"list_rounds_rounds_get","security":[{"HTTPBearer":[]},{"APIKeyHeader":[]}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RoundsResponse"}}}},"400":{"description":"A parameter the vocabulary does not accept (code invalid_parameter).","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, unknown or revoked key (missing_key, invalid_key, revoked_key).","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"402":{"description":"No plan or no API calls on the plan (no_plan, api_not_included, trial_ended).","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"Unknown company number, investor key or path (not_found).","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"429":{"description":"Per-key rate limit (rate_limited, Retry-After 60) or monthly quota used (quota_exceeded, Retry-After until the UTC month resets).","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"parameters":[{"name":"filed","in":"query","required":false,"description":"Window the first filing was filed in: 7d, 30d, 90d, 12m, ytd or from..to (ISO dates, either end optional).","schema":{"type":"string"},"example":"90d"},{"name":"allotted","in":"query","required":false,"description":"Window the shares were allotted in; same forms as filed.","schema":{"type":"string"},"example":"2026-01-01.."},{"name":"sector","in":"query","required":false,"description":"Sector slug(s), comma separated or repeated: software-and-it, life-sciences-and-health, ...","schema":{"type":"string"},"example":"software-and-it"},{"name":"region","in":"query","required":false,"description":"Region slug(s): london, south-east, scotland, ...","schema":{"type":"string"},"example":"london,scotland"},{"name":"cash","in":"query","required":false,"description":"Cash raised in pounds as lo..hi, either end optional, suffixes k, m, bn.","schema":{"type":"string"},"example":"100k.."},{"name":"post","in":"query","required":false,"description":"Post-money in pounds, same form as cash. Filters on post_money_ex_deferred (deferred shares left out), so a round with valuation_verdict never has no value and never matches.","schema":{"type":"string"},"example":"5m..25m"},{"name":"stepup","in":"query","required":false,"description":"up, flat, down (comma separated), or a price multiple range such as 1.5..","schema":{"type":"string"},"example":"up"},{"name":"conf","in":"query","required":false,"description":"Confidence range between 0 and 1.","schema":{"type":"string"},"example":"0.6.."},{"name":"announced","in":"query","required":false,"description":"yes: only rounds matched to a press announcement; no: only those not.","schema":{"type":"string"},"example":"yes"},{"name":"press_link","in":"query","required":false,"description":"found: rounds with a matched press article; none: rounds we searched and found no press for (rounds not yet checked are in neither). Only while the press links feature is on.","schema":{"type":"string"},"example":"none"},{"name":"company","in":"query","required":false,"description":"One company number.","schema":{"type":"string"},"example":"12203483"},{"name":"company_class","in":"query","required":false,"description":"public, vehicle, subsidiary or independent (comma separated). Default: all classes.","schema":{"type":"string"},"example":"independent"},{"name":"q","in":"query","required":false,"description":"Text inside the company name.","schema":{"type":"string"}},{"name":"sort","in":"query","required":false,"description":"filed (default, newest first), allotted, cash, price, stepup, post (post_money_ex_deferred) or conf; a leading - sorts descending.","schema":{"type":"string"},"example":"-cash"},{"name":"page","in":"query","required":false,"description":"Page number, from 1.","schema":{"type":"string"},"example":"1"},{"name":"per","in":"query","required":false,"description":"Rows per page: 25 (default), 50 or 100.","schema":{"type":"string"},"example":"50"}]}},"/financials/{number}":{"get":{"summary":"Balance-sheet history","description":"Every period of filed accounts we hold for the company, as filed, with the extraction flags.","operationId":"get_financials_financials__number__get","security":[{"HTTPBearer":[]},{"APIKeyHeader":[]}],"parameters":[{"name":"number","in":"path","required":true,"schema":{"type":"string","title":"Number"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FinancialsResponse"}}}},"400":{"description":"A parameter the vocabulary does not accept (code invalid_parameter).","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, unknown or revoked key (missing_key, invalid_key, revoked_key).","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"402":{"description":"No plan or no API calls on the plan (no_plan, api_not_included, trial_ended).","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No company with that number.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"429":{"description":"Per-key rate limit (rate_limited, Retry-After 60) or monthly quota used (quota_exceeded, Retry-After until the UTC month resets).","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/investors":{"get":{"summary":"Corporate holders","description":"Corporate PSC families. Default `holds=raised` keeps only investors with a quality-round company. Paged with `page` and `per` (25, 50 or 100).","operationId":"list_investors_investors_get","security":[{"HTTPBearer":[]},{"APIKeyHeader":[]}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InvestorsResponse"}}}},"400":{"description":"A parameter the vocabulary does not accept (code invalid_parameter).","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, unknown or revoked key (missing_key, invalid_key, revoked_key).","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"402":{"description":"No plan or no API calls on the plan (no_plan, api_not_included, trial_ended).","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"Unknown company number, investor key or path (not_found).","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"429":{"description":"Per-key rate limit (rate_limited, Retry-After 60) or monthly quota used (quota_exceeded, Retry-After until the UTC month resets).","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"parameters":[{"name":"q","in":"query","required":false,"description":"Investor name.","schema":{"type":"string"}},{"name":"holds","in":"query","required":false,"description":"raised (default): only investors with a company that has a quality round; any: all corporate holders.","schema":{"type":"string"}},{"name":"type","in":"query","required":false,"description":"fund, parent, nominee or other (comma separated).","schema":{"type":"string"},"example":"fund"},{"name":"sectors","in":"query","required":false,"description":"Sector slug(s) held.","schema":{"type":"string"},"example":"software-and-it"},{"name":"regions","in":"query","required":false,"description":"Region slug(s) held.","schema":{"type":"string"},"example":"london"},{"name":"status","in":"query","required":false,"description":"active, ceased or any.","schema":{"type":"string"}},{"name":"held","in":"query","required":false,"description":"Companies held as a range.","schema":{"type":"string"},"example":"5.."},{"name":"raised_2024","in":"query","required":false,"description":"Companies with a round since 2024 as a range.","schema":{"type":"string"}},{"name":"sort","in":"query","required":false,"description":"raised_2024 (default), held, with_round or name; a leading - sorts descending.","schema":{"type":"string"},"example":"-held"},{"name":"page","in":"query","required":false,"description":"Page number, from 1.","schema":{"type":"string"},"example":"1"},{"name":"per","in":"query","required":false,"description":"Rows per page: 25 (default), 50 or 100.","schema":{"type":"string"},"example":"50"}]}},"/investors/{key}":{"get":{"summary":"One investor and its portfolio","description":"The investor family and the companies it holds (page and per page through the portfolio), each with a summary of its quality rounds. `key` is the `key` from the list, URL encoded.","operationId":"get_investor_investors__key__get","security":[{"HTTPBearer":[]},{"APIKeyHeader":[]}],"parameters":[{"name":"key","in":"path","required":true,"schema":{"type":"string","title":"Key"}},{"name":"page","in":"query","required":false,"description":"Page number, from 1.","schema":{"type":"string"},"example":"1"},{"name":"per","in":"query","required":false,"description":"Rows per page: 25 (default), 50 or 100.","schema":{"type":"string"},"example":"50"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InvestorResponse"}}}},"400":{"description":"A parameter the vocabulary does not accept (code invalid_parameter).","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, unknown or revoked key (missing_key, invalid_key, revoked_key).","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"402":{"description":"No plan or no API calls on the plan (no_plan, api_not_included, trial_ended).","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No investor with that key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"429":{"description":"Per-key rate limit (rate_limited, Retry-After 60) or monthly quota used (quota_exceeded, Retry-After until the UTC month resets).","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/signals":{"get":{"summary":"Signals","description":"Signals detected from filings, newest first. Paged with `page` and `per` (25, 50 or 100).","operationId":"list_signals_signals_get","security":[{"HTTPBearer":[]},{"APIKeyHeader":[]}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SignalsResponse"}}}},"400":{"description":"A parameter the vocabulary does not accept (code invalid_parameter).","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, unknown or revoked key (missing_key, invalid_key, revoked_key).","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"402":{"description":"No plan or no API calls on the plan (no_plan, api_not_included, trial_ended).","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"Unknown company number, investor key or path (not_found).","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"429":{"description":"Per-key rate limit (rate_limited, Retry-After 60) or monthly quota used (quota_exceeded, Retry-After until the UTC month resets).","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"parameters":[{"name":"rule","in":"query","required":false,"description":"grant_then_equity, up_round, lower_priced, headcount_surge, distress or foreign_parent (comma separated).","schema":{"type":"string"},"example":"up_round"},{"name":"since","in":"query","required":false,"description":"Detected on or after: 30d, 12m or an ISO date.","schema":{"type":"string"},"example":"2026-09-01"},{"name":"detected","in":"query","required":false,"description":"Detected window: same forms as filed, including from..to.","schema":{"type":"string"}},{"name":"sector","in":"query","required":false,"description":"Bradshaw sector slug(s) of the company. A legacy SIC-group slug is still accepted here for backward compatibility; use sic_group.","schema":{"type":"string"}},{"name":"sic_group","in":"query","required":false,"description":"SIC group slug(s) of the company: software-and-it, life-sciences-and-health, ...","schema":{"type":"string"},"example":"software-and-it"},{"name":"region","in":"query","required":false,"description":"Region slug(s) of the company.","schema":{"type":"string"}},{"name":"sort","in":"query","required":false,"description":"detected (default newest first) or -detected / detected for the order.","schema":{"type":"string"}},{"name":"page","in":"query","required":false,"description":"Page number, from 1.","schema":{"type":"string"},"example":"1"},{"name":"per","in":"query","required":false,"description":"Rows per page: 25 (default), 50 or 100.","schema":{"type":"string"},"example":"50"}]}},"/search":{"get":{"summary":"Search companies and investors","description":"What the app's search box shows: up to 8 companies and 4 investors for the text. `q` is required (at least 2 characters). Not a paged list.","operationId":"search_search_get","security":[{"HTTPBearer":[]},{"APIKeyHeader":[]}],"parameters":[{"name":"q","in":"query","required":true,"schema":{"type":"string","maxLength":200,"description":"Name or company number; at least 2 characters.","title":"Q"},"description":"Name or company number; at least 2 characters."}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SearchResponse"}}}},"400":{"description":"A parameter the vocabulary does not accept (code invalid_parameter).","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, unknown or revoked key (missing_key, invalid_key, revoked_key).","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"402":{"description":"No plan or no API calls on the plan (no_plan, api_not_included, trial_ended).","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"Unknown company number, investor key or path (not_found).","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"429":{"description":"Per-key rate limit (rate_limited, Retry-After 60) or monthly quota used (quota_exceeded, Retry-After until the UTC month resets).","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/events":{"get":{"summary":"Corporate events","description":"Strike-off notices, liquidations, administrations, plc re-registrations, name changes and new corporate shareholders, newest first. Only event types that have passed their precision check are returned (`meta.live_types`); `acquired` and `possible_mbo` are never returned. Every event links to its filing or Gazette notice. Paged with `page` and `per` (25, 50 or 100).","operationId":"list_events_events_get","security":[{"HTTPBearer":[]},{"APIKeyHeader":[]}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EventsResponse"}}}},"400":{"description":"A parameter the vocabulary does not accept (code invalid_parameter).","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, unknown or revoked key (missing_key, invalid_key, revoked_key).","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"402":{"description":"No plan or no API calls on the plan (no_plan, api_not_included, trial_ended).","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"Unknown company number, investor key or path (not_found).","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"429":{"description":"Per-key rate limit (rate_limited, Retry-After 60) or monthly quota used (quota_exceeded, Retry-After until the UTC month resets).","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"parameters":[{"name":"type","in":"query","required":false,"description":"Event type(s), comma separated or repeated. Only types listed in `meta.live_types` are accepted.","schema":{"type":"string"},"example":"plc,name_change"},{"name":"company","in":"query","required":false,"description":"One company number.","schema":{"type":"string"},"example":"12203483"},{"name":"since","in":"query","required":false,"description":"Events dated on or after: an ISO date, or a span such as 30d or 12m.","schema":{"type":"string"},"example":"30d"},{"name":"page","in":"query","required":false,"description":"Page number, from 1.","schema":{"type":"string"},"example":"1"},{"name":"per","in":"query","required":false,"description":"Rows per page: 25 (default), 50 or 100.","schema":{"type":"string"},"example":"50"}]}},"/grants":{"get":{"summary":"Public grants","description":"Grant awards matched to a company number, newest start first, as published (an award offered is not money paid), each with its funder, licence and source link. Paged with `page` and `per` (25, 50 or 100).","operationId":"list_grants_grants_get","security":[{"HTTPBearer":[]},{"APIKeyHeader":[]}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GrantsResponse"}}}},"400":{"description":"A parameter the vocabulary does not accept (code invalid_parameter).","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, unknown or revoked key (missing_key, invalid_key, revoked_key).","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"402":{"description":"No plan or no API calls on the plan (no_plan, api_not_included, trial_ended).","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"Unknown company number, investor key or path (not_found).","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"429":{"description":"Per-key rate limit (rate_limited, Retry-After 60) or monthly quota used (quota_exceeded, Retry-After until the UTC month resets).","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"parameters":[{"name":"company","in":"query","required":false,"description":"One company number.","schema":{"type":"string"},"example":"12203483"},{"name":"funder","in":"query","required":false,"description":"Funder name, for example Innovate UK (not case sensitive).","schema":{"type":"string"},"example":"Innovate UK"},{"name":"source","in":"query","required":false,"description":"Source dataset, for example innovate_uk.","schema":{"type":"string"}},{"name":"since","in":"query","required":false,"description":"Project started on or after: an ISO date, or a span such as 12m.","schema":{"type":"string"},"example":"2025-01-01"},{"name":"min_award","in":"query","required":false,"description":"Smallest award offered, in pounds.","schema":{"type":"string"},"example":"100000"},{"name":"page","in":"query","required":false,"description":"Page number, from 1.","schema":{"type":"string"},"example":"1"},{"name":"per","in":"query","required":false,"description":"Rows per page: 25 (default), 50 or 100.","schema":{"type":"string"},"example":"50"}]}},"/lists":{"get":{"summary":"Your organisation's lists","description":"The saved lists of the key's own organisation: the shared ones, and those owned by the person who created the key. Another organisation's lists are never returned. Paged with `page` and `per` (25, 50 or 100).","operationId":"list_lists_lists_get","security":[{"HTTPBearer":[]},{"APIKeyHeader":[]}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListsResponse"}}}},"400":{"description":"A parameter the vocabulary does not accept (code invalid_parameter).","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, unknown or revoked key (missing_key, invalid_key, revoked_key).","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"402":{"description":"No plan or no API calls on the plan (no_plan, api_not_included, trial_ended).","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"Unknown company number, investor key or path (not_found).","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"429":{"description":"Per-key rate limit (rate_limited, Retry-After 60) or monthly quota used (quota_exceeded, Retry-After until the UTC month resets).","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"parameters":[{"name":"page","in":"query","required":false,"description":"Page number, from 1.","schema":{"type":"string"},"example":"1"},{"name":"per","in":"query","required":false,"description":"Rows per page: 25 (default), 50 or 100.","schema":{"type":"string"},"example":"50"}]}},"/lists/{list_id}":{"get":{"summary":"One list and its companies","description":"A list of the key's organisation and a page of its companies (`page` and `per`). A list that is not visible to the key is a 404, whoever owns it.","operationId":"get_list_lists__list_id__get","security":[{"HTTPBearer":[]},{"APIKeyHeader":[]}],"parameters":[{"name":"list_id","in":"path","required":true,"schema":{"type":"string","title":"List Id"}},{"name":"page","in":"query","required":false,"description":"Page number, from 1.","schema":{"type":"string"},"example":"1"},{"name":"per","in":"query","required":false,"description":"Rows per page: 25 (default), 50 or 100.","schema":{"type":"string"},"example":"50"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListResponse"}}}},"400":{"description":"A parameter the vocabulary does not accept (code invalid_parameter).","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing, unknown or revoked key (missing_key, invalid_key, revoked_key).","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"402":{"description":"No plan or no API calls on the plan (no_plan, api_not_included, trial_ended).","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such list for this key's organisation.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"429":{"description":"Per-key rate limit (rate_limited, Retry-After 60) or monthly quota used (quota_exceeded, Retry-After until the UTC month resets).","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}}},"components":{"schemas":{"CompaniesResponse":{"properties":{"api_version":{"type":"string","const":"1","title":"Api Version"},"data":{"items":{"$ref":"#/components/schemas/CompanyListItem"},"type":"array","title":"Data"},"meta":{"$ref":"#/components/schemas/ListMeta"}},"type":"object","required":["api_version","data","meta"],"title":"CompaniesResponse"},"Company":{"properties":{"company_number":{"type":"string","title":"Company Number"},"name":{"type":"string","title":"Name"},"status":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Status"},"incorporated_on":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Incorporated On"},"sic_codes":{"items":{"type":"string"},"type":"array","title":"Sic Codes"},"sector":{"type":"string","title":"Sector"},"region":{"type":"string","title":"Region"},"town":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Town"},"postcode":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Postcode"},"companies_house_url":{"type":"string","title":"Companies House Url"},"trading_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Trading Name"},"website":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Website"},"website_source":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Website Source","description":"Where the candidate site came from: domain_guess, press or session."},"website_match":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Website Match","description":"Strength of the check: number_on_site, legal_name_on_site or name_match (name only: an estimate)."},"website_checked_on":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Website Checked On"},"logo_url":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Logo Url","description":"Same-origin path `/logos/{company_number}` when a logo was fetched from the company's published website."},"lei":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Lei"},"company_class":{"type":"string","enum":["public","vehicle","subsidiary","independent"],"title":"Company Class","description":"public (plc by category or plc event), vehicle (name pattern or fund-held 75-100%), subsidiary (active corporate PSC at 75-100%), or independent.","default":"independent"},"class_basis":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Class Basis","description":"Why the class was set: company_category, plc_event, name_pattern, psc_75_fund or psc_75_corporate."},"class_evidence":{"items":{"type":"string"},"type":"array","title":"Class Evidence","description":"Supporting evidence only (holding_sic, activity_holding); never a sole class trigger."},"parent_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Parent Name","description":"Corporate PSC holder name when vehicle or subsidiary."},"parent_company_number":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Parent Company Number","description":"UK company number of the parent when we hold it."},"parent_public":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Parent Public","description":"True when the parent is a plc by the same public rule."},"parent_since":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Parent Since","description":"PSC notified_on date for the parent holding."},"lei_parent_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Lei Parent Name","description":"GLEIF direct parent legal name; corroboration only, never a sole class trigger."},"pe_backed":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Pe Backed","description":"Estimate: fund-like corporate PSC on the company or observed UK parent chain (name heuristic). Not a curated sponsor label. Null while the estimate is withheld (it has not passed its precision check)."},"pe_backed_basis":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Pe Backed Basis","description":"Structured provenance when pe_backed: rule_id, investor_key, investor_name, path, estimate."},"ownership_uk_chain":{"items":{"additionalProperties":true,"type":"object"},"type":"array","title":"Ownership Uk Chain","description":"Observed UK PSC parent hops upward (as-filed). No invented offshore nodes."},"ownership_uk_chain_status":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Ownership Uk Chain Status","description":"empty, ok, truncated, or cycle."},"rounds_summary":{"$ref":"#/components/schemas/RoundsSummary"},"rounds":{"items":{"$ref":"#/components/schemas/CompanyRound"},"type":"array","title":"Rounds","description":"Every priced round we can read, small ones included (the Company X-ray rule), oldest first."},"latest_financials":{"anyOf":[{"$ref":"#/components/schemas/Financials"},{"type":"null"}]},"corporate_holders":{"items":{"$ref":"#/components/schemas/Holder"},"type":"array","title":"Corporate Holders","description":"Corporate persons with significant control only; individuals are never included."}},"type":"object","required":["company_number","name","sic_codes","sector","region","companies_house_url","rounds_summary","rounds","corporate_holders"],"title":"Company"},"CompanyListItem":{"properties":{"company_number":{"type":"string","title":"Company Number"},"name":{"type":"string","title":"Name"},"status":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Status"},"incorporated_on":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Incorporated On"},"sector":{"type":"string","title":"Sector"},"region":{"type":"string","title":"Region"},"n_rounds":{"type":"integer","title":"N Rounds","description":"Priced rounds (the Company X-ray rule)."},"last_round_on":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Last Round On"},"total_raised":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Total Raised"},"currency":{"type":"string","const":"GBP","title":"Currency","default":"GBP"},"trading_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Trading Name"},"website":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Website"},"logo_url":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Logo Url","description":"Same-origin path `/logos/{company_number}` when a logo is stored."},"company_class":{"type":"string","enum":["public","vehicle","subsidiary","independent"],"title":"Company Class","default":"independent"}},"type":"object","required":["company_number","name","sector","region","n_rounds"],"title":"CompanyListItem"},"CompanyResponse":{"properties":{"api_version":{"type":"string","const":"1","title":"Api Version"},"data":{"$ref":"#/components/schemas/Company"},"meta":{"$ref":"#/components/schemas/Meta"}},"type":"object","required":["api_version","data","meta"],"title":"CompanyResponse"},"CompanyRound":{"properties":{"round_id":{"type":"integer","title":"Round Id"},"status":{"type":"string","title":"Status","description":"provisional, confirmed or similar review state of the round."},"currency":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Currency","description":"Currency of every money field of the round (GBP for all rounds listed)."},"allotted":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Allotted","description":"First allotment date."},"allotted_to":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Allotted To","description":"Last allotment date of the round."},"filed":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Filed","description":"Date the first filing of the round was filed at Companies House."},"cash_raised":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Cash Raised","description":"Sum of the priced allotment lines, as filed."},"price_per_share":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Price Per Share","description":"Highest priced line, amount paid per share including premium."},"new_shares":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"New Shares"},"total_shares_after":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Total Shares After","description":"Issued shares after the round, from the latest statement of capital."},"pre_money":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Pre Money","description":"Price x shares before the round, on an issued-share basis. Null when first_issue is true."},"post_money":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Post Money","description":"Price x shares after the round, as filed, on an issued-share basis (excludes any unissued option pool). Counts every share in issue, deferred shares included, so it can overstate value: use post_money_ex_deferred for a valuation."},"valuation_verdict":{"type":"string","enum":["quote","quote_with_care","never"],"title":"Valuation Verdict","description":"Whether a valuation may be quoted for the round, from its latest statement of capital. quote: post_money_ex_deferred is reliable. quote_with_care: it is shown but growth or incentive shares are 10% or more of the shares, or the priced class is under 10% of them (see valuation_note). never: no valuation (flagged for review, no post-money, no statement of capital, or the priced class cannot be found); post_money_ex_deferred is null and valuation_basis gives the reason.","default":"never"},"post_money_ex_deferred":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Post Money Ex Deferred","description":"Price x (shares in issue less deferred shares). Null when valuation_verdict is never. Deferred shares carry no economic value, so they are left out."},"valuation_basis":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Valuation Basis","description":"The working of post_money_ex_deferred, for example 'price 2.00 x (10,000 shares less 1,000 deferred)', or why valuation_verdict is never."},"valuation_note":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Valuation Note","description":"For quote_with_care, the reason to read the figure with care, for example 'Read with care: growth or incentive shares are 12% of shares'. Otherwise null."},"confidence":{"type":"number","title":"Confidence","description":"0 to 1; the working shows how it is built."},"flags":{"items":{"type":"string"},"type":"array","title":"Flags","description":"Checks that fired on the round."},"quality":{"type":"boolean","title":"Quality","description":"True when the round passes the quality rule behind /v1/rounds (priced equity, GBP, confidence 0.5 or more, cash 100,000 or more)."},"step_up":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Step Up","description":"Price divided by the company's previous quality round price, only when the step-up rules allow a comparison."},"step_up_direction":{"anyOf":[{"type":"string","enum":["up","flat","down"]},{"type":"null"}],"title":"Step Up Direction"},"first_round":{"type":"boolean","title":"First Round","description":"The company's first quality round."},"first_issue":{"type":"boolean","title":"First Issue","description":"True when new_shares >= total_shares_after (every share in issue is new); pre_money is then null.","default":false},"announced_on":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Announced On","description":"Date of a matched press announcement."},"press_url":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Press Url"},"filing_url":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Filing Url","description":"The Companies House filing page of the round's highest priced line."},"working":{"type":"string","title":"Working","description":"The arithmetic behind every number of the round, line by line, with document ids and pages."},"company_class":{"type":"string","enum":["public","vehicle","subsidiary","independent"],"title":"Company Class","description":"Company class at build time: public (plc), vehicle, subsidiary or independent. Copied from the company.","default":"independent"},"press":{"anyOf":[{"items":{"$ref":"#/components/schemas/PressMatch"},"type":"array"},{"type":"null"}],"title":"Press","description":"Press articles matched to the round, newest first. Present only while the press links feature is on. An empty list with press_checked true means we searched and found no press coverage."},"press_checked":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Press Checked","description":"True when we have searched for press coverage of this round (found or not). False: not checked yet. Present only while the press links feature is on."},"investors":{"items":{"$ref":"#/components/schemas/RoundInvestor"},"type":"array","title":"Investors","description":"Corporate PSC holders whose holding overlapped this round. Empty when no link has been built yet."}},"type":"object","required":["round_id","status","confidence","flags","quality","first_round","working"],"title":"CompanyRound"},"ErrorBody":{"properties":{"code":{"type":"string","title":"Code","description":"Stable machine code: missing_key, invalid_key, revoked_key, no_plan, api_not_included, trial_ended, invalid_parameter, not_found, rate_limited, quota_exceeded, data_unavailable, internal_error."},"message":{"type":"string","title":"Message","description":"Human-readable explanation. Safe to show; never contains secrets."}},"type":"object","required":["code","message"],"title":"ErrorBody"},"ErrorResponse":{"properties":{"error":{"$ref":"#/components/schemas/ErrorBody"}},"type":"object","required":["error"],"title":"ErrorResponse","description":"Every failure is JSON with this shape and a matching HTTP status (see roundbook.api.errors)."},"Event":{"properties":{"event_id":{"type":"integer","title":"Event Id"},"company_number":{"type":"string","title":"Company Number"},"company_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Company Name"},"event":{"type":"string","title":"Event","description":"strike_off_notice, strike_off_discontinued, dissolved, liquidation, administration, plc, name_change or corporate_owner. Only types whose precision check has passed are returned."},"label":{"type":"string","title":"Label","description":"Plain-English one-liner."},"event_date":{"type":"string","title":"Event Date","description":"The date carried by the defining filing, Gazette notice or PSC record; never inferred."},"solvent":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Solvent","description":"Liquidations only: true for a members' voluntary (solvent) liquidation."},"status":{"type":"string","enum":["detected","possible"],"title":"Status"},"confidence":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Confidence"},"source":{"type":"string","title":"Source","description":"filing, gazette, filing+gazette or psc."},"date_basis":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Date Basis","description":"Which document gave the date, for example `filing LIQ01`."},"filing_url":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Filing Url","description":"Companies House filing page of the defining filing."},"gazette_urls":{"items":{"type":"string"},"type":"array","title":"Gazette Urls"},"first_seen_at":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"First Seen At"},"corporate_shareholder":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Corporate Shareholder","description":"corporate_owner events only: the corporate shareholder's name."},"corporate_shareholder_number":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Corporate Shareholder Number"}},"type":"object","required":["event_id","company_number","event","label","event_date","status","source"],"title":"Event"},"EventsMeta":{"properties":{"data_to":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Data To","description":"Latest filing first seen by the live build (UTC, ISO 8601): the data is complete up to here."},"build_id":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Build Id","description":"Id of the read-model build that served this response."},"total":{"type":"integer","title":"Total","description":"Rows matching the filters, across all pages."},"page":{"type":"integer","title":"Page"},"per":{"type":"integer","title":"Per"},"pages":{"type":"integer","title":"Pages"},"next":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Next","description":"Relative URL of the next page, or null on the last page."},"prev":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Prev","description":"Relative URL of the previous page, or null on the first page."},"live_types":{"items":{"type":"string"},"type":"array","title":"Live Types","description":"The event types that have passed their precision check and may be requested with `type`. Empty while the Events feature is off. `acquired` and `possible_mbo` never appear."}},"type":"object","required":["total","page","per","pages","live_types"],"title":"EventsMeta"},"EventsResponse":{"properties":{"api_version":{"type":"string","const":"1","title":"Api Version"},"data":{"items":{"$ref":"#/components/schemas/Event"},"type":"array","title":"Data"},"meta":{"$ref":"#/components/schemas/EventsMeta"}},"type":"object","required":["api_version","data","meta"],"title":"EventsResponse"},"Financials":{"properties":{"period_start":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Period Start"},"period_end":{"type":"string","title":"Period End"},"balance_sheet_date":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Balance Sheet Date"},"is_prior_year":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Is Prior Year","description":"The figures come from the prior-year column of a later filing."},"accounts_class":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Accounts Class"},"accounts_type":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Accounts Type"},"accounting_standard":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Accounting Standard"},"audit_status":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Audit Status"},"dormant":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Dormant"},"currency":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Currency","description":"Currency of every money field in this row."},"turnover":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Turnover"},"gross_profit":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Gross Profit"},"operating_profit":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Operating Profit"},"profit_loss":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Profit Loss"},"equity":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Equity"},"net_assets":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Net Assets"},"cash":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Cash"},"current_assets":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Current Assets"},"debtors":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Debtors"},"net_current_assets":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Net Current Assets"},"total_assets_less_current_liabilities":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Total Assets Less Current Liabilities"},"creditors_within_one_year":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Creditors Within One Year"},"creditors_after_one_year":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Creditors After One Year"},"fixed_assets":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Fixed Assets"},"tangible_assets":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Tangible Assets"},"intangible_assets":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Intangible Assets"},"called_up_share_capital":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Called Up Share Capital"},"share_premium":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Share Premium"},"retained_earnings":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Retained Earnings"},"average_employees":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Average Employees"},"flags":{"items":{"type":"string"},"type":"array","title":"Flags","description":"Extraction checks that fired on the row."}},"type":"object","required":["period_end","flags"],"title":"Financials"},"FinancialsData":{"properties":{"company_number":{"type":"string","title":"Company Number"},"name":{"type":"string","title":"Name"},"periods":{"items":{"$ref":"#/components/schemas/Financials"},"type":"array","title":"Periods","description":"Newest period first. Figures as filed; a missing figure is null."}},"type":"object","required":["company_number","name","periods"],"title":"FinancialsData"},"FinancialsResponse":{"properties":{"api_version":{"type":"string","const":"1","title":"Api Version"},"data":{"$ref":"#/components/schemas/FinancialsData"},"meta":{"$ref":"#/components/schemas/Meta"}},"type":"object","required":["api_version","data","meta"],"title":"FinancialsResponse"},"Grant":{"properties":{"grant_id":{"type":"integer","title":"Grant Id"},"company_number":{"type":"string","title":"Company Number"},"company_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Company Name"},"participant_name":{"type":"string","title":"Participant Name"},"project_number":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Project Number"},"project_title":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Project Title"},"competition_title":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Competition Title"},"programme_title":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Programme Title"},"product_type":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Product Type"},"is_lead":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Is Lead"},"award_offered":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Award Offered","description":"As published: an offer, not money paid."},"total_costs":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Total Costs"},"currency":{"type":"string","title":"Currency","default":"GBP"},"start_date":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Start Date"},"end_date":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"End Date"},"project_status":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Project Status"},"funder":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Funder"},"source":{"type":"string","title":"Source"},"licence":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Licence"},"source_url":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Source Url"}},"type":"object","required":["grant_id","company_number","participant_name","source"],"title":"Grant"},"GrantsResponse":{"properties":{"api_version":{"type":"string","const":"1","title":"Api Version"},"data":{"items":{"$ref":"#/components/schemas/Grant"},"type":"array","title":"Data"},"meta":{"$ref":"#/components/schemas/ListMeta"}},"type":"object","required":["api_version","data","meta"],"title":"GrantsResponse"},"HTTPValidationError":{"properties":{"detail":{"items":{"$ref":"#/components/schemas/ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"},"Holder":{"properties":{"investor_key":{"type":"string","title":"Investor Key","description":"Use with /v1/investors/{key}."},"investor_name":{"type":"string","title":"Investor Name"},"psc_name":{"type":"string","title":"Psc Name","description":"The holder's name as it is on the PSC register."},"share_band":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Share Band","description":"Share ownership band notified, for example 25-50."},"holds_shares":{"type":"boolean","title":"Holds Shares"},"active":{"type":"boolean","title":"Active","description":"True while the notification has not ceased."},"notified_on":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Notified On"},"ceased_on":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Ceased On"},"country_registered":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Country Registered"}},"type":"object","required":["investor_key","investor_name","psc_name","holds_shares","active"],"title":"Holder"},"Investor":{"properties":{"key":{"type":"string","title":"Key","description":"The investor family key. Use with /v1/investors/{key}."},"name":{"type":"string","title":"Name"},"type":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Type","description":"Estimated type: fund_like, parent_like, nominee or other. An estimate."},"companies_held":{"type":"integer","title":"Companies Held","description":"Companies where the family has an active corporate PSC record holding shares."},"companies_ceased":{"type":"integer","title":"Companies Ceased"},"companies_with_round":{"type":"integer","title":"Companies With Round","description":"Held companies with at least one quality round."},"companies_with_round_since_2024":{"type":"integer","title":"Companies With Round Since 2024","description":"Held companies with a quality round allotted on or after 2024-01-01."},"cash_raised_since_2024":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Cash Raised Since 2024","description":"Cash raised by those companies in those rounds."},"currency":{"type":"string","const":"GBP","title":"Currency","default":"GBP"},"sectors":{"items":{"type":"string"},"type":"array","title":"Sectors"},"regions":{"items":{"type":"string"},"type":"array","title":"Regions"}},"type":"object","required":["key","name","companies_held","companies_ceased","companies_with_round","companies_with_round_since_2024","sectors","regions"],"title":"Investor"},"InvestorDetail":{"properties":{"investor":{"$ref":"#/components/schemas/Investor"},"portfolio":{"items":{"$ref":"#/components/schemas/PortfolioCompany"},"type":"array","title":"Portfolio","description":"Held companies first, then by name. Paged with page and per."}},"type":"object","required":["investor","portfolio"],"title":"InvestorDetail"},"InvestorResponse":{"properties":{"api_version":{"type":"string","const":"1","title":"Api Version"},"data":{"$ref":"#/components/schemas/InvestorDetail"},"meta":{"$ref":"#/components/schemas/ListMeta"}},"type":"object","required":["api_version","data","meta"],"title":"InvestorResponse"},"InvestorsResponse":{"properties":{"api_version":{"type":"string","const":"1","title":"Api Version"},"data":{"items":{"$ref":"#/components/schemas/Investor"},"type":"array","title":"Data"},"meta":{"$ref":"#/components/schemas/ListMeta"}},"type":"object","required":["api_version","data","meta"],"title":"InvestorsResponse"},"ListDetail":{"properties":{"list_id":{"type":"integer","title":"List Id"},"name":{"type":"string","title":"Name"},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description"},"purpose":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Purpose"},"shared":{"type":"boolean","title":"Shared","description":"Shared with the whole organisation. Private lists appear only for the key's creator."},"favourite":{"type":"boolean","title":"Favourite"},"n_companies":{"type":"integer","title":"N Companies"},"created_at":{"type":"string","title":"Created At"},"companies":{"items":{"$ref":"#/components/schemas/ListMember"},"type":"array","title":"Companies","description":"This page of the list's companies, oldest added first."}},"type":"object","required":["list_id","name","shared","favourite","n_companies","created_at","companies"],"title":"ListDetail"},"ListMember":{"properties":{"company_number":{"type":"string","title":"Company Number"},"name":{"type":"string","title":"Name"},"added_at":{"type":"string","title":"Added At"},"source":{"type":"string","enum":["manual","auto"],"title":"Source"},"sector":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Sector"},"region":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Region"},"n_rounds":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"N Rounds"},"last_round_on":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Last Round On"},"total_raised":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Total Raised"},"currency":{"type":"string","const":"GBP","title":"Currency","default":"GBP"},"companies_house_url":{"type":"string","title":"Companies House Url"}},"type":"object","required":["company_number","name","added_at","source","companies_house_url"],"title":"ListMember"},"ListMeta":{"properties":{"data_to":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Data To","description":"Latest filing first seen by the live build (UTC, ISO 8601): the data is complete up to here."},"build_id":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Build Id","description":"Id of the read-model build that served this response."},"total":{"type":"integer","title":"Total","description":"Rows matching the filters, across all pages."},"page":{"type":"integer","title":"Page"},"per":{"type":"integer","title":"Per"},"pages":{"type":"integer","title":"Pages"},"next":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Next","description":"Relative URL of the next page, or null on the last page."},"prev":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Prev","description":"Relative URL of the previous page, or null on the first page."}},"type":"object","required":["total","page","per","pages"],"title":"ListMeta"},"ListResponse":{"properties":{"api_version":{"type":"string","const":"1","title":"Api Version"},"data":{"$ref":"#/components/schemas/ListDetail"},"meta":{"$ref":"#/components/schemas/ListMeta"}},"type":"object","required":["api_version","data","meta"],"title":"ListResponse"},"ListSummary":{"properties":{"list_id":{"type":"integer","title":"List Id"},"name":{"type":"string","title":"Name"},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description"},"purpose":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Purpose"},"shared":{"type":"boolean","title":"Shared","description":"Shared with the whole organisation. Private lists appear only for the key's creator."},"favourite":{"type":"boolean","title":"Favourite"},"n_companies":{"type":"integer","title":"N Companies"},"created_at":{"type":"string","title":"Created At"}},"type":"object","required":["list_id","name","shared","favourite","n_companies","created_at"],"title":"ListSummary"},"ListsResponse":{"properties":{"api_version":{"type":"string","const":"1","title":"Api Version"},"data":{"items":{"$ref":"#/components/schemas/ListSummary"},"type":"array","title":"Data"},"meta":{"$ref":"#/components/schemas/ListMeta"}},"type":"object","required":["api_version","data","meta"],"title":"ListsResponse"},"Meta":{"properties":{"data_to":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Data To","description":"Latest filing first seen by the live build (UTC, ISO 8601): the data is complete up to here."},"build_id":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Build Id","description":"Id of the read-model build that served this response."}},"type":"object","title":"Meta"},"PortfolioCompany":{"properties":{"company_number":{"type":"string","title":"Company Number"},"name":{"type":"string","title":"Name"},"status":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Status"},"sector":{"type":"string","title":"Sector"},"region":{"type":"string","title":"Region"},"share_band":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Share Band"},"psc_names":{"items":{"type":"string"},"type":"array","title":"Psc Names"},"holds_shares":{"type":"boolean","title":"Holds Shares"},"held":{"type":"boolean","title":"Held","description":"An active record holding shares."},"notified_on":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Notified On","description":"Earliest notification."},"ceased_on":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Ceased On","description":"Latest cessation, null while any record is active."},"rounds":{"$ref":"#/components/schemas/PortfolioRounds","description":"The company's quality rounds."}},"type":"object","required":["company_number","name","sector","region","psc_names","holds_shares","held","rounds"],"title":"PortfolioCompany"},"PortfolioRounds":{"properties":{"currency":{"type":"string","const":"GBP","title":"Currency","default":"GBP"},"n_rounds":{"type":"integer","title":"N Rounds"},"total_cash":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Total Cash"},"last_allotted":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Last Allotted"},"last_round_id":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Last Round Id","description":"round_id of the latest quality GBP round; use with /companies/{number}?round=."},"last_cash":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Last Cash"},"last_price":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Last Price"}},"type":"object","required":["n_rounds"],"title":"PortfolioRounds"},"PressMatch":{"properties":{"url":{"type":"string","title":"Url","description":"Link to the article."},"title":{"type":"string","title":"Title"},"outlet":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Outlet"},"published_on":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Published On","description":"Publication date of the article."},"method":{"type":"string","title":"Method","description":"How the match was found: gdelt, session, news or sitemap."}},"type":"object","required":["url","title","method"],"title":"PressMatch"},"Round":{"properties":{"round_id":{"type":"integer","title":"Round Id"},"status":{"type":"string","title":"Status","description":"provisional, confirmed or similar review state of the round."},"currency":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Currency","description":"Currency of every money field of the round (GBP for all rounds listed)."},"allotted":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Allotted","description":"First allotment date."},"allotted_to":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Allotted To","description":"Last allotment date of the round."},"filed":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Filed","description":"Date the first filing of the round was filed at Companies House."},"cash_raised":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Cash Raised","description":"Sum of the priced allotment lines, as filed."},"price_per_share":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Price Per Share","description":"Highest priced line, amount paid per share including premium."},"new_shares":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"New Shares"},"total_shares_after":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Total Shares After","description":"Issued shares after the round, from the latest statement of capital."},"pre_money":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Pre Money","description":"Price x shares before the round, on an issued-share basis. Null when first_issue is true."},"post_money":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Post Money","description":"Price x shares after the round, as filed, on an issued-share basis (excludes any unissued option pool). Counts every share in issue, deferred shares included, so it can overstate value: use post_money_ex_deferred for a valuation."},"valuation_verdict":{"type":"string","enum":["quote","quote_with_care","never"],"title":"Valuation Verdict","description":"Whether a valuation may be quoted for the round, from its latest statement of capital. quote: post_money_ex_deferred is reliable. quote_with_care: it is shown but growth or incentive shares are 10% or more of the shares, or the priced class is under 10% of them (see valuation_note). never: no valuation (flagged for review, no post-money, no statement of capital, or the priced class cannot be found); post_money_ex_deferred is null and valuation_basis gives the reason.","default":"never"},"post_money_ex_deferred":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Post Money Ex Deferred","description":"Price x (shares in issue less deferred shares). Null when valuation_verdict is never. Deferred shares carry no economic value, so they are left out."},"valuation_basis":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Valuation Basis","description":"The working of post_money_ex_deferred, for example 'price 2.00 x (10,000 shares less 1,000 deferred)', or why valuation_verdict is never."},"valuation_note":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Valuation Note","description":"For quote_with_care, the reason to read the figure with care, for example 'Read with care: growth or incentive shares are 12% of shares'. Otherwise null."},"confidence":{"type":"number","title":"Confidence","description":"0 to 1; the working shows how it is built."},"flags":{"items":{"type":"string"},"type":"array","title":"Flags","description":"Checks that fired on the round."},"quality":{"type":"boolean","title":"Quality","description":"True when the round passes the quality rule behind /v1/rounds (priced equity, GBP, confidence 0.5 or more, cash 100,000 or more)."},"step_up":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Step Up","description":"Price divided by the company's previous quality round price, only when the step-up rules allow a comparison."},"step_up_direction":{"anyOf":[{"type":"string","enum":["up","flat","down"]},{"type":"null"}],"title":"Step Up Direction"},"first_round":{"type":"boolean","title":"First Round","description":"The company's first quality round."},"first_issue":{"type":"boolean","title":"First Issue","description":"True when new_shares >= total_shares_after (every share in issue is new); pre_money is then null.","default":false},"announced_on":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Announced On","description":"Date of a matched press announcement."},"press_url":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Press Url"},"filing_url":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Filing Url","description":"The Companies House filing page of the round's highest priced line."},"working":{"type":"string","title":"Working","description":"The arithmetic behind every number of the round, line by line, with document ids and pages."},"company_class":{"type":"string","enum":["public","vehicle","subsidiary","independent"],"title":"Company Class","description":"Company class at build time: public (plc), vehicle, subsidiary or independent. Copied from the company.","default":"independent"},"press":{"anyOf":[{"items":{"$ref":"#/components/schemas/PressMatch"},"type":"array"},{"type":"null"}],"title":"Press","description":"Press articles matched to the round, newest first. Present only while the press links feature is on. An empty list with press_checked true means we searched and found no press coverage."},"press_checked":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Press Checked","description":"True when we have searched for press coverage of this round (found or not). False: not checked yet. Present only while the press links feature is on."},"company_number":{"type":"string","title":"Company Number"},"name":{"type":"string","title":"Name","description":"Company name as registered."},"sector":{"type":"string","title":"Sector"},"region":{"type":"string","title":"Region"}},"type":"object","required":["round_id","status","confidence","flags","quality","first_round","working","company_number","name","sector","region"],"title":"Round"},"RoundInvestor":{"properties":{"key":{"type":"string","title":"Key","description":"Investor family key. Use with /v1/investors/{key}."},"name":{"type":"string","title":"Name"},"share_band":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Share Band","description":"PSC share band when the link came from the register."},"basis":{"type":"string","title":"Basis","description":"Evidence basis: psc, confirmation_statement, director_appointment, press or form_d."},"confirmed":{"type":"boolean","title":"Confirmed","description":"True when the link comes from a filing (PSC register), false when inferred."}},"type":"object","required":["key","name","basis","confirmed"],"title":"RoundInvestor"},"RoundsResponse":{"properties":{"api_version":{"type":"string","const":"1","title":"Api Version"},"data":{"items":{"$ref":"#/components/schemas/Round"},"type":"array","title":"Data"},"meta":{"$ref":"#/components/schemas/ListMeta"}},"type":"object","required":["api_version","data","meta"],"title":"RoundsResponse"},"RoundsSummary":{"properties":{"currency":{"type":"string","const":"GBP","title":"Currency","default":"GBP"},"n_rounds":{"type":"integer","title":"N Rounds"},"first_round_on":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"First Round On"},"last_round_on":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Last Round On"},"total_raised":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Total Raised"},"latest_price":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Latest Price"},"latest_post_money":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Latest Post Money","description":"Post-money of the latest round, as filed (counts deferred shares). See latest_post_money_ex_deferred."},"latest_valuation_verdict":{"type":"string","enum":["quote","quote_with_care","never"],"title":"Latest Valuation Verdict","description":"valuation_verdict of the latest round (see the round's fields).","default":"never"},"latest_post_money_ex_deferred":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Latest Post Money Ex Deferred","description":"post_money_ex_deferred of the latest round. Null when latest_valuation_verdict is never."}},"type":"object","required":["n_rounds"],"title":"RoundsSummary"},"SearchCompany":{"properties":{"company_number":{"type":"string","title":"Company Number"},"name":{"type":"string","title":"Name"},"trading_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Trading Name"},"website":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Website"},"n_rounds":{"type":"integer","title":"N Rounds"}},"type":"object","required":["company_number","name","n_rounds"],"title":"SearchCompany"},"SearchData":{"properties":{"q":{"type":"string","title":"Q"},"companies":{"items":{"$ref":"#/components/schemas/SearchCompany"},"type":"array","title":"Companies","description":"Up to 8."},"investors":{"items":{"$ref":"#/components/schemas/SearchInvestor"},"type":"array","title":"Investors","description":"Up to 4."},"total_companies":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Total Companies","description":"Companies /v1/companies?q= would list, or null when it could not be counted in time."}},"type":"object","required":["q","companies","investors"],"title":"SearchData"},"SearchInvestor":{"properties":{"key":{"type":"string","title":"Key"},"name":{"type":"string","title":"Name"},"companies_held":{"type":"integer","title":"Companies Held"},"companies_with_round":{"type":"integer","title":"Companies With Round"}},"type":"object","required":["key","name","companies_held","companies_with_round"],"title":"SearchInvestor"},"SearchResponse":{"properties":{"api_version":{"type":"string","const":"1","title":"Api Version"},"data":{"$ref":"#/components/schemas/SearchData"},"meta":{"$ref":"#/components/schemas/Meta"}},"type":"object","required":["api_version","data","meta"],"title":"SearchResponse"},"Signal":{"properties":{"signal_id":{"type":"integer","title":"Signal Id"},"rule":{"type":"string","title":"Rule"},"company_number":{"type":"string","title":"Company Number"},"name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Name"},"sector":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Sector"},"region":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Region"},"round_id":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Round Id"},"detected_on":{"type":"string","title":"Detected On"},"detail":{"additionalProperties":true,"type":"object","title":"Detail","description":"The facts behind the signal, as recorded by the rule."}},"type":"object","required":["signal_id","rule","company_number","detected_on","detail"],"title":"Signal"},"SignalsResponse":{"properties":{"api_version":{"type":"string","const":"1","title":"Api Version"},"data":{"items":{"$ref":"#/components/schemas/Signal"},"type":"array","title":"Data"},"meta":{"$ref":"#/components/schemas/ListMeta"}},"type":"object","required":["api_version","data","meta"],"title":"SignalsResponse"},"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"}},"securitySchemes":{"HTTPBearer":{"type":"http","description":"bk_live_... API key","scheme":"bearer"},"APIKeyHeader":{"type":"apiKey","in":"header","name":"X-API-Key"}}},"servers":[{"url":"/v1"}]}