{"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/cloud:azure-maps-search/search-get-geocoding":{"get":{"operationId":"cloud_azure_maps_search_search_get_geocoding","summary":"Use to get longitude and latitude coordinates of a street address or name of a place.","description":"GET /geocode","tags":["cloud"],"parameters":[{"name":"endpoint","in":"query","required":false,"description":"The Azure Maps service hostname. Use `https://atlas.microsoft.com` for the Azure public cloud. To target a specific Azure Maps geography…","schema":{"type":"string","default":"https://atlas.microsoft.com","description":"The Azure Maps service hostname. Use `https://atlas.microsoft.com` for the Azure public cloud. To target a specific Azure Maps geography…"}},{"name":"api-version","in":"query","required":false,"description":"The API version to use for this operation.","schema":{"type":"string","default":"2026-01-01","description":"The API version to use for this operation."}},{"name":"Accept-Language","in":"query","required":false,"description":"Language in which search results should be returned. Please refer to [Supported…","schema":{"type":"string","description":"Language in which search results should be returned. Please refer to [Supported…"}},{"name":"top","in":"query","required":false,"description":"Maximum number of responses that will be returned. Default: 5, minimum: 1 and maximum: 20.","schema":{"type":"integer","default":5,"description":"Maximum number of responses that will be returned. Default: 5, minimum: 1 and maximum: 20."}},{"name":"query","in":"query","required":false,"description":"A string that contains information about a location, such as an address or landmark name.","schema":{"type":"string","description":"A string that contains information about a location, such as an address or landmark name."}},{"name":"addressLine","in":"query","required":false,"description":"The official street line of an address relative to the area, as specified by the locality, or postalCode, properties. Typical use of this…","schema":{"type":"string","description":"The official street line of an address relative to the area, as specified by the locality, or postalCode, properties. Typical use of this…"}},{"name":"countryRegion","in":"query","required":false,"description":"Signal for the geocoding result to an [ISO 3166-1 Alpha-2 region/country code](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) that is…","schema":{"type":"string","description":"Signal for the geocoding result to an [ISO 3166-1 Alpha-2 region/country code](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) that is…"}},{"name":"bbox","in":"query","required":false,"description":"A rectangular area on the earth defined as a bounding box object. The sides of the rectangle are defined by longitude and latitude values.…","schema":{"type":"array","description":"A rectangular area on the earth defined as a bounding box object. The sides of the rectangle are defined by longitude and latitude values.…"}},{"name":"view","in":"query","required":false,"description":"A string that represents an [ISO 3166-1 Alpha-2 region/country code](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2). This will alter…","schema":{"type":"string","description":"A string that represents an [ISO 3166-1 Alpha-2 region/country code](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2). This will alter…"}},{"name":"coordinates","in":"query","required":false,"description":"A point on the earth specified as a longitude and latitude. When you specify this parameter, the user's location is taken into account and…","schema":{"type":"array","description":"A point on the earth specified as a longitude and latitude. When you specify this parameter, the user's location is taken into account and…"}},{"name":"adminDistrict","in":"query","required":false,"description":"The country subdivision portion of an address, such as WA. This parameter should not be used when the `query` parameter is included in the…","schema":{"type":"string","description":"The country subdivision portion of an address, such as WA. This parameter should not be used when the `query` parameter is included in the…"}},{"name":"adminDistrict2","in":"query","required":false,"description":"The county for the structured address, such as King. This parameter should not be used when the `query` parameter is included in the…","schema":{"type":"string","description":"The county for the structured address, such as King. This parameter should not be used when the `query` parameter is included in the…"}},{"name":"adminDistrict3","in":"query","required":false,"description":"The named area for the structured address. This parameter should not be used when the `query` parameter is included in the request.","schema":{"type":"string","description":"The named area for the structured address. This parameter should not be used when the `query` parameter is included in the request."}},{"name":"locality","in":"query","required":false,"description":"The locality portion of an address, such as Seattle. This parameter should not be used when the `query` parameter is included in the…","schema":{"type":"string","description":"The locality portion of an address, such as Seattle. This parameter should not be used when the `query` parameter is included in the…"}},{"name":"postalCode","in":"query","required":false,"description":"The postal code portion of an address. This parameter should not be used when the `query` parameter is included in the request.","schema":{"type":"string","description":"The postal code portion of an address. This parameter should not be used when the `query` parameter is included in the request."}},{"name":"x-ms-client-id","in":"query","required":false,"description":"Specifies which account is intended for usage in conjunction with the Azure AD security model. It represents a unique ID for the Azure…","schema":{"type":"string","description":"Specifies which account is intended for usage in conjunction with the Azure AD security model. It represents a unique ID for the Azure…"}}],"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":"byok"}},"/v1/cloud:azure-maps-search/search-get-geocode-autocomplete":{"get":{"operationId":"cloud_azure_maps_search_search_get_geocode_autocomplete","summary":"Use to get ranked list of suggested entities based on a user's location and a partial query.","description":"GET /geocode:autocomplete","tags":["cloud"],"parameters":[{"name":"endpoint","in":"query","required":false,"description":"The Azure Maps service hostname. Use `https://atlas.microsoft.com` for the Azure public cloud. To target a specific Azure Maps geography…","schema":{"type":"string","default":"https://atlas.microsoft.com","description":"The Azure Maps service hostname. Use `https://atlas.microsoft.com` for the Azure public cloud. To target a specific Azure Maps geography…"}},{"name":"api-version","in":"query","required":false,"description":"The API version to use for this operation.","schema":{"type":"string","default":"2026-01-01","description":"The API version to use for this operation."}},{"name":"x-ms-client-id","in":"query","required":false,"description":"Specifies which account is intended for usage in conjunction with the Azure AD security model. It represents a unique ID for the Azure…","schema":{"type":"string","description":"Specifies which account is intended for usage in conjunction with the Azure AD security model. It represents a unique ID for the Azure…"}},{"name":"Accept-Language","in":"query","required":false,"description":"Language in which search results should be returned. Please refer to [Supported…","schema":{"type":"string","description":"Language in which search results should be returned. Please refer to [Supported…"}},{"name":"query","in":"query","required":true,"description":"Required. The user's query prefix. Example: \"1 Micro\" or \"Muir Woods\".","schema":{"type":"string","description":"Required. The user's query prefix. Example: \"1 Micro\" or \"Muir Woods\"."}},{"name":"coordinates","in":"query","required":false,"description":"Required when `bbox` is not provided. A point on the earth specified as a longitude and latitude. When you specify this parameter, the…","schema":{"type":"array","description":"Required when `bbox` is not provided. A point on the earth specified as a longitude and latitude. When you specify this parameter, the…"}},{"name":"bbox","in":"query","required":false,"description":"Required when `coordinates` is not provided. A rectangular area on the earth defined as a bounding box object. The sides of the rectangle…","schema":{"type":"array","description":"Required when `coordinates` is not provided. A rectangular area on the earth defined as a bounding box object. The sides of the rectangle…"}},{"name":"top","in":"query","required":false,"description":"Maximum number of responses that will be returned. Default: 5, minimum: 1 and maximum: 20.","schema":{"type":"integer","default":5,"description":"Maximum number of responses that will be returned. Default: 5, minimum: 1 and maximum: 20."}},{"name":"resultTypeGroups","in":"query","required":false,"description":"A comma separated list of returned entity type groups. The possible values are - Address - Place","schema":{"type":"array","description":"A comma separated list of returned entity type groups. The possible values are - Address - Place"}},{"name":"resultTypes","in":"query","required":false,"description":"A comma separated list of returned entity types. When type group is set to Address, the supported types are: - Address - RoadBlock All…","schema":{"type":"array","description":"A comma separated list of returned entity types. When type group is set to Address, the supported types are: - Address - RoadBlock All…"}},{"name":"view","in":"query","required":false,"description":"A string that represents an [ISO 3166-1 Alpha-2 region/country code](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2). This will alter…","schema":{"type":"string","description":"A string that represents an [ISO 3166-1 Alpha-2 region/country code](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2). This will alter…"}},{"name":"countryRegion","in":"query","required":false,"description":"Signal for the autocomplete result to an [ISO 3166-1 Alpha-2 region/country code](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) that…","schema":{"type":"string","default":"none","description":"Signal for the autocomplete result to an [ISO 3166-1 Alpha-2 region/country code](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) that…"}}],"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":"byok"}},"/v1/cloud:azure-maps-search/search-get-geocoding-batch":{"post":{"operationId":"cloud_azure_maps_search_search_get_geocoding_batch","summary":"Use to send a batch of queries to the [Geocoding](/rest/api/maps/search/get-geocoding) API in a single…","description":"POST /geocode:batch","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["body"],"properties":{"endpoint":{"type":"string","default":"https://atlas.microsoft.com","description":"The Azure Maps service hostname. Use `https://atlas.microsoft.com` for the Azure public cloud. To target a specific Azure Maps geography…"},"api-version":{"type":"string","default":"2026-01-01","description":"The API version to use for this operation."},"x-ms-client-id":{"type":"string","description":"Specifies which account is intended for usage in conjunction with the Azure AD security model. It represents a unique ID for the Azure…"},"Accept-Language":{"type":"string","description":"Language in which search results should be returned. Please refer to [Supported…"},"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":"byok"}},"/v1/cloud:azure-maps-search/search-get-reverse-geocoding":{"get":{"operationId":"cloud_azure_maps_search_search_get_reverse_geocoding","summary":"Use to get a street address and location info from longitude and latitude coordinates.","description":"GET /reverseGeocode","tags":["cloud"],"parameters":[{"name":"endpoint","in":"query","required":false,"description":"The Azure Maps service hostname. Use `https://atlas.microsoft.com` for the Azure public cloud. To target a specific Azure Maps geography…","schema":{"type":"string","default":"https://atlas.microsoft.com","description":"The Azure Maps service hostname. Use `https://atlas.microsoft.com` for the Azure public cloud. To target a specific Azure Maps geography…"}},{"name":"api-version","in":"query","required":false,"description":"The API version to use for this operation.","schema":{"type":"string","default":"2026-01-01","description":"The API version to use for this operation."}},{"name":"x-ms-client-id","in":"query","required":false,"description":"Specifies which account is intended for usage in conjunction with the Azure AD security model. It represents a unique ID for the Azure…","schema":{"type":"string","description":"Specifies which account is intended for usage in conjunction with the Azure AD security model. It represents a unique ID for the Azure…"}},{"name":"Accept-Language","in":"query","required":false,"description":"Language in which search results should be returned. Please refer to [Supported…","schema":{"type":"string","description":"Language in which search results should be returned. Please refer to [Supported…"}},{"name":"coordinates","in":"query","required":true,"description":"The coordinates of the location that you want to reverse geocode. Example: &coordinates=lon,lat","schema":{"type":"array","description":"The coordinates of the location that you want to reverse geocode. Example: &coordinates=lon,lat"}},{"name":"resultTypes","in":"query","required":false,"description":"Specify entity types that you want in the response. Only the types you specify will be returned. If the point cannot be mapped to the…","schema":{"type":"array","description":"Specify entity types that you want in the response. Only the types you specify will be returned. If the point cannot be mapped to the…"}},{"name":"view","in":"query","required":false,"description":"A string that represents an [ISO 3166-1 Alpha-2 region/country code](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2). This will alter…","schema":{"type":"string","description":"A string that represents an [ISO 3166-1 Alpha-2 region/country code](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2). This will alter…"}}],"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":"byok"}},"/v1/cloud:azure-maps-search/search-get-reverse-geocoding-batch":{"post":{"operationId":"cloud_azure_maps_search_search_get_reverse_geocoding_batch","summary":"Use to send a batch of queries to the [Reverse Geocoding](/rest/api/maps/search/get-reverse-geocoding) API…","description":"POST /reverseGeocode:batch","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["body"],"properties":{"endpoint":{"type":"string","default":"https://atlas.microsoft.com","description":"The Azure Maps service hostname. Use `https://atlas.microsoft.com` for the Azure public cloud. To target a specific Azure Maps geography…"},"api-version":{"type":"string","default":"2026-01-01","description":"The API version to use for this operation."},"x-ms-client-id":{"type":"string","description":"Specifies which account is intended for usage in conjunction with the Azure AD security model. It represents a unique ID for the Azure…"},"Accept-Language":{"type":"string","description":"Language in which search results should be returned. Please refer to [Supported…"},"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":"byok"}},"/v1/cloud:azure-maps-search/search-get-polygon":{"get":{"operationId":"cloud_azure_maps_search_search_get_polygon","summary":"Use to get polygon data of a geographical area shape such as a city or a country region.","description":"GET /search/polygon","tags":["cloud"],"parameters":[{"name":"endpoint","in":"query","required":false,"description":"The Azure Maps service hostname. Use `https://atlas.microsoft.com` for the Azure public cloud. To target a specific Azure Maps geography…","schema":{"type":"string","default":"https://atlas.microsoft.com","description":"The Azure Maps service hostname. Use `https://atlas.microsoft.com` for the Azure public cloud. To target a specific Azure Maps geography…"}},{"name":"api-version","in":"query","required":false,"description":"The API version to use for this operation.","schema":{"type":"string","default":"2026-01-01","description":"The API version to use for this operation."}},{"name":"x-ms-client-id","in":"query","required":false,"description":"Specifies which account is intended for usage in conjunction with the Azure AD security model. It represents a unique ID for the Azure…","schema":{"type":"string","description":"Specifies which account is intended for usage in conjunction with the Azure AD security model. It represents a unique ID for the Azure…"}},{"name":"Accept-Language","in":"query","required":false,"description":"Language in which search results should be returned. Please refer to [Supported…","schema":{"type":"string","description":"Language in which search results should be returned. Please refer to [Supported…"}},{"name":"coordinates","in":"query","required":true,"description":"A point on the earth specified as a longitude and latitude. Example: &coordinates=lon,lat","schema":{"type":"array","description":"A point on the earth specified as a longitude and latitude. Example: &coordinates=lon,lat"}},{"name":"view","in":"query","required":false,"description":"A string that represents an [ISO 3166-1 Alpha-2 region/country code](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2). This will alter…","schema":{"type":"string","description":"A string that represents an [ISO 3166-1 Alpha-2 region/country code](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2). This will alter…"}},{"name":"resultType","in":"query","required":false,"description":"The geopolitical concept to return a boundary for. If not specified, the default is `countryRegion` result type.","schema":{"type":"string","enum":["countryRegion","adminDistrict","adminDistrict2","postalCode","postalCode2","postalCode3","postalCode4","neighborhood","locality"],"default":"countryRegion","description":"The geopolitical concept to return a boundary for. If not specified, the default is `countryRegion` result type."}},{"name":"resolution","in":"query","required":false,"description":"Resolution determines the amount of points to send back. If not specified, the default is medium resolution.","schema":{"type":"string","enum":["small","medium","large","huge"],"default":"medium","description":"Resolution determines the amount of points to send back. If not specified, the default is medium resolution."}}],"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":"byok"}}},"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"}}}}}}}