Skip to content

Instantly share code, notes, and snippets.

@tonidy

tonidy/ch-swagger.json

Last active January 23, 2022 14:06
Show Gist options
  • Star 0 You must be signed in to star a gist
  • Fork 0 You must be signed in to fork a gist
  • Save tonidy/4cc1569dcbcc12ef6e0b74f6e83adb9d to your computer and use it in GitHub Desktop.
Save tonidy/4cc1569dcbcc12ef6e0b74f6e83adb9d to your computer and use it in GitHub Desktop.
Download ZIP
CH Swagger
Raw
ch-swagger.json
{
"swagger": "2.0",
"info": {
"version": "1.0.0",
"title": "Companies House Public Data API",
"description": "An API suite providing read only access to search and retrieve public company data"
},
"host": "api.company-information.service.gov.uk",
"schemes": [
"https",
"http"
],
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [{
"name": "registeredOfficeAddress",
"description": "Registered office address"
},
{
"name": "companyProfile",
"description": "Company profile"
},
{
"name": "search",
"description": "Search"
},
{
"name": "officers",
"description": "Officers"
},
{
"name": "registers",
"description": "Registers"
},
{
"name": "charges",
"description": "Charges"
},
{
"name": "filingHistory",
"description": "Filing history"
},
{
"name": "insolvency",
"description": "Insolvency"
},
{
"name": "exemptions",
"description": "Exemptions"
},
{
"name": "officerDisqualifications",
"description": "Officer disqualifications"
},
{
"name": "officerAppointments",
"description": "Officer appointments"
},
{
"name": "UKEstablishments",
"description": "UK Establishments"
},
{
"name": "personsWithSignificantControl",
"description": "Persons with significant control"
}
],
"securityDefinitions": {
"api_key": {
"type": "apiKey",
"name": "api_key",
"in": "header"
}
},
"security": [{
"api_key": []
}
],
"paths": {
"/company/{companyNumber}/registered-office-address": {
"$ref": "https:/developer-specs.company-information.service.gov.uk/api.ch.gov.uk-specifications/swagger-2.0/spec/companyAddress.json#/getCompanyAddress"
},
"/company/{companyNumber}": {
"$ref": "https:/developer-specs.company-information.service.gov.uk/api.ch.gov.uk-specifications/swagger-2.0/spec/companyProfile.json"
},
"/search": {
"$ref": "https:/developer-specs.company-information.service.gov.uk/api.ch.gov.uk-specifications/swagger-2.0/spec/search.json#/searchAll"
},
"/search/companies": {
"$ref": "https:/developer-specs.company-information.service.gov.uk/api.ch.gov.uk-specifications/swagger-2.0/spec/search.json#/searchCompanies"
},
"/search/officers": {
"$ref": "https:/developer-specs.company-information.service.gov.uk/api.ch.gov.uk-specifications/swagger-2.0/spec/search.json#/searchOfficers"
},
"/search/disqualified-officers": {
"$ref": "https:/developer-specs.company-information.service.gov.uk/api.ch.gov.uk-specifications/swagger-2.0/spec/search.json#/searchDisqualified-officers"
},
"/dissolved-search/companies": {
"$ref": "https:/developer-specs.company-information.service.gov.uk/api.ch.gov.uk-specifications/swagger-2.0/spec/search-companies.json#/searchDissolved"
},
"/alphabetic-search/companies": {
"$ref": "https:/developer-specs.company-information.service.gov.uk/api.ch.gov.uk-specifications/swagger-2.0/spec/search-companies.json#/searchAlphabetic"
},
"/company/{company_number}/officers": {
"$ref": "https:/developer-specs.company-information.service.gov.uk/api.ch.gov.uk-specifications/swagger-2.0/spec/companyOfficerList.json#/listCompanyOfficers"
},
"/company/{company_number}/appointments/{appointment_id}": {
"$ref": "https:/developer-specs.company-information.service.gov.uk/api.ch.gov.uk-specifications/swagger-2.0/spec/companyOfficerList.json#/getCompanyOfficerAppointment"
},
"/company/{company_number}/registers": {
"$ref": "https:/developer-specs.company-information.service.gov.uk/api.ch.gov.uk-specifications/swagger-2.0/spec/companyRegisters.json"
},
"/company/{company_number}/filing-history/{transaction_id}": {
"$ref": "https:/developer-specs.company-information.service.gov.uk/api.ch.gov.uk-specifications/swagger-2.0/spec/filingHistory.json#/getFilingHistory"
},
"/company/{company_number}/filing-history": {
"$ref": "https:/developer-specs.company-information.service.gov.uk/api.ch.gov.uk-specifications/swagger-2.0/spec/filingHistory.json#/listFilingHistory"
},
"/company/{company_number}/exemptions": {
"$ref": "https:/developer-specs.company-information.service.gov.uk/api.ch.gov.uk-specifications/swagger-2.0/spec/exemptions.json"
},
"/disqualified-officers/natural/{officer_id}": {
"$ref": "https:/developer-specs.company-information.service.gov.uk/api.ch.gov.uk-specifications/swagger-2.0/spec/disqualifications.json#/getNatural"
},
"/disqualified-officers/corporate/{officer_id}": {
"$ref": "https:/developer-specs.company-information.service.gov.uk/api.ch.gov.uk-specifications/swagger-2.0/spec/disqualifications.json#/getCorporate"
},
"/officers/{officer_id}/appointments": {
"$ref": "https:/developer-specs.company-information.service.gov.uk/api.ch.gov.uk-specifications/swagger-2.0/spec/officerAppointmentList.json"
},
"/company/{company_number}/charges": {
"$ref": "https:/developer-specs.company-information.service.gov.uk/api.ch.gov.uk-specifications/swagger-2.0/spec/charges.json#/chargeList"
},
"/company/{company_number}/charges/{charge_id}": {
"$ref": "https:/developer-specs.company-information.service.gov.uk/api.ch.gov.uk-specifications/swagger-2.0/spec/charges.json#/chargeDetails"
},
"/company/{company_number}/insolvency": {
"$ref": "https:/developer-specs.company-information.service.gov.uk/api.ch.gov.uk-specifications/swagger-2.0/spec/insolvency.json"
},
"/company/{company_number}/uk-establishments": {
"$ref": "https:/developer-specs.company-information.service.gov.uk/api.ch.gov.uk-specifications/swagger-2.0/spec/companyUKEstablishments.json"
},
"/company/{company_number}/persons-with-significant-control": {
"$ref": "https:/developer-specs.company-information.service.gov.uk/api.ch.gov.uk-specifications/swagger-2.0/spec/psc.json#/listCompanyPSC"
},
"/company/{company_number}/persons-with-significant-control/individual/{psc_id}": {
"$ref": "https:/developer-specs.company-information.service.gov.uk/api.ch.gov.uk-specifications/swagger-2.0/spec/psc.json#/getIndividualPSC"
},
"/company/{company_number}/persons-with-significant-control/corporate-entity/{psc_id}": {
"$ref": "https:/developer-specs.company-information.service.gov.uk/api.ch.gov.uk-specifications/swagger-2.0/spec/psc.json#/getCorporateEntityPSC"
},
"/company/{company_number}/persons-with-significant-control/legal-person/{psc_id}": {
"$ref": "https:/developer-specs.company-information.service.gov.uk/api.ch.gov.uk-specifications/swagger-2.0/spec/psc.json#/getLegalPersonPSC"
},
"/company/{company_number}/persons-with-significant-control-statements": {
"$ref": "https:/developer-specs.company-information.service.gov.uk/api.ch.gov.uk-specifications/swagger-2.0/spec/psc.json#/listCompanyPSCStatements"
},
"/company/{company_number}/persons-with-significant-control-statements/{statement_id}": {
"$ref": "https:/developer-specs.company-information.service.gov.uk/api.ch.gov.uk-specifications/swagger-2.0/spec/psc.json#/getPSCStatement"
},
"/company/{company_number}/persons-with-significant-control/super-secure/{super_secure_id}": {
"$ref": "https:/developer-specs.company-information.service.gov.uk/api.ch.gov.uk-specifications/swagger-2.0/spec/psc.json#/getSuperSecurePSC"
}
}
}
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment