{"openapi":"3.1.0","info":{"title":"Apizie","version":"2.0.0","description":"One API key, one envelope, many public data sources."},"servers":[{"url":"https://zieapi.vercel.app"}],"security":[{"ApiKeyAuth":[]}],"paths":{"/v1/open-data:parliament-uk-bills/get-api-v1-bill-types":{"get":{"operationId":"open_data_parliament_uk_bills_get_api_v1_bill_types","summary":"Returns a list of Bill types.","description":"GET /api/v1/BillTypes","tags":["open-data"],"parameters":[{"name":"Category","in":"query","required":false,"schema":{"type":"string","enum":["Public","Private","Hybrid"]}},{"name":"Skip","in":"query","required":false,"schema":{"type":"integer"}},{"name":"Take","in":"query","required":false,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/open-data:parliament-uk-bills/get-bills":{"get":{"operationId":"open_data_parliament_uk_bills_get_bills","summary":"Returns a list of Bills.","description":"GET /api/v1/Bills","tags":["open-data"],"parameters":[{"name":"SearchTerm","in":"query","required":false,"schema":{"type":"string"}},{"name":"Session","in":"query","required":false,"schema":{"type":"integer"}},{"name":"CurrentHouse","in":"query","required":false,"schema":{"type":"string","enum":["All","Commons","Lords","Unassigned"]}},{"name":"OriginatingHouse","in":"query","required":false,"schema":{"type":"string","enum":["All","Commons","Lords"]}},{"name":"MemberId","in":"query","required":false,"schema":{"type":"integer"}},{"name":"DepartmentId","in":"query","required":false,"schema":{"type":"integer"}},{"name":"BillStage","in":"query","required":false,"schema":{"type":"array"}},{"name":"BillStagesExcluded","in":"query","required":false,"schema":{"type":"array"}},{"name":"IsDefeated","in":"query","required":false,"schema":{"type":"boolean"}},{"name":"IsWithdrawn","in":"query","required":false,"schema":{"type":"boolean"}},{"name":"BillType","in":"query","required":false,"schema":{"type":"array"}},{"name":"SortOrder","in":"query","required":false,"schema":{"type":"string","enum":["TitleAscending","TitleDescending","DateUpdatedAscending","DateUpdatedDescending"]}},{"name":"BillIds","in":"query","required":false,"schema":{"type":"array"}},{"name":"Skip","in":"query","required":false,"schema":{"type":"integer"}},{"name":"Take","in":"query","required":false,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/open-data:parliament-uk-bills/get-bill":{"get":{"operationId":"open_data_parliament_uk_bills_get_bill","summary":"Return a Bill.","description":"GET /api/v1/Bills/{billId}","tags":["open-data"],"parameters":[{"name":"billId","in":"query","required":true,"description":"Bill with ID specified","schema":{"type":"integer","description":"Bill with ID specified"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/open-data:parliament-uk-bills/get-news-articles":{"get":{"operationId":"open_data_parliament_uk_bills_get_news_articles","summary":"Returns a list of news articles for a Bill.","description":"GET /api/v1/Bills/{billId}/NewsArticles","tags":["open-data"],"parameters":[{"name":"billId","in":"query","required":true,"schema":{"type":"integer"}},{"name":"Skip","in":"query","required":false,"schema":{"type":"integer"}},{"name":"Take","in":"query","required":false,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/open-data:parliament-uk-bills/get-bill-publication":{"get":{"operationId":"open_data_parliament_uk_bills_get_bill_publication","summary":"Return a list of Bill publications.","description":"GET /api/v1/Bills/{billId}/Publications","tags":["open-data"],"parameters":[{"name":"billId","in":"query","required":true,"description":"Publications relating to Bill with Bill ID specified","schema":{"type":"integer","description":"Publications relating to Bill with Bill ID specified"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/open-data:parliament-uk-bills/get-api-v1-bills-bill-id-stages":{"get":{"operationId":"open_data_parliament_uk_bills_get_api_v1_bills_bill_id_stages","summary":"Returns all Bill stages.","description":"GET /api/v1/Bills/{billId}/Stages","tags":["open-data"],"parameters":[{"name":"billId","in":"query","required":true,"description":"Stages relating to a Bill with Bill ID specified","schema":{"type":"integer","description":"Stages relating to a Bill with Bill ID specified"}},{"name":"Skip","in":"query","required":false,"schema":{"type":"integer"}},{"name":"Take","in":"query","required":false,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/open-data:parliament-uk-bills/get-bill-stage-details":{"get":{"operationId":"open_data_parliament_uk_bills_get_bill_stage_details","summary":"Returns a Bill stage.","description":"GET /api/v1/Bills/{billId}/Stages/{billStageId}","tags":["open-data"],"parameters":[{"name":"billId","in":"query","required":true,"description":"Bill stage relating to Bill with Bill ID specified","schema":{"type":"integer","description":"Bill stage relating to Bill with Bill ID specified"}},{"name":"billStageId","in":"query","required":true,"description":"Bill stage with ID specified","schema":{"type":"integer","description":"Bill stage with ID specified"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/open-data:parliament-uk-bills/get-amendments":{"get":{"operationId":"open_data_parliament_uk_bills_get_amendments","summary":"Returns a list of amendments.","description":"GET /api/v1/Bills/{billId}/Stages/{billStageId}/Amendments","tags":["open-data"],"parameters":[{"name":"billId","in":"query","required":true,"description":"Amendments relating to a Bill with Bill ID specified","schema":{"type":"integer","description":"Amendments relating to a Bill with Bill ID specified"}},{"name":"billStageId","in":"query","required":true,"description":"Amendments relating to a Bill stage with Bill stage ID specified","schema":{"type":"integer","description":"Amendments relating to a Bill stage with Bill stage ID specified"}},{"name":"SearchTerm","in":"query","required":false,"schema":{"type":"string"}},{"name":"Decision","in":"query","required":false,"schema":{"type":"string","enum":["All","NoDecision","Withdrawn","Disagreed","NotMoved","Agreed"]}},{"name":"MemberId","in":"query","required":false,"schema":{"type":"integer"}},{"name":"Skip","in":"query","required":false,"schema":{"type":"integer"}},{"name":"Take","in":"query","required":false,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/open-data:parliament-uk-bills/get-amendment":{"get":{"operationId":"open_data_parliament_uk_bills_get_amendment","summary":"Returns an amendment.","description":"GET /api/v1/Bills/{billId}/Stages/{billStageId}/Amendments/{amendmentId}","tags":["open-data"],"parameters":[{"name":"billId","in":"query","required":true,"description":"Amendment relating to a bill with bill ID specified","schema":{"type":"integer","description":"Amendment relating to a bill with bill ID specified"}},{"name":"billStageId","in":"query","required":true,"description":"Amendment relating to a bill stage with bill stage ID specified","schema":{"type":"integer","description":"Amendment relating to a bill stage with bill stage ID specified"}},{"name":"amendmentId","in":"query","required":true,"description":"Amendment with amendment ID specified","schema":{"type":"integer","description":"Amendment with amendment ID specified"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/open-data:parliament-uk-bills/get-api-v1-bills-bill-id-stages-stage-id-publications":{"get":{"operationId":"open_data_parliament_uk_bills_get_api_v1_bills_bill_id_stages_stage_id_publications","summary":"Return a list of Bill stage publications.","description":"GET /api/v1/Bills/{billId}/Stages/{stageId}/Publications","tags":["open-data"],"parameters":[{"name":"billId","in":"query","required":true,"schema":{"type":"integer"}},{"name":"stageId","in":"query","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/open-data:parliament-uk-bills/get-api-v1-publication-types":{"get":{"operationId":"open_data_parliament_uk_bills_get_api_v1_publication_types","summary":"Returns a list of publication types.","description":"GET /api/v1/PublicationTypes","tags":["open-data"],"parameters":[{"name":"Skip","in":"query","required":false,"schema":{"type":"integer"}},{"name":"Take","in":"query","required":false,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/open-data:parliament-uk-bills/get-api-v1-publications-publication-id-documents-document-id":{"get":{"operationId":"open_data_parliament_uk_bills_get_api_v1_publications_publication_id_documents_document_id","summary":"Return information on a document.","description":"GET /api/v1/Publications/{publicationId}/Documents/{documentId}","tags":["open-data"],"parameters":[{"name":"publicationId","in":"query","required":true,"description":"Document with publication Id specified","schema":{"type":"integer","description":"Document with publication Id specified"}},{"name":"documentId","in":"query","required":true,"description":"Document with Id specified","schema":{"type":"integer","description":"Document with Id specified"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/open-data:parliament-uk-bills/get-api-v1-publications-publication-id-documents-document-id-2":{"get":{"operationId":"open_data_parliament_uk_bills_get_api_v1_publications_publication_id_documents_document_id_2","summary":"Return a document.","description":"GET /api/v1/Publications/{publicationId}/Documents/{documentId}/Download","tags":["open-data"],"parameters":[{"name":"publicationId","in":"query","required":true,"description":"Document with publication Id specified","schema":{"type":"integer","description":"Document with publication Id specified"}},{"name":"documentId","in":"query","required":true,"description":"Document with Id specified","schema":{"type":"integer","description":"Document with Id specified"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/open-data:parliament-uk-bills/get-api-v1-rss-bills-id-rss":{"get":{"operationId":"open_data_parliament_uk_bills_get_api_v1_rss_bills_id_rss","summary":"Returns an Rss feed of a certain Bill.","description":"GET /api/v1/Rss/Bills/{id}.rss","tags":["open-data"],"parameters":[{"name":"id","in":"query","required":true,"description":"Id of Bill","schema":{"type":"integer","description":"Id of Bill"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/open-data:parliament-uk-bills/get-api-v1-rss-allbills-rss":{"get":{"operationId":"open_data_parliament_uk_bills_get_api_v1_rss_allbills_rss","summary":"Returns an Rss feed of all Bills.","description":"GET /api/v1/Rss/allbills.rss","tags":["open-data"],"parameters":[],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/open-data:parliament-uk-bills/get-api-v1-rss-privatebills-rss":{"get":{"operationId":"open_data_parliament_uk_bills_get_api_v1_rss_privatebills_rss","summary":"Returns an Rss feed of private Bills.","description":"GET /api/v1/Rss/privatebills.rss","tags":["open-data"],"parameters":[],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/open-data:parliament-uk-bills/get-api-v1-rss-publicbills-rss":{"get":{"operationId":"open_data_parliament_uk_bills_get_api_v1_rss_publicbills_rss","summary":"Returns an Rss feed of public Bills.","description":"GET /api/v1/Rss/publicbills.rss","tags":["open-data"],"parameters":[],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/open-data:parliament-uk-bills/get-sittings":{"get":{"operationId":"open_data_parliament_uk_bills_get_sittings","summary":"Returns a list of Sittings.","description":"GET /api/v1/Sittings","tags":["open-data"],"parameters":[{"name":"House","in":"query","required":false,"schema":{"type":"string","enum":["All","Commons","Lords","Unassigned"]}},{"name":"DateFrom","in":"query","required":false,"schema":{"type":"string"}},{"name":"DateTo","in":"query","required":false,"schema":{"type":"string"}},{"name":"Skip","in":"query","required":false,"schema":{"type":"integer"}},{"name":"Take","in":"query","required":false,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/open-data:parliament-uk-bills/get-api-v1-stages":{"get":{"operationId":"open_data_parliament_uk_bills_get_api_v1_stages","summary":"Returns a list of Bill stages.","description":"GET /api/v1/Stages","tags":["open-data"],"parameters":[{"name":"Skip","in":"query","required":false,"schema":{"type":"integer"}},{"name":"Take","in":"query","required":false,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}}},"components":{"securitySchemes":{"ApiKeyAuth":{"type":"apiKey","in":"header","name":"x-api-key"}},"schemas":{"RunEnvelope":{"type":"object","required":["project","data","timestamp"],"properties":{"project":{"type":"string","example":"dev-tools:hash"},"data":{},"timestamp":{"type":"string","format":"date-time"}}},"ErrorEnvelope":{"type":"object","properties":{"content":{},"message":{"type":"string"},"errors":{"type":"array","items":{}},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"}}}}}},"responses":{"Error":{"description":"Invalid key, plan gate, rate limit or upstream failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}}}}