{"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/transport:departureboard/get-arrivals-and-departures-by-crs":{"get":{"operationId":"transport_departureboard_get_arrivals_and_departures_by_crs","summary":"getArrivalsAndDeparturesByCRS is used to get a list of services arriving to and departing from a UK train…","description":"GET /getArrivalsAndDeparturesByCRS/{CRS}","tags":["transport"],"parameters":[{"name":"CRS","in":"query","required":true,"description":"The CRS (Computer Reservation System) for the Station you wish to get departure and arrival information for, e.g. KGX for London Kings…","schema":{"type":"string","description":"The CRS (Computer Reservation System) for the Station you wish to get departure and arrival information for, e.g. KGX for London Kings…"}},{"name":"apiKey","in":"query","required":true,"description":"The National Rail OpenLDBWS API Key to use for looking up service information. You must register with National Rail to obtain this key and…","schema":{"type":"string","description":"The National Rail OpenLDBWS API Key to use for looking up service information. You must register with National Rail to obtain this key and…"}},{"name":"numServices","in":"query","required":false,"description":"The number of arriving and departing services to return. This is a maximum value, less may be returned if there is not a sufficient amount…","schema":{"type":"integer","default":10,"description":"The number of arriving and departing services to return. This is a maximum value, less may be returned if there is not a sufficient amount…"}},{"name":"timeOffset","in":"query","required":false,"description":"The time window in minutes to offset the arrival and departure information by. For example, a value of 20 will not show services arriving…","schema":{"type":"integer","default":0,"description":"The time window in minutes to offset the arrival and departure information by. For example, a value of 20 will not show services arriving…"}},{"name":"timeWindow","in":"query","required":false,"description":"The time window in minutes to offset the arrival and departure information by. For example, a value of 20 will not show services arriving…","schema":{"type":"integer","default":120,"description":"The time window in minutes to offset the arrival and departure information by. For example, a value of 20 will not show services arriving…"}},{"name":"serviceDetails","in":"query","required":false,"description":"Should the response contain information on the calling points for each service? If set to false, calling points will not be returned.","schema":{"type":"boolean","default":true,"description":"Should the response contain information on the calling points for each service? If set to false, calling points will not be returned."}},{"name":"filterStation","in":"query","required":false,"description":"The CRS (Computer Reservation System) code to filter the results by. When setting this you must also set the filterType parameter. For…","schema":{"type":"string","description":"The CRS (Computer Reservation System) code to filter the results by. When setting this you must also set the filterType parameter. For…"}},{"name":"filterType","in":"query","required":false,"description":"Determines if the filterStation parameter should be applied for services arriving to, or leaving from the selected station. Required if…","schema":{"type":"string","description":"Determines if the filterStation parameter should be applied for services arriving to, or leaving from the selected station. Required if…"}}],"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/transport:departureboard/get-arrivals-by-crs":{"get":{"operationId":"transport_departureboard_get_arrivals_by_crs","summary":"getArrivalsByCRS is used to get a list of services arriving to a UK train station by the CRS (Computer…","description":"GET /getArrivalsByCRS/{CRS}","tags":["transport"],"parameters":[{"name":"CRS","in":"query","required":true,"description":"The CRS (Computer Reservation System) for the Station you wish to get arrival information for, e.g. KGX for London Kings Cross.","schema":{"type":"string","description":"The CRS (Computer Reservation System) for the Station you wish to get arrival information for, e.g. KGX for London Kings Cross."}},{"name":"apiKey","in":"query","required":true,"description":"The National Rail OpenLDBWS API Key to use for looking up service information. You must register with National Rail to obtain this key and…","schema":{"type":"string","description":"The National Rail OpenLDBWS API Key to use for looking up service information. You must register with National Rail to obtain this key and…"}},{"name":"numServices","in":"query","required":false,"description":"The number of arriving train services to return. This is a maximum value, less may be returned if there is not a sufficient amount of…","schema":{"type":"integer","default":10,"description":"The number of arriving train services to return. This is a maximum value, less may be returned if there is not a sufficient amount of…"}},{"name":"timeOffset","in":"query","required":false,"description":"The time window in minutes to offset the arrival information by. For example, a value of 20 will not show services arriving within the…","schema":{"type":"integer","default":0,"description":"The time window in minutes to offset the arrival information by. For example, a value of 20 will not show services arriving within the…"}},{"name":"timeWindow","in":"query","required":false,"description":"The time window to show train services for in minutes. For example, a value of 60 will show services arriving to the station in the next…","schema":{"type":"integer","default":120,"description":"The time window to show train services for in minutes. For example, a value of 60 will show services arriving to the station in the next…"}},{"name":"serviceDetails","in":"query","required":false,"description":"Should the response contain information on the calling points for each service? If set to false, calling points will not be returned.","schema":{"type":"boolean","default":true,"description":"Should the response contain information on the calling points for each service? If set to false, calling points will not be returned."}},{"name":"filterStation","in":"query","required":false,"description":"The CRS (Computer Reservation System) code to filter the results by. For example, performing a lookup for PAD (London Paddington) and…","schema":{"type":"string","description":"The CRS (Computer Reservation System) code to filter the results by. For example, performing a lookup for PAD (London Paddington) and…"}}],"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/transport:departureboard/get-departures-by-crs":{"get":{"operationId":"transport_departureboard_get_departures_by_crs","summary":"getDeparturesByCRS is used to get a list of services departing from a UK train station by the CRS (Computer…","description":"GET /getDeparturesByCRS/{CRS}","tags":["transport"],"parameters":[{"name":"CRS","in":"query","required":true,"description":"The CRS (Computer Reservation System) for the station you wish to get departure information for, e.g. KGX for London Kings Cross.","schema":{"type":"string","description":"The CRS (Computer Reservation System) for the station you wish to get departure information for, e.g. KGX for London Kings Cross."}},{"name":"apiKey","in":"query","required":true,"description":"The National Rail OpenLDBWS API Key to use for looking up service information. You must register with National Rail to obtain this key and…","schema":{"type":"string","description":"The National Rail OpenLDBWS API Key to use for looking up service information. You must register with National Rail to obtain this key and…"}},{"name":"numServices","in":"query","required":false,"description":"The number of departing services to return. This is a maximum value, less may be returned if there is not a sufficient amount of services…","schema":{"type":"integer","default":10,"description":"The number of departing services to return. This is a maximum value, less may be returned if there is not a sufficient amount of services…"}},{"name":"timeOffset","in":"query","required":false,"description":"The time window in minutes to offset the departure information by. For example, a value of 20 will not show services departing within the…","schema":{"type":"integer","default":0,"description":"The time window in minutes to offset the departure information by. For example, a value of 20 will not show services departing within the…"}},{"name":"timeWindow","in":"query","required":false,"description":"The time window to show services for in minutes. For example, a value of 60 will show services departing the station in the next 60 minutes.","schema":{"type":"integer","default":120,"description":"The time window to show services for in minutes. For example, a value of 60 will show services departing the station in the next 60 minutes."}},{"name":"serviceDetails","in":"query","required":false,"description":"Should the response contain information on the calling points for each service? If set to false, calling points will not be returned.","schema":{"type":"boolean","default":true,"description":"Should the response contain information on the calling points for each service? If set to false, calling points will not be returned."}},{"name":"filterStation","in":"query","required":false,"description":"The CRS (Computer Reservation System) code to filter the results by. For example, performing a lookup for PAD (London Paddington) and…","schema":{"type":"string","description":"The CRS (Computer Reservation System) code to filter the results by. For example, performing a lookup for PAD (London Paddington) and…"}}],"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/transport:departureboard/get-fastest-departures-by-crs":{"get":{"operationId":"transport_departureboard_get_fastest_departures_by_crs","summary":"getFastestDeparturesByCRS is used to get the fastest next service running between two stations. Multiple…","description":"GET /getFastestDeparturesByCRS/{CRS}","tags":["transport"],"parameters":[{"name":"CRS","in":"query","required":true,"description":"The CRS (Computer Reservation System) for the station you wish to get departure information for, e.g. KGX for London Kings Cross.","schema":{"type":"string","description":"The CRS (Computer Reservation System) for the station you wish to get departure information for, e.g. KGX for London Kings Cross."}},{"name":"apiKey","in":"query","required":true,"description":"The National Rail OpenLDBWS API Key to use for looking up service information. You must register with National Rail to obtain this key and…","schema":{"type":"string","description":"The National Rail OpenLDBWS API Key to use for looking up service information. You must register with National Rail to obtain this key and…"}},{"name":"filterList","in":"query","required":true,"description":"The CRS (Computer Reservation System) codes to show the fastest departing services to. Up to 20 destination stations can be specified.…","schema":{"type":"string","description":"The CRS (Computer Reservation System) codes to show the fastest departing services to. Up to 20 destination stations can be specified.…"}},{"name":"timeOffset","in":"query","required":false,"description":"The time window in minutes to offset the departure information by. For example, a value of 20 will show the fastest services departing…","schema":{"type":"integer","default":0,"description":"The time window in minutes to offset the departure information by. For example, a value of 20 will show the fastest services departing…"}},{"name":"timeWindow","in":"query","required":false,"description":"The time window to show train services for in minutes. For example, a value of 60 will show the fastest services departing the station in…","schema":{"type":"integer","default":120,"description":"The time window to show train services for in minutes. For example, a value of 60 will show the fastest services departing the station in…"}},{"name":"serviceDetails","in":"query","required":false,"description":"Should the response contain information on the calling points for each service? If set to false, calling points will not be returned.","schema":{"type":"boolean","default":true,"description":"Should the response contain information on the calling points for each service? If set to false, calling points will not be returned."}}],"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/transport:departureboard/get-next-departures-by-crs":{"get":{"operationId":"transport_departureboard_get_next_departures_by_crs","summary":"getNextDeparturesByCRS is used to get the next service running between two stations. Multiple destinations…","description":"GET /getNextDeparturesByCRS/{CRS}","tags":["transport"],"parameters":[{"name":"CRS","in":"query","required":true,"description":"The CRS (Computer Reservation System) for the station you wish to get departure information for, e.g. KGX for London Kings Cross.","schema":{"type":"string","description":"The CRS (Computer Reservation System) for the station you wish to get departure information for, e.g. KGX for London Kings Cross."}},{"name":"apiKey","in":"query","required":true,"description":"The National Rail OpenLDBWS API Key to use for looking up service information. You must register with National Rail to obtain this key and…","schema":{"type":"string","description":"The National Rail OpenLDBWS API Key to use for looking up service information. You must register with National Rail to obtain this key and…"}},{"name":"filterList","in":"query","required":true,"description":"The CRS (Computer Reservation System) codes to show departing services to. Up to 20 destination stations can be specified. These should be…","schema":{"type":"string","description":"The CRS (Computer Reservation System) codes to show departing services to. Up to 20 destination stations can be specified. These should be…"}},{"name":"timeOffset","in":"query","required":false,"description":"The time window in minutes to offset the arrival and departure information by. For example, a value of 20 will not show services arriving…","schema":{"type":"integer","default":0,"description":"The time window in minutes to offset the arrival and departure information by. For example, a value of 20 will not show services arriving…"}},{"name":"timeWindow","in":"query","required":false,"description":"The time window in minutes to offset the arrival and departure information by. For example, a value of 20 will not show services arriving…","schema":{"type":"integer","default":120,"description":"The time window in minutes to offset the arrival and departure information by. For example, a value of 20 will not show services arriving…"}},{"name":"serviceDetails","in":"query","required":false,"description":"Should the response contain information on the calling points for each service? If set to false, calling points will not be returned.","schema":{"type":"boolean","default":true,"description":"Should the response contain information on the calling points for each service? If set to false, calling points will not be returned."}}],"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/transport:departureboard/get-service-details-by-id":{"get":{"operationId":"transport_departureboard_get_service_details_by_id","summary":"getServiceDetailsByID is used to get information on a service, by the Service ID. This will typically return…","description":"GET /getServiceDetailsByID/{serviceID}","tags":["transport"],"parameters":[{"name":"serviceID","in":"query","required":true,"description":"The Service ID for the Train Service you wish to look up in the URL Safe format. For example \"qsec4O8LW7k8ITcOt_ir4Q--\".","schema":{"type":"string","description":"The Service ID for the Train Service you wish to look up in the URL Safe format. For example \"qsec4O8LW7k8ITcOt_ir4Q--\"."}},{"name":"apiKey","in":"query","required":true,"description":"The National Rail OpenLDBWS API Key to use for looking up service information. You must register with National Rail to obtain this key and…","schema":{"type":"string","description":"The National Rail OpenLDBWS API Key to use for looking up service information. You must register with National Rail to obtain this key and…"}}],"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"}}}}}}}