{"openapi":"3.1.0","info":{"title":"Apizie","version":"2.0.0","description":"One API key, one envelope, many public data sources."},"servers":[{"url":"https://apizie.tech"}],"security":[{"ApiKeyAuth":[]}],"paths":{"/v1/places:postcodes-io/lookup":{"get":{"operationId":"places_postcodes_io_lookup","summary":"Look up a postcode","description":"Location and administrative areas for a UK postcode.","tags":["places"],"parameters":[{"name":"postcode","in":"query","required":true,"schema":{"type":"string"},"example":"SW1A 1AA"}],"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":86400,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/places:postcodes-io/validate":{"get":{"operationId":"places_postcodes_io_validate","summary":"Validate a postcode","description":"Whether a UK postcode exists.","tags":["places"],"parameters":[{"name":"postcode","in":"query","required":true,"schema":{"type":"string"},"example":"SW1A 1AA"}],"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":86400,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/places:postcodes-io/reverse":{"get":{"operationId":"places_postcodes_io_reverse","summary":"Nearest postcodes","description":"Postcodes nearest to a coordinate.","tags":["places"],"parameters":[{"name":"lat","in":"query","required":true,"schema":{"type":"number"},"example":51.501},{"name":"lon","in":"query","required":true,"schema":{"type":"number"},"example":-0.1416},{"name":"limit","in":"query","required":false,"description":"Number of results","schema":{"type":"integer","default":10,"minimum":1,"maximum":100,"description":"Number of results"}}],"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":86400,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/places:postcodes-io/autocomplete":{"get":{"operationId":"places_postcodes_io_autocomplete","summary":"Autocomplete","description":"Postcodes starting with a partial input.","tags":["places"],"parameters":[{"name":"partial","in":"query","required":true,"schema":{"type":"string"},"example":"SW1A"},{"name":"limit","in":"query","required":false,"description":"Number of results","schema":{"type":"integer","default":10,"minimum":1,"maximum":100,"description":"Number of results"}}],"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":86400,"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"}}}}}}}