{"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/places:ideal-postcodes-co-uk/addresses":{"get":{"operationId":"places_ideal_postcodes_co_uk_addresses","summary":"Extract Addresses","description":"GET /addresses","tags":["places"],"parameters":[{"name":"api_key","in":"query","required":true,"description":"Your API Key. Typically beings `ak_`. Available from your dashboard","schema":{"type":"string","description":"Your API Key. Typically beings `ak_`. Available from your dashboard"}},{"name":"query","in":"query","required":false,"description":"Specifies the address you wish to query. Query can be shortened to `q=`","schema":{"type":"string","description":"Specifies the address you wish to query. Query can be shortened to `q=`"}},{"name":"limit","in":"query","required":false,"description":"Specifies the maximum number of suggestions to retrieve. By default the limit is 10, unless a postcode is queried (then all addresses at…","schema":{"type":"integer","default":10,"description":"Specifies the maximum number of suggestions to retrieve. By default the limit is 10, unless a postcode is queried (then all addresses at…"}},{"name":"page","in":"query","required":false,"description":"0 indexed indicator of the page of results to receive. Virtually all postcode results are returned on page 0. A small number of Multiple…","schema":{"type":"integer","default":0,"description":"0 indexed indicator of the page of results to receive. Virtually all postcode results are returned on page 0. A small number of Multiple…"}},{"name":"filter","in":"query","required":false,"description":"Comma separated whitelist of address elements to return. E.g. `filter=line_1,line_2,line_3` returns only `line_1`, `line_2` and `line_3`…","schema":{"type":"string","description":"Comma separated whitelist of address elements to return. E.g. `filter=line_1,line_2,line_3` returns only `line_1`, `line_2` and `line_3`…"}},{"name":"lon","in":"query","required":false,"description":"Longitude query for reverse geocoding. An accompanying latitude (lat=) query must be submitted for a valid reverse geocode query.","schema":{"type":"number","description":"Longitude query for reverse geocoding. An accompanying latitude (lat=) query must be submitted for a valid reverse geocode query."}},{"name":"lat","in":"query","required":false,"description":"Latitude query for reverse geocoding. An accompanying longitude (lon=) query must be submitted for a valid reverse geocode query.","schema":{"type":"number","description":"Latitude query for reverse geocoding. An accompanying longitude (lon=) query must be submitted for a valid reverse geocode query."}},{"name":"postcode_outward","in":"query","required":false,"description":"Filter by outward code.","schema":{"type":"string","description":"Filter by outward code."}},{"name":"postcode","in":"query","required":false,"description":"Filter by postcode. Can be combined with query to perform a postcode + building number/name search.","schema":{"type":"string","description":"Filter by postcode. Can be combined with query to perform a postcode + building number/name search."}},{"name":"postcode_area","in":"query","required":false,"description":"Filter by postcode. Can be combined with query to perform a postcode + building number/name search.","schema":{"type":"string","description":"Filter by postcode. Can be combined with query to perform a postcode + building number/name search."}},{"name":"postcode_sector","in":"query","required":false,"description":"Filter by postcode sector, the outward code plus first numeric of the inward code.","schema":{"type":"string","description":"Filter by postcode sector, the outward code plus first numeric of the inward code."}},{"name":"post_town","in":"query","required":false,"description":"Filter by town.","schema":{"type":"string","description":"Filter by town."}},{"name":"uprn","in":"query","required":false,"description":"Filters by UPRN. Does not accept comma separated terms. Only a single term is permitted","schema":{"type":"integer","description":"Filters by UPRN. Does not accept comma separated terms. Only a single term is permitted"}},{"name":"country","in":"query","required":false,"description":"Filter by country. Possible values are England, Scotland, Wales, Northern Ireland, Jersey, Guernsey and Isle of Man.","schema":{"type":"string","description":"Filter by country. Possible values are England, Scotland, Wales, Northern Ireland, Jersey, Guernsey and Isle of Man."}},{"name":"postcode_type","in":"query","required":false,"description":"Filter by Postcode Type. Useful for separating organisational and residential addresses","schema":{"type":"string","description":"Filter by Postcode Type. Useful for separating organisational and residential addresses"}},{"name":"su_organisation_indicator","in":"query","required":false,"description":"Filter by Organisation Indicator. Useful for separating organisational and residential addresses","schema":{"type":"string","description":"Filter by Organisation Indicator. Useful for separating organisational and residential addresses"}},{"name":"box","in":"query","required":false,"description":"Restrict search to a geospatial box determined by the \"top-left\" and \"bottom-right\" gelocations. Only one geospatial box can be provided.","schema":{"type":"string","description":"Restrict search to a geospatial box determined by the \"top-left\" and \"bottom-right\" gelocations. Only one geospatial box can be provided."}},{"name":"bias_postcode_outward","in":"query","required":false,"description":"Bias by outward code","schema":{"type":"string","description":"Bias by outward code"}},{"name":"bias_postcode","in":"query","required":false,"description":"Bias by postcode. Can be combined with query to perform a postcode + building number/name search.","schema":{"type":"string","description":"Bias by postcode. Can be combined with query to perform a postcode + building number/name search."}},{"name":"bias_postcode_area","in":"query","required":false,"description":"Bias by postcode area, the first one or two non-numeric characters of a postcode.","schema":{"type":"string","description":"Bias by postcode area, the first one or two non-numeric characters of a postcode."}},{"name":"bias_postcode_sector","in":"query","required":false,"description":"Bias by postcode sector, the outward code plus first numeric of the inward code.","schema":{"type":"string","description":"Bias by postcode sector, the outward code plus first numeric of the inward code."}},{"name":"bias_post_town","in":"query","required":false,"description":"Bias by town.","schema":{"type":"string","description":"Bias by town."}},{"name":"bias_thoroughfare","in":"query","required":false,"description":"Bias by street name.","schema":{"type":"string","description":"Bias by street name."}},{"name":"bias_country","in":"query","required":false,"description":"Bias by country. Possible values are England, Scotland, Wales, Northern Ireland, Jersey, Guernsey and Isle of Man.","schema":{"type":"string","description":"Bias by country. Possible values are England, Scotland, Wales, Northern Ireland, Jersey, Guernsey and Isle of Man."}},{"name":"bias_lonlat","in":"query","required":false,"description":"Bias search to a geospatial circle determined by an origin and radius in meters. Max radius is `50000`. Uses the format…","schema":{"type":"string","description":"Bias search to a geospatial circle determined by an origin and radius in meters. Max radius is `50000`. Uses the format…"}}],"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/places:ideal-postcodes-co-uk/address-autocomplete":{"get":{"operationId":"places_ideal_postcodes_co_uk_address_autocomplete","summary":"Find Address","description":"GET /autocomplete/addresses","tags":["places"],"parameters":[{"name":"api_key","in":"query","required":false,"description":"Your API Key. Typically beings `ak_`. Available from your dashboard","schema":{"type":"string","description":"Your API Key. Typically beings `ak_`. Available from your dashboard"}},{"name":"query","in":"query","required":false,"description":"Specifies the address you wish to query. Query can be shortened to `q=`","schema":{"type":"string","description":"Specifies the address you wish to query. Query can be shortened to `q=`"}},{"name":"context","in":"query","required":false,"description":"Limits search results within a geographical boundary or country.","schema":{"type":"string","description":"Limits search results within a geographical boundary or country."}},{"name":"limit","in":"query","required":false,"description":"Limits number of address suggestions unless a postcode is detected. In this instance entire list of addreses for that postcode is returned.","schema":{"type":"integer","default":10,"description":"Limits number of address suggestions unless a postcode is detected. In this instance entire list of addreses for that postcode is returned."}},{"name":"postcode_outward","in":"query","required":false,"description":"Filter by outward code.","schema":{"type":"string","description":"Filter by outward code."}},{"name":"postcode","in":"query","required":false,"description":"Filter by postcode. Can be combined with query to perform a postcode + building number/name search.","schema":{"type":"string","description":"Filter by postcode. Can be combined with query to perform a postcode + building number/name search."}},{"name":"postcode_area","in":"query","required":false,"description":"Filter by postcode. Can be combined with query to perform a postcode + building number/name search.","schema":{"type":"string","description":"Filter by postcode. Can be combined with query to perform a postcode + building number/name search."}},{"name":"postcode_sector","in":"query","required":false,"description":"Filter by postcode sector, the outward code plus first numeric of the inward code.","schema":{"type":"string","description":"Filter by postcode sector, the outward code plus first numeric of the inward code."}},{"name":"post_town","in":"query","required":false,"description":"Filter by town.","schema":{"type":"string","description":"Filter by town."}},{"name":"uprn","in":"query","required":false,"description":"Filters by UPRN. Does not accept comma separated terms. Only a single term is permitted","schema":{"type":"integer","description":"Filters by UPRN. Does not accept comma separated terms. Only a single term is permitted"}},{"name":"country","in":"query","required":false,"description":"Filter by country. Possible values are England, Scotland, Wales, Northern Ireland, Jersey, Guernsey and Isle of Man.","schema":{"type":"string","description":"Filter by country. Possible values are England, Scotland, Wales, Northern Ireland, Jersey, Guernsey and Isle of Man."}},{"name":"postcode_type","in":"query","required":false,"description":"Filter by Postcode Type. Useful for separating organisational and residential addresses","schema":{"type":"string","description":"Filter by Postcode Type. Useful for separating organisational and residential addresses"}},{"name":"su_organisation_indicator","in":"query","required":false,"description":"Filter by Organisation Indicator. Useful for separating organisational and residential addresses","schema":{"type":"string","description":"Filter by Organisation Indicator. Useful for separating organisational and residential addresses"}},{"name":"box","in":"query","required":false,"description":"Restrict search to a geospatial box determined by the \"top-left\" and \"bottom-right\" gelocations. Only one geospatial box can be provided.","schema":{"type":"string","description":"Restrict search to a geospatial box determined by the \"top-left\" and \"bottom-right\" gelocations. Only one geospatial box can be provided."}},{"name":"bias_postcode_outward","in":"query","required":false,"description":"Bias by outward code","schema":{"type":"string","description":"Bias by outward code"}},{"name":"bias_postcode","in":"query","required":false,"description":"Bias by postcode. Can be combined with query to perform a postcode + building number/name search.","schema":{"type":"string","description":"Bias by postcode. Can be combined with query to perform a postcode + building number/name search."}},{"name":"bias_postcode_area","in":"query","required":false,"description":"Bias by postcode area, the first one or two non-numeric characters of a postcode.","schema":{"type":"string","description":"Bias by postcode area, the first one or two non-numeric characters of a postcode."}},{"name":"bias_postcode_sector","in":"query","required":false,"description":"Bias by postcode sector, the outward code plus first numeric of the inward code.","schema":{"type":"string","description":"Bias by postcode sector, the outward code plus first numeric of the inward code."}},{"name":"bias_post_town","in":"query","required":false,"description":"Bias by town.","schema":{"type":"string","description":"Bias by town."}},{"name":"bias_thoroughfare","in":"query","required":false,"description":"Bias by street name.","schema":{"type":"string","description":"Bias by street name."}},{"name":"bias_country","in":"query","required":false,"description":"Bias by country. Possible values are England, Scotland, Wales, Northern Ireland, Jersey, Guernsey and Isle of Man.","schema":{"type":"string","description":"Bias by country. Possible values are England, Scotland, Wales, Northern Ireland, Jersey, Guernsey and Isle of Man."}},{"name":"bias_lonlat","in":"query","required":false,"description":"Bias search to a geospatial circle determined by an origin and radius in meters. Max radius is `50000`. Uses the format…","schema":{"type":"string","description":"Bias search to a geospatial circle determined by an origin and radius in meters. Max radius is `50000`. Uses the format…"}},{"name":"bias_ip","in":"query","required":false,"description":"Biases search based on approximate geolocation of IP address. Set `bias_ip=true` to enable.","schema":{"type":"string","enum":["true"],"description":"Biases search based on approximate geolocation of IP address. Set `bias_ip=true` to enable."}}],"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/places:ideal-postcodes-co-uk/resolve":{"get":{"operationId":"places_ideal_postcodes_co_uk_resolve","summary":"Resolve Address (GBR)","description":"GET /autocomplete/addresses/{address}/gbr","tags":["places"],"parameters":[{"name":"address","in":"query","required":true,"description":"ID of address suggestion","schema":{"type":"string","description":"ID of address suggestion"}},{"name":"api_key","in":"query","required":false,"description":"Your API Key. Typically beings `ak_`. Available from your dashboard","schema":{"type":"string","description":"Your API Key. Typically beings `ak_`. Available from your dashboard"}}],"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/places:ideal-postcodes-co-uk/resolve-usa":{"get":{"operationId":"places_ideal_postcodes_co_uk_resolve_usa","summary":"Resolve Address (USA)","description":"GET /autocomplete/addresses/{address}/usa","tags":["places"],"parameters":[{"name":"address","in":"query","required":true,"description":"ID of address suggestion","schema":{"type":"string","description":"ID of address suggestion"}},{"name":"api_key","in":"query","required":false,"description":"Your API Key. Typically beings `ak_`. Available from your dashboard","schema":{"type":"string","description":"Your API Key. Typically beings `ak_`. Available from your dashboard"}}],"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/places:ideal-postcodes-co-uk/address-cleanse":{"post":{"operationId":"places_ideal_postcodes_co_uk_address_cleanse","summary":"Cleanse","description":"POST /cleanse/addresses","tags":["places"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["body"],"properties":{"api_key":{"type":"string","description":"Your API Key. Typically beings `ak_`. Available from your dashboard"},"body":{"type":"object","description":"JSON request body"}}}}}},"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":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/places:ideal-postcodes-co-uk/email-validation":{"get":{"operationId":"places_ideal_postcodes_co_uk_email_validation","summary":"Email Validation","description":"GET /emails","tags":["places"],"parameters":[{"name":"api_key","in":"query","required":true,"description":"Your API Key. Typically beings `ak_`. Available from your dashboard","schema":{"type":"string","description":"Your API Key. Typically beings `ak_`. Available from your dashboard"}},{"name":"query","in":"query","required":true,"description":"Specifies the email address to validate","schema":{"type":"string","description":"Specifies the email address to validate"}}],"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/places:ideal-postcodes-co-uk/key-availability":{"get":{"operationId":"places_ideal_postcodes_co_uk_key_availability","summary":"Availability","description":"GET /keys/{key}","tags":["places"],"parameters":[{"name":"key","in":"query","required":true,"description":"Your API Key. Typically beings `ak_`. Available from your dashboard","schema":{"type":"string","description":"Your API Key. Typically beings `ak_`. Available from your dashboard"}}],"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/places:ideal-postcodes-co-uk/list-configs":{"get":{"operationId":"places_ideal_postcodes_co_uk_list_configs","summary":"List","description":"GET /keys/{key}/configs","tags":["places"],"parameters":[{"name":"key","in":"query","required":true,"description":"Your API Key. Typically beings `ak_`. Available from your dashboard","schema":{"type":"string","description":"Your API Key. Typically beings `ak_`. Available from your dashboard"}},{"name":"user_token","in":"query","required":false,"description":"A secret key used for sensitive operations on your account and API Keys. Your user token can be retrieved and managed from your [accounts…","schema":{"type":"string","description":"A secret key used for sensitive operations on your account and API Keys. Your user token can be retrieved and managed from your [accounts…"}}],"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/places:ideal-postcodes-co-uk/create-config":{"post":{"operationId":"places_ideal_postcodes_co_uk_create_config","summary":"Create","description":"POST /keys/{key}/configs","tags":["places"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["key","body"],"properties":{"key":{"type":"string","description":"Your API Key. Typically beings `ak_`. Available from your dashboard"},"user_token":{"type":"string","description":"A secret key used for sensitive operations on your account and API Keys. Your user token can be retrieved and managed from your [accounts…"},"body":{"type":"object","description":"JSON request body"}}}}}},"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":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/places:ideal-postcodes-co-uk/retrieve-config":{"get":{"operationId":"places_ideal_postcodes_co_uk_retrieve_config","summary":"Retrieve","description":"GET /keys/{key}/configs/{config}","tags":["places"],"parameters":[{"name":"key","in":"query","required":true,"description":"Your API Key. Typically beings `ak_`. Available from your dashboard","schema":{"type":"string","description":"Your API Key. Typically beings `ak_`. Available from your dashboard"}},{"name":"config","in":"query","required":true,"description":"User provided configuration object name","schema":{"type":"string","description":"User provided configuration object name"}}],"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/places:ideal-postcodes-co-uk/update-config":{"post":{"operationId":"places_ideal_postcodes_co_uk_update_config","summary":"Update","description":"POST /keys/{key}/configs/{config}","tags":["places"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["key","config","body"],"properties":{"key":{"type":"string","description":"Your API Key. Typically beings `ak_`. Available from your dashboard"},"config":{"type":"string","description":"User provided configuration object name"},"user_token":{"type":"string","description":"A secret key used for sensitive operations on your account and API Keys. Your user token can be retrieved and managed from your [accounts…"},"body":{"type":"object","description":"JSON request body"}}}}}},"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":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/places:ideal-postcodes-co-uk/delete-config":{"post":{"operationId":"places_ideal_postcodes_co_uk_delete_config","summary":"Delete","description":"DELETE /keys/{key}/configs/{config}","tags":["places"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["key","config"],"properties":{"key":{"type":"string","description":"Your API Key. Typically beings `ak_`. Available from your dashboard"},"config":{"type":"string","description":"User provided configuration object name"},"user_token":{"type":"string","description":"A secret key used for sensitive operations on your account and API Keys. Your user token can be retrieved and managed from your [accounts…"}}}}}},"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":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/places:ideal-postcodes-co-uk/key-details":{"get":{"operationId":"places_ideal_postcodes_co_uk_key_details","summary":"Details","description":"GET /keys/{key}/details","tags":["places"],"parameters":[{"name":"key","in":"query","required":true,"description":"Your API Key. Typically beings `ak_`. Available from your dashboard","schema":{"type":"string","description":"Your API Key. Typically beings `ak_`. Available from your dashboard"}},{"name":"user_token","in":"query","required":false,"description":"A secret key used for sensitive operations on your account and API Keys. Your user token can be retrieved and managed from your [accounts…","schema":{"type":"string","description":"A secret key used for sensitive operations on your account and API Keys. Your user token can be retrieved and managed from your [accounts…"}}],"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/places:ideal-postcodes-co-uk/list-licensees":{"get":{"operationId":"places_ideal_postcodes_co_uk_list_licensees","summary":"List","description":"GET /keys/{key}/licensees","tags":["places"],"parameters":[{"name":"key","in":"query","required":true,"description":"Your API Key. Typically beings `ak_`. Available from your dashboard","schema":{"type":"string","description":"Your API Key. Typically beings `ak_`. Available from your dashboard"}},{"name":"starting_after","in":"query","required":false,"description":"Specify ID of the licensee after which you would like to list results","schema":{"type":"integer","description":"Specify ID of the licensee after which you would like to list results"}},{"name":"user_token","in":"query","required":false,"description":"A secret key used for sensitive operations on your account and API Keys. Your user token can be retrieved and managed from your [accounts…","schema":{"type":"string","description":"A secret key used for sensitive operations on your account and API Keys. Your user token can be retrieved and managed from your [accounts…"}},{"name":"limit","in":"query","required":false,"description":"Specify the maximum number of results to return per page. Default and maximum is `100`.","schema":{"type":"integer","default":10,"description":"Specify the maximum number of results to return per page. Default and maximum is `100`."}},{"name":"query","in":"query","required":false,"description":"Filter result by licensee name. Query can be shortened to `q=`","schema":{"type":"string","description":"Filter result by licensee name. Query can be shortened to `q=`"}}],"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/places:ideal-postcodes-co-uk/create-licensee":{"post":{"operationId":"places_ideal_postcodes_co_uk_create_licensee","summary":"Create","description":"POST /keys/{key}/licensees","tags":["places"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["key","body"],"properties":{"key":{"type":"string","description":"Your API Key. Typically beings `ak_`. Available from your dashboard"},"user_token":{"type":"string","description":"A secret key used for sensitive operations on your account and API Keys. Your user token can be retrieved and managed from your [accounts…"},"body":{"type":"object","description":"JSON request body"}}}}}},"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":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/places:ideal-postcodes-co-uk/retrieve-licensee":{"get":{"operationId":"places_ideal_postcodes_co_uk_retrieve_licensee","summary":"Retrieve","description":"GET /keys/{key}/licensees/{licensee}","tags":["places"],"parameters":[{"name":"key","in":"query","required":true,"description":"Your API Key. Typically beings `ak_`. Available from your dashboard","schema":{"type":"string","description":"Your API Key. Typically beings `ak_`. Available from your dashboard"}},{"name":"licensee","in":"query","required":true,"description":"Uniquely identifies a licensee","schema":{"type":"string","description":"Uniquely identifies a licensee"}},{"name":"user_token","in":"query","required":false,"description":"A secret key used for sensitive operations on your account and API Keys. Your user token can be retrieved and managed from your [accounts…","schema":{"type":"string","description":"A secret key used for sensitive operations on your account and API Keys. Your user token can be retrieved and managed from your [accounts…"}}],"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/places:ideal-postcodes-co-uk/update-licensee":{"post":{"operationId":"places_ideal_postcodes_co_uk_update_licensee","summary":"Update","description":"PUT /keys/{key}/licensees/{licensee}","tags":["places"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["key","licensee","body"],"properties":{"key":{"type":"string","description":"Your API Key. Typically beings `ak_`. Available from your dashboard"},"licensee":{"type":"string","description":"Uniquely identifies a licensee"},"user_token":{"type":"string","description":"A secret key used for sensitive operations on your account and API Keys. Your user token can be retrieved and managed from your [accounts…"},"body":{"type":"object","description":"JSON request body"}}}}}},"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":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/places:ideal-postcodes-co-uk/delete-licensee":{"post":{"operationId":"places_ideal_postcodes_co_uk_delete_licensee","summary":"Cancel","description":"DELETE /keys/{key}/licensees/{licensee}","tags":["places"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["key","licensee"],"properties":{"key":{"type":"string","description":"Your API Key. Typically beings `ak_`. Available from your dashboard"},"licensee":{"type":"string","description":"Uniquely identifies a licensee"},"user_token":{"type":"string","description":"A secret key used for sensitive operations on your account and API Keys. Your user token can be retrieved and managed from your [accounts…"}}}}}},"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":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/places:ideal-postcodes-co-uk/key-logs":{"get":{"operationId":"places_ideal_postcodes_co_uk_key_logs","summary":"Logs (CSV)","description":"GET /keys/{key}/lookups","tags":["places"],"parameters":[{"name":"key","in":"query","required":true,"description":"Your API Key. Typically beings `ak_`. Available from your dashboard","schema":{"type":"string","description":"Your API Key. Typically beings `ak_`. Available from your dashboard"}},{"name":"start","in":"query","required":false,"description":"An start date/time in the form of a UNIX Timestamp in milliseconds, e.g. `1418556452651`. If no start time is provided, the start time…","schema":{"type":"integer","description":"An start date/time in the form of a UNIX Timestamp in milliseconds, e.g. `1418556452651`. If no start time is provided, the start time…"}},{"name":"end","in":"query","required":false,"description":"An end date/time in the form of a UNIX Timestamp in milliseconds, e.g. `1418556452651`. If no end time is provided, the current time will…","schema":{"type":"integer","description":"An end date/time in the form of a UNIX Timestamp in milliseconds, e.g. `1418556452651`. If no end time is provided, the current time will…"}},{"name":"licensee","in":"query","required":false,"description":"Sublicensed keys only. This will restrict the analysed dataset to a specific licensee.","schema":{"type":"string","description":"Sublicensed keys only. This will restrict the analysed dataset to a specific licensee."}}],"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/places:ideal-postcodes-co-uk/key-usage":{"get":{"operationId":"places_ideal_postcodes_co_uk_key_usage","summary":"Usage Stats","description":"GET /keys/{key}/usage","tags":["places"],"parameters":[{"name":"key","in":"query","required":true,"description":"Your API Key. Typically beings `ak_`. Available from your dashboard","schema":{"type":"string","description":"Your API Key. Typically beings `ak_`. Available from your dashboard"}},{"name":"start","in":"query","required":false,"description":"A start date/time in the form of a UNIX Timestamp in milliseconds, e.g. `1418556452651`. If no start time is provided, the start time will…","schema":{"type":"integer","description":"A start date/time in the form of a UNIX Timestamp in milliseconds, e.g. `1418556452651`. If no start time is provided, the start time will…"}},{"name":"end","in":"query","required":false,"description":"An end date/time in the form of a UNIX Timestamp in milliseconds, e.g. `1418556452651`. If no end time is provided, the current time will…","schema":{"type":"integer","description":"An end date/time in the form of a UNIX Timestamp in milliseconds, e.g. `1418556452651`. If no end time is provided, the current time will…"}},{"name":"tags","in":"query","required":false,"description":"A comma separated list of tags to query over. Useful if you want to specify the circumstances in which the request was made. If multiple…","schema":{"type":"string","description":"A comma separated list of tags to query over. Useful if you want to specify the circumstances in which the request was made. If multiple…"}},{"name":"licensee","in":"query","required":false,"description":"Sublicensed keys only. This will restrict the analysed dataset to a specific licensee.","schema":{"type":"string","description":"Sublicensed keys only. This will restrict the analysed dataset to a specific licensee."}}],"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/places:ideal-postcodes-co-uk/phone-number-validation":{"get":{"operationId":"places_ideal_postcodes_co_uk_phone_number_validation","summary":"Phone Number Validation","description":"GET /phone_numbers","tags":["places"],"parameters":[{"name":"api_key","in":"query","required":true,"description":"Your API Key. Typically beings `ak_`. Available from your dashboard","schema":{"type":"string","description":"Your API Key. Typically beings `ak_`. Available from your dashboard"}},{"name":"query","in":"query","required":true,"description":"Specifies the phone number to validate. Phone number must include a country code in acceptable format. For instance, UK phone numbers…","schema":{"type":"string","description":"Specifies the phone number to validate. Phone number must include a country code in acceptable format. For instance, UK phone numbers…"}}],"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/places:ideal-postcodes-co-uk/find-place":{"get":{"operationId":"places_ideal_postcodes_co_uk_find_place","summary":"Find Place","description":"GET /places","tags":["places"],"parameters":[{"name":"api_key","in":"query","required":true,"description":"Your API Key. Typically beings `ak_`. Available from your dashboard","schema":{"type":"string","description":"Your API Key. Typically beings `ak_`. Available from your dashboard"}},{"name":"query","in":"query","required":false,"description":"Specifies the place you wish to query. Query can be shortened to `q=`","schema":{"type":"string","description":"Specifies the place you wish to query. Query can be shortened to `q=`"}},{"name":"country_iso","in":"query","required":false,"description":"Filter by country ISO code. Uses 3 letter country code (ISO 3166-1) standard. Filter by multiple countries with a comma separated list.…","schema":{"type":"string","description":"Filter by country ISO code. Uses 3 letter country code (ISO 3166-1) standard. Filter by multiple countries with a comma separated list.…"}},{"name":"bias_country_iso","in":"query","required":false,"description":"Bias by country ISO code. Uses 3 letter country code (ISO 3166-1) standard. Bias by multiple countries with a comma separated list. E.g.…","schema":{"type":"string","description":"Bias by country ISO code. Uses 3 letter country code (ISO 3166-1) standard. Bias by multiple countries with a comma separated list. E.g.…"}},{"name":"bias_lonlat","in":"query","required":false,"description":"Bias search to a geospatial circle determined by an origin and radius in meters. Max radius is `50000`. Uses the format…","schema":{"type":"string","description":"Bias search to a geospatial circle determined by an origin and radius in meters. Max radius is `50000`. Uses the format…"}},{"name":"bias_ip","in":"query","required":false,"description":"Biases search based on approximate geolocation of IP address. Set `bias_ip=true` to enable.","schema":{"type":"string","enum":["true"],"description":"Biases search based on approximate geolocation of IP address. Set `bias_ip=true` to enable."}}],"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/places:ideal-postcodes-co-uk/resolve-place":{"get":{"operationId":"places_ideal_postcodes_co_uk_resolve_place","summary":"Resolve Place","description":"GET /places/${place}","tags":["places"],"parameters":[{"name":"place","in":"query","required":true,"description":"ID of place suggestion","schema":{"type":"string","description":"ID of place suggestion"}},{"name":"api_key","in":"query","required":false,"description":"Your API Key. Typically beings `ak_`. Available from your dashboard","schema":{"type":"string","description":"Your API Key. Typically beings `ak_`. Available from your dashboard"}}],"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/places:ideal-postcodes-co-uk/postcodes":{"get":{"operationId":"places_ideal_postcodes_co_uk_postcodes","summary":"Lookup Postcode","description":"GET /postcodes/{postcode}","tags":["places"],"parameters":[{"name":"postcode","in":"query","required":true,"description":"Postcode to retrieve","schema":{"type":"string","description":"Postcode to retrieve"}},{"name":"api_key","in":"query","required":false,"description":"Your API Key. Typically beings `ak_`. Available from your dashboard","schema":{"type":"string","description":"Your API Key. Typically beings `ak_`. Available from your dashboard"}},{"name":"filter","in":"query","required":false,"description":"Comma separated whitelist of address elements to return. E.g. `filter=line_1,line_2,line_3` returns only `line_1`, `line_2` and `line_3`…","schema":{"type":"string","description":"Comma separated whitelist of address elements to return. E.g. `filter=line_1,line_2,line_3` returns only `line_1`, `line_2` and `line_3`…"}},{"name":"page","in":"query","required":false,"description":"0 indexed indicator of the page of results to receive. Virtually all postcode results are returned on page 0. A small number of Multiple…","schema":{"type":"integer","default":0,"description":"0 indexed indicator of the page of results to receive. Virtually all postcode results are returned on page 0. A small number of Multiple…"}}],"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/places:ideal-postcodes-co-uk/udprn":{"get":{"operationId":"places_ideal_postcodes_co_uk_udprn","summary":"Retrieve by UDPRN","description":"GET /udprn/{udprn}","tags":["places"],"parameters":[{"name":"udprn","in":"query","required":true,"description":"UDPRN to be retrieved","schema":{"type":"string","description":"UDPRN to be retrieved"}},{"name":"api_key","in":"query","required":false,"description":"Your API Key. Typically beings `ak_`. Available from your dashboard","schema":{"type":"string","description":"Your API Key. Typically beings `ak_`. Available from your dashboard"}},{"name":"filter","in":"query","required":false,"description":"Comma separated whitelist of address elements to return. E.g. `filter=line_1,line_2,line_3` returns only `line_1`, `line_2` and `line_3`…","schema":{"type":"string","description":"Comma separated whitelist of address elements to return. E.g. `filter=line_1,line_2,line_3` returns only `line_1`, `line_2` and `line_3`…"}}],"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/places:ideal-postcodes-co-uk/umprn":{"get":{"operationId":"places_ideal_postcodes_co_uk_umprn","summary":"Retrieve by UMPRN","description":"GET /umprn/{umprn}","tags":["places"],"parameters":[{"name":"umprn","in":"query","required":true,"description":"UMPRN to be retrieved","schema":{"type":"string","description":"UMPRN to be retrieved"}},{"name":"api_key","in":"query","required":false,"description":"Your API Key. Typically beings `ak_`. Available from your dashboard","schema":{"type":"string","description":"Your API Key. Typically beings `ak_`. Available from your dashboard"}},{"name":"filter","in":"query","required":false,"description":"Comma separated whitelist of address elements to return. E.g. `filter=line_1,line_2,line_3` returns only `line_1`, `line_2` and `line_3`…","schema":{"type":"string","description":"Comma separated whitelist of address elements to return. E.g. `filter=line_1,line_2,line_3` returns only `line_1`, `line_2` and `line_3`…"}}],"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"}}}}}}}