Datasets:
davidfant
/
rapidapi-example-responses

Dataset card Data Studio Files Community
1
id
stringlengths
53
86
api_name
stringlengths
2
76
api_description
stringlengths
1
500
⌀
api_score
float64
0
10
⌀
endpoint_name
stringlengths
1
190
endpoint_description
stringlengths
0
500
response_status_code
int64
100
505
response_summary
stringlengths
1
68
⌀
response_json
stringlengths
6
50k
response_json_schema
stringlengths
14
150k
975b58f7-85ea-4e68-b0ce-868ac028542a/f3351362-cc43-4a44-b8e3-6c0d6e818919/0/0
Woosmap
Location-based Search Platform
7
updateStores
Used to update assets in batch. storeId must exists when using PUT method, if one asset does not exists, the batch will be refused.
401
null
{"detail": "Incorrect authentication credentials. Please check or use a valid API Key"}
{"title": "Error401", "type": "object", "description": "Authentication credentials are incorrect", "properties": {"detail": {"description": "Details for the credentials error", "type": "string"}}}
975b58f7-85ea-4e68-b0ce-868ac028542a/f3351362-cc43-4a44-b8e3-6c0d6e818919/1/0
Woosmap
Location-based Search Platform
7
updateStores
Used to update assets in batch. storeId must exists when using PUT method, if one asset does not exists, the batch will be refused.
400
null
{"status": "error", "value": "The request is invalid, the data is not a valid JSON."}
{"title": "Error400", "type": "object", "description": "The request is invalid", "properties": {"status": {"type": "string", "description": "the status of the request"}, "value": {"description": "the value of request", "type": "string"}}}
975b58f7-85ea-4e68-b0ce-868ac028542a/f3351362-cc43-4a44-b8e3-6c0d6e818919/2/0
Woosmap
Location-based Search Platform
7
updateStores
Used to update assets in batch. storeId must exists when using PUT method, if one asset does not exists, the batch will be refused.
403
null
{"detail": "This Woosmap API is not enabled for this project."}
{"title": "Error403", "type": "object", "description": "API Request is authenticated but API Key don't have permission to access the resources", "properties": {"detail": {"description": "Details for the forbidden error message", "type": "string"}}}
975b58f7-85ea-4e68-b0ce-868ac028542a/f3351362-cc43-4a44-b8e3-6c0d6e818919/3/0
Woosmap
Location-based Search Platform
7
updateStores
Used to update assets in batch. storeId must exists when using PUT method, if one asset does not exists, the batch will be refused.
200
null
{"status": "success", "value": "1 stores"}
{"title": "Success", "type": "object", "description": "Message returned to a success request", "properties": {"status": {"type": "string", "description": "the status of the request"}, "value": {"description": "the value of request", "oneOf": [{"type": "string"}, {"type": "integer"}]}}}
975b58f7-85ea-4e68-b0ce-868ac028542a/c69e7900-ffff-49e5-89a6-80ee311ccbb5/0/0
Woosmap
Location-based Search Platform
7
createStores
Used to batch create Assets to a specific project identified with the private_key parameter.
400
null
{"status": "error", "value": "The request is invalid, the data is not a valid JSON."}
{"title": "Error400", "type": "object", "description": "The request is invalid", "properties": {"status": {"type": "string", "description": "the status of the request"}, "value": {"description": "the value of request", "type": "string"}}}
975b58f7-85ea-4e68-b0ce-868ac028542a/c69e7900-ffff-49e5-89a6-80ee311ccbb5/1/0
Woosmap
Location-based Search Platform
7
createStores
Used to batch create Assets to a specific project identified with the private_key parameter.
200
null
{"status": "success", "value": "2 stores"}
{"title": "Success", "type": "object", "description": "Message returned to a success request", "properties": {"status": {"type": "string", "description": "the status of the request"}, "value": {"description": "the value of request", "oneOf": [{"type": "string"}, {"type": "integer"}]}}}
975b58f7-85ea-4e68-b0ce-868ac028542a/c69e7900-ffff-49e5-89a6-80ee311ccbb5/2/0
Woosmap
Location-based Search Platform
7
createStores
Used to batch create Assets to a specific project identified with the private_key parameter.
403
null
{"detail": "This Woosmap API is not enabled for this project."}
{"title": "Error403", "type": "object", "description": "API Request is authenticated but API Key don't have permission to access the resources", "properties": {"detail": {"description": "Details for the forbidden error message", "type": "string"}}}
975b58f7-85ea-4e68-b0ce-868ac028542a/c69e7900-ffff-49e5-89a6-80ee311ccbb5/3/0
Woosmap
Location-based Search Platform
7
createStores
Used to batch create Assets to a specific project identified with the private_key parameter.
401
null
{"detail": "Incorrect authentication credentials. Please check or use a valid API Key"}
{"title": "Error401", "type": "object", "description": "Authentication credentials are incorrect", "properties": {"detail": {"description": "Details for the credentials error", "type": "string"}}}
975b58f7-85ea-4e68-b0ce-868ac028542a/76c6ffc3-1046-4221-9b26-b9f77421f725/0/0
Woosmap
Location-based Search Platform
7
localitiesAutocomplete
Autocomplete on worldwide suggestions for a for text-based geographic searches. It can match on full words as well as substrings. You can therefore send queries as the user types, to provide on-the-fly city names, postal codes or suburb name suggestions.
200
null
{"localities": [{"public_id": "Ch6qA8cLmvyvEEoFy6nYeFcEdNU=", "description": "London, City of London, United Kingdom", "name": "London", "type": "locality", "location": {"lat": 51.50732, "lng": -0.12764746}, "matched_substrings": {"name": [{"offset": 0, "length": 4}], "admin_1": [{"offset": 8, "length": 4}], "description": [{"offset": 0, "length": 4}, {"offset": 16, "length": 4}]}, "admin_1": "City of London", "locality": "", "admin_0": "United Kingdom"}, {"public_id": "m/T2C4YI2LgszkKXrELBC+9dfC8=", "description": "Londonderry/Derry, Derry City and Strabane, United Kingdom", "name": "Londonderry/Derry", "type": "locality", "location": {"lat": 54.997868, "lng": -7.3213058}, "matched_substrings": {"name": [{"offset": 0, "length": 4}], "description": [{"offset": 0, "length": 4}]}, "admin_1": "Derry City and Strabane", "locality": "", "admin_0": "United Kingdom"}, {"public_id": "VOBREUi72/VtnsYgE6aI8HNYcxg=", "description": "Londesborough, East Riding of Yorkshire, United Kingdom", "name": "Londesborough", "type": "locality", "location": {"lat": 53.898506, "lng": -0.6805281}, "matched_substrings": {"name": [{"offset": 0, "length": 4}], "description": [{"offset": 0, "length": 4}]}, "admin_1": "East Riding of Yorkshire", "locality": "", "admin_0": "United Kingdom"}, {"public_id": "Js0mQmmeI46X3hiqRj/R4pvb8mQ=", "description": "Long Stratton, Norfolk, United Kingdom", "name": "Long Stratton", "type": "locality", "location": {"lat": 52.487827, "lng": 1.233093}, "admin_1": "Norfolk", "locality": "", "admin_0": "United Kingdom"}, {"public_id": "BQOzBfxua+W9eLymBnVKRkqK2Zc=", "description": "Long Sutton, Lincolnshire, United Kingdom", "name": "Long Sutton", "type": "locality", "location": {"lat": 52.786278, "lng": 0.12017952}, "admin_1": "Lincolnshire", "locality": "", "admin_0": "United Kingdom"}]}
{"title": "LocalitiesAutocompleteCollectionResponse", "type": "object", "description": "Localities Collection Response containing Localities", "properties": {"localities": {"type": "array", "items": {"title": "LocalitiesAutocompleteResponse", "type": "object", "description": "Attributes describing a locality. Not all attributes will be available for all locality types.", "properties": {"name": {"description": "contains the human-readable name for the returned result. For `postal_code` results, this is directly the postal code value. For `locality` results, name in the specified language is returns. If no language is specified, default name (country local language) is returned.", "type": "string"}, "description": {"description": "Concatenation of `name`, `admin_1`, `admin_0` to be used as suggestion in drop down list if needed. The description can vary depending on the type requested.", "type": "string"}, "location": {"title": "LatLngLiteral", "type": "object", "description": "An object describing a specific location with Latitude and Longitude in decimal degrees.", "required": ["lat", "lng"], "properties": {"lat": {"type": "number", "description": "Latitude in decimal degrees"}, "lng": {"type": "number", "description": "Longitude in decimal degrees"}}}, "public_id": {"description": "Contains a unique ID for each suggestion. Please use this ID if you need to give us feedbacks on results. This ID is also required to perform Localities Details request.", "type": "string"}, "type": {"title": "LocalitiesTypes", "type": "string", "description": "Contains the type of the suggestion.", "enum": ["locality", "postal_code", "admin_level", "airport", "train_station", "metro_station", "shopping", "museum", "zoo", "amusement_park", "art_gallery", "tourist_attraction", "country", "address"]}, "admin_0": {"description": "Contains the country name.", "type": "string"}, "admin_1": {"description": "Contains the administrative level including the suggestion.", "type": "string"}, "admin_2": {"description": "For small locality type points of interests (suburbs, neighborhoods, villages), contains the municipality it belongs to.", "type": "string"}, "viewpoint": {"title": "LocalitiesViewpoint", "type": "object", "description": "Contains the bounds for the locality", "properties": {"bounds": {"title": "LocalitiesBounds", "type": "object", "description": "A rectangle in geographical coordinates from points at the southwest and northeast corners.", "required": ["north", "east", "south", "west"], "properties": {"north": {"type": "number", "description": "Latitude in decimal degrees for upper right corner"}, "east": {"type": "number", "description": "Longitude in decimal degrees for upper right corner"}, "south": {"type": "number", "description": "Latitude in decimal degrees for lower left corner"}, "west": {"type": "number", "description": "Longitude in decimal degrees for lower left corner"}}}}}, "postal_codes": {"description": "Contains an array of known postal codes for a locality (only available on *suggestions* with country:`fr` for France or `it` for Italy and type: `locality`).\n", "type": "array", "items": {"type": "string"}}, "postal_town": {"description": "Contains the larger city (or the post office city) for a `postal_code` (only available on suggestions with type: `postal_code`).\n", "type": "string"}, "matched_substrings": {"title": "LocalitiesAutocompleteMatchedFields", "type": "object", "description": "Contains a set of substrings for each field (`description`, `name`, `admin_0`, `admin_1`, `admin_2`, `postal_town`) that match elements in the `input`. It can be used to highlight those substrings. Each substring is identified by an `offset` and a `length`.`", "properties": {"description": {"description": "match substrings for `description`", "type": "array", "items": {"title": "MatchedSubstring", "type": "object", "properties": {"length": {"description": "Length of the matched substring in the prediction result text.", "type": "number"}, "offset": {"description": "Start location of the matched substring in the prediction result text.", "type": "number"}}}}, "name": {"description": "match substrings for `name`", "type": "array", "items": {"title": "MatchedSubstring", "type": "object", "properties": {"length": {"description": "Length of the matched substring in the prediction result text.", "type": "number"}, "offset": {"description": "Start location of the matched substring in the prediction result text.", "type": "number"}}}}, "admin_0": {"description": "match substrings for `admin_0`", "type": "array", "items": {"title": "MatchedSubstring", "type": "object", "properties": {"length": {"description": "Length of the matched substring in the prediction result text.", "type": "number"}, "offset": {"description": "Start location of the matched substring in the prediction result text.", "type": "number"}}}}, "admin_1": {"description": "match substrings for `admin_1`", "type": "array", "items": {"title": "MatchedSubstring", "type": "object", "properties": {"length": {"description": "Length of the matched substring in the prediction result text.", "type": "number"}, "offset": {"description": "Start location of the matched substring in the prediction result text.", "type": "number"}}}}, "admin_2": {"description": "match substrings for `admin_2`", "type": "array", "items": {"title": "MatchedSubstring", "type": "object", "properties": {"length": {"description": "Length of the matched substring in the prediction result text.", "type": "number"}, "offset": {"description": "Start location of the matched substring in the prediction result text.", "type": "number"}}}}, "postal_town": {"description": "match substrings for `postal_town`", "type": "array", "items": {"title": "MatchedSubstring", "type": "object", "properties": {"length": {"description": "Length of the matched substring in the prediction result text.", "type": "number"}, "offset": {"description": "Start location of the matched substring in the prediction result text.", "type": "number"}}}}}}, "locality": {"type": "string", "description": "The parent locality when retrieving a POI. often empty."}, "has_addresses": {"description": "On the specific territory of United Kingdom, Localities autocomplete request can return the additional attribute `has_addresses` for a postal code, which indicates if a postal code bears addresses. When `has_addresses` is `true`, it is possible to display a list of the available addresses by requesting `details` with the Localities `public_id`. To get the details of an address you will need to request again `/details` endpoint passing in the dedicated address `public_id`.\n", "type": "boolean"}}}}}}
975b58f7-85ea-4e68-b0ce-868ac028542a/76c6ffc3-1046-4221-9b26-b9f77421f725/1/0
Woosmap
Location-based Search Platform
7
localitiesAutocomplete
Autocomplete on worldwide suggestions for a for text-based geographic searches. It can match on full words as well as substrings. You can therefore send queries as the user types, to provide on-the-fly city names, postal codes or suburb name suggestions.
429
null
{"detail": "The rate limit for this endpoint has been exceeded"}
{"title": "Error429", "type": "object", "description": "Over Query Limit. Check the API Documentation for available QPS.", "properties": {"detail": {"description": "Details for the Over Query Limit error message", "type": "string"}}}
975b58f7-85ea-4e68-b0ce-868ac028542a/76c6ffc3-1046-4221-9b26-b9f77421f725/2/0
Woosmap
Location-based Search Platform
7
localitiesAutocomplete
Autocomplete on worldwide suggestions for a for text-based geographic searches. It can match on full words as well as substrings. You can therefore send queries as the user types, to provide on-the-fly city names, postal codes or suburb name suggestions.
403
null
{"detail": "This Woosmap API is not enabled for this project."}
{"title": "Error403", "type": "object", "description": "API Request is authenticated but API Key don't have permission to access the resources", "properties": {"detail": {"description": "Details for the forbidden error message", "type": "string"}}}
975b58f7-85ea-4e68-b0ce-868ac028542a/76c6ffc3-1046-4221-9b26-b9f77421f725/3/0
Woosmap
Location-based Search Platform
7
localitiesAutocomplete
Autocomplete on worldwide suggestions for a for text-based geographic searches. It can match on full words as well as substrings. You can therefore send queries as the user types, to provide on-the-fly city names, postal codes or suburb name suggestions.
401
null
{"detail": "Incorrect authentication credentials. Please check or use a valid API Key"}
{"title": "Error401", "type": "object", "description": "Authentication credentials are incorrect", "properties": {"detail": {"description": "Details for the credentials error", "type": "string"}}}
975b58f7-85ea-4e68-b0ce-868ac028542a/4ec9ab59-bcb2-4974-a64e-c0dadc58b390/0/0
Woosmap
Location-based Search Platform
7
localitiesDetails
Provides details of an autocomplete suggestion (using the suggestion’s public_id).
200
null
{"result": {"formatted_address": "House Of Commons, House Of Commons Palace Of Westminster, Parliament Square, London, SW1A 0AA", "types": ["address"], "public_id": "MVZWBfGZQnAQn9JtE9CJZjgeB4Q=", "geometry": {"location": {"lat": 51.49984, "lng": -0.1246375}, "accuracy": "ROOFTOP"}, "address_components": [{"types": ["country", "administrative_area_level_0"], "long_name": "United Kingdom", "short_name": "GB"}, {"types": ["administrative_area_level_1"], "long_name": "City of London", "short_name": "City of London"}, {"types": ["premise"], "long_name": "House Of Commons Palace Of Westminster", "short_name": "House Of Commons Palace Of Westminster"}, {"types": ["locality"], "long_name": "London", "short_name": "London"}, {"types": ["postal_codes"], "long_name": "SW1A 0AA", "short_name": "SW1A 0AA"}, {"types": ["organisation"], "long_name": "House Of Commons", "short_name": "House Of Commons"}, {"types": ["route"], "long_name": "Parliament Square", "short_name": "Parliament Square"}]}}
{"title": "LocalitiesDetailsResponse", "type": "object", "description": "Localities Details Root Node Response", "properties": {"result": {"description": "The Root Node for Localities Details", "type": "object", "anyOf": [{"title": "LocalitiesDetailsAddressResponse", "type": "object", "description": "Attributes describing a locality. Not all attributes will be available for all locality types.", "properties": {"formatted_address": {"description": "Contains the text description of the proposal to be used as suggestion in drop down list if needed.", "type": "string"}, "types": {"description": "available localities types", "type": "array", "items": {"title": "LocalitiesTypes", "type": "string", "description": "Contains the type of the suggestion.", "enum": ["locality", "postal_code", "admin_level", "airport", "train_station", "metro_station", "shopping", "museum", "zoo", "amusement_park", "art_gallery", "tourist_attraction", "country", "address"]}}, "public_id": {"description": "Contains a unique ID for each suggestion. Please use this ID to give feedbacks on results.", "type": "string"}, "geometry": {"description": "The location of the result, in latitude and longitude. Accuracy is also provided.", "type": "object", "properties": {"location": {"title": "LatLngLiteral", "type": "object", "description": "An object describing a specific location with Latitude and Longitude in decimal degrees.", "required": ["lat", "lng"], "properties": {"lat": {"type": "number", "description": "Latitude in decimal degrees"}, "lng": {"type": "number", "description": "Longitude in decimal degrees"}}}, "accuracy": {"type": "string", "enum": ["ROOFTOP", "POSTAL_CODE", "DISTRICT"]}}}, "address_components": {"description": "An array containing the separate components applicable to this address.", "type": "array", "items": {"title": "AddressComponents", "type": "object", "description": "Address Components with additional information", "properties": {"long_name": {"type": "string", "description": "The full text description or name of the address component as returned by the Details."}, "short_name": {"description": "An abbreviated textual name for the address component, if available. For example, an address component for the state of United Kingdom may have a `long_name` of `United Kingdom` and a `short_name` of `UK` using the 2-letter postal abbreviation.", "type": "string"}, "types": {"description": "An array indicating the type of the address component. Those fields are provided when no fields parameter is set in the request.", "type": "array", "items": {"type": "string"}}}}}}}, {"title": "LocalitiesDetailsPostalCodeResponse", "type": "object", "description": "Attributes describing a locality. Not all attributes will be available for all locality types.", "properties": {"formatted_address": {"description": "Contains the text description of the proposal to be used as suggestion in drop down list if needed.", "type": "string"}, "types": {"description": "available localities types", "type": "array", "items": {"title": "LocalitiesTypes", "type": "string", "description": "Contains the type of the suggestion.", "enum": ["locality", "postal_code", "admin_level", "airport", "train_station", "metro_station", "shopping", "museum", "zoo", "amusement_park", "art_gallery", "tourist_attraction", "country", "address"]}}, "public_id": {"description": "Contains a unique ID for each suggestion. Please use this ID to give feedbacks on results.", "type": "string"}, "geometry": {"description": "The location of the PostalCode, in latitude and longitude.", "type": "object", "properties": {"location": {"title": "LatLngLiteral", "type": "object", "description": "An object describing a specific location with Latitude and Longitude in decimal degrees.", "required": ["lat", "lng"], "properties": {"lat": {"type": "number", "description": "Latitude in decimal degrees"}, "lng": {"type": "number", "description": "Longitude in decimal degrees"}}}}}, "address_components": {"description": "An array containing the separate components applicable to this address.", "type": "array", "items": {"title": "AddressComponents", "type": "object", "description": "Address Components with additional information", "properties": {"long_name": {"type": "string", "description": "The full text description or name of the address component as returned by the Details."}, "short_name": {"description": "An abbreviated textual name for the address component, if available. For example, an address component for the state of United Kingdom may have a `long_name` of `United Kingdom` and a `short_name` of `UK` using the 2-letter postal abbreviation.", "type": "string"}, "types": {"description": "An array indicating the type of the address component. Those fields are provided when no fields parameter is set in the request.", "type": "array", "items": {"type": "string"}}}}}, "addresses": {"description": "List of adresses attached to this Postal Code", "type": "object", "properties": {"pagination": {"type": "object", "properties": {"page": {"type": "number"}, "page_count": {"type": "number"}, "addresses_per_page": {"type": "number"}, "address_count": {"type": "number"}}}, "list": {"type": "array", "items": {"type": "object", "properties": {"description": {"type": "string"}, "public_id": {"type": "string"}}}}}}}}]}}}
975b58f7-85ea-4e68-b0ce-868ac028542a/4ec9ab59-bcb2-4974-a64e-c0dadc58b390/0/1
Woosmap
Location-based Search Platform
7
localitiesDetails
Provides details of an autocomplete suggestion (using the suggestion’s public_id).
200
null
{"result": {"formatted_address": "SW1A 0AA, City of London", "types": ["postal_code"], "public_id": "QaCU+fBtigK65ztSrqHqUoUDwZw=", "name": "SW1A 0AA", "geometry": {"location": {"lat": 51.49984, "lng": -0.124663}}, "address_components": [{"types": ["country", "administrative_area_level_0"], "long_name": "United Kingdom", "short_name": "GB"}, {"types": ["administrative_area_level_1"], "long_name": "City of London", "short_name": "City of London"}], "addresses": {"pagination": {"page": 1, "page_count": 1, "addresses_per_page": 20, "address_count": 5}, "list": [{"public_id": "J9y6c0VHd8L5djgVKAmUZir1D74=", "description": "The Speakers House, 1 Parliament Square, London, SW1A 0AA"}, {"public_id": "i5WqCPd+qTTnZtiXnKzV8KoIpT8=", "description": "Lord Chancellors Residence, House Of Commons Palace Of Westminster, Parliament Square, London, SW1A 0AA"}, {"public_id": "DuxKg3/i5t1AuSt1qvwaiSgd+gI=", "description": "Postmasters Redirection Service, House Of Commons Palace Of Westminster, Parliament Square, London, SW1A 0AA"}, {"public_id": "K13iP+XIfYK2h+6NFqVVX2q0NQ8=", "description": "Speakers Housekeepers Apartment, House Of Commons Palace Of Westminster, Parliament Square, London, SW1A 0AA"}, {"public_id": "MVZWBfGZQnAQn9JtE9CJZjgeB4Q=", "description": "House Of Commons, House Of Commons Palace Of Westminster, Parliament Square, London, SW1A 0AA"}]}}}
{"title": "LocalitiesDetailsResponse", "type": "object", "description": "Localities Details Root Node Response", "properties": {"result": {"description": "The Root Node for Localities Details", "type": "object", "anyOf": [{"title": "LocalitiesDetailsAddressResponse", "type": "object", "description": "Attributes describing a locality. Not all attributes will be available for all locality types.", "properties": {"formatted_address": {"description": "Contains the text description of the proposal to be used as suggestion in drop down list if needed.", "type": "string"}, "types": {"description": "available localities types", "type": "array", "items": {"title": "LocalitiesTypes", "type": "string", "description": "Contains the type of the suggestion.", "enum": ["locality", "postal_code", "admin_level", "airport", "train_station", "metro_station", "shopping", "museum", "zoo", "amusement_park", "art_gallery", "tourist_attraction", "country", "address"]}}, "public_id": {"description": "Contains a unique ID for each suggestion. Please use this ID to give feedbacks on results.", "type": "string"}, "geometry": {"description": "The location of the result, in latitude and longitude. Accuracy is also provided.", "type": "object", "properties": {"location": {"title": "LatLngLiteral", "type": "object", "description": "An object describing a specific location with Latitude and Longitude in decimal degrees.", "required": ["lat", "lng"], "properties": {"lat": {"type": "number", "description": "Latitude in decimal degrees"}, "lng": {"type": "number", "description": "Longitude in decimal degrees"}}}, "accuracy": {"type": "string", "enum": ["ROOFTOP", "POSTAL_CODE", "DISTRICT"]}}}, "address_components": {"description": "An array containing the separate components applicable to this address.", "type": "array", "items": {"title": "AddressComponents", "type": "object", "description": "Address Components with additional information", "properties": {"long_name": {"type": "string", "description": "The full text description or name of the address component as returned by the Details."}, "short_name": {"description": "An abbreviated textual name for the address component, if available. For example, an address component for the state of United Kingdom may have a `long_name` of `United Kingdom` and a `short_name` of `UK` using the 2-letter postal abbreviation.", "type": "string"}, "types": {"description": "An array indicating the type of the address component. Those fields are provided when no fields parameter is set in the request.", "type": "array", "items": {"type": "string"}}}}}}}, {"title": "LocalitiesDetailsPostalCodeResponse", "type": "object", "description": "Attributes describing a locality. Not all attributes will be available for all locality types.", "properties": {"formatted_address": {"description": "Contains the text description of the proposal to be used as suggestion in drop down list if needed.", "type": "string"}, "types": {"description": "available localities types", "type": "array", "items": {"title": "LocalitiesTypes", "type": "string", "description": "Contains the type of the suggestion.", "enum": ["locality", "postal_code", "admin_level", "airport", "train_station", "metro_station", "shopping", "museum", "zoo", "amusement_park", "art_gallery", "tourist_attraction", "country", "address"]}}, "public_id": {"description": "Contains a unique ID for each suggestion. Please use this ID to give feedbacks on results.", "type": "string"}, "geometry": {"description": "The location of the PostalCode, in latitude and longitude.", "type": "object", "properties": {"location": {"title": "LatLngLiteral", "type": "object", "description": "An object describing a specific location with Latitude and Longitude in decimal degrees.", "required": ["lat", "lng"], "properties": {"lat": {"type": "number", "description": "Latitude in decimal degrees"}, "lng": {"type": "number", "description": "Longitude in decimal degrees"}}}}}, "address_components": {"description": "An array containing the separate components applicable to this address.", "type": "array", "items": {"title": "AddressComponents", "type": "object", "description": "Address Components with additional information", "properties": {"long_name": {"type": "string", "description": "The full text description or name of the address component as returned by the Details."}, "short_name": {"description": "An abbreviated textual name for the address component, if available. For example, an address component for the state of United Kingdom may have a `long_name` of `United Kingdom` and a `short_name` of `UK` using the 2-letter postal abbreviation.", "type": "string"}, "types": {"description": "An array indicating the type of the address component. Those fields are provided when no fields parameter is set in the request.", "type": "array", "items": {"type": "string"}}}}}, "addresses": {"description": "List of adresses attached to this Postal Code", "type": "object", "properties": {"pagination": {"type": "object", "properties": {"page": {"type": "number"}, "page_count": {"type": "number"}, "addresses_per_page": {"type": "number"}, "address_count": {"type": "number"}}}, "list": {"type": "array", "items": {"type": "object", "properties": {"description": {"type": "string"}, "public_id": {"type": "string"}}}}}}}}]}}}
975b58f7-85ea-4e68-b0ce-868ac028542a/4ec9ab59-bcb2-4974-a64e-c0dadc58b390/1/0
Woosmap
Location-based Search Platform
7
localitiesDetails
Provides details of an autocomplete suggestion (using the suggestion’s public_id).
403
null
{"detail": "This Woosmap API is not enabled for this project."}
{"title": "Error403", "type": "object", "description": "API Request is authenticated but API Key don't have permission to access the resources", "properties": {"detail": {"description": "Details for the forbidden error message", "type": "string"}}}
975b58f7-85ea-4e68-b0ce-868ac028542a/4ec9ab59-bcb2-4974-a64e-c0dadc58b390/2/0
Woosmap
Location-based Search Platform
7
localitiesDetails
Provides details of an autocomplete suggestion (using the suggestion’s public_id).
401
null
{"detail": "Incorrect authentication credentials. Please check or use a valid API Key"}
{"title": "Error401", "type": "object", "description": "Authentication credentials are incorrect", "properties": {"detail": {"description": "Details for the credentials error", "type": "string"}}}
975b58f7-85ea-4e68-b0ce-868ac028542a/4ec9ab59-bcb2-4974-a64e-c0dadc58b390/3/0
Woosmap
Location-based Search Platform
7
localitiesDetails
Provides details of an autocomplete suggestion (using the suggestion’s public_id).
429
null
{"detail": "The rate limit for this endpoint has been exceeded"}
{"title": "Error429", "type": "object", "description": "Over Query Limit. Check the API Documentation for available QPS.", "properties": {"detail": {"description": "Details for the Over Query Limit error message", "type": "string"}}}
975b58f7-85ea-4e68-b0ce-868ac028542a/e75d39bb-4f44-407a-abf9-1e04b6879915/0/0
Woosmap
Location-based Search Platform
7
addressAutocomplete
Autocomplete on worldwide suggestions for a for text-based geographic searches. It can match on full words as well as substrings.
200
null
{"predictions": [{"public_id": "aGVyZTpjbTpuYW1lZHBsYWNlOjIwMzM3NDU0", "description": "London, England, United Kingdom", "matched_substring": {"description": [{"offset": 0, "length": 4}]}, "type": "locality"}, {"public_id": "aGVyZTpjbTpuYW1lZHBsYWNlOjIwNDE5Nzgz", "description": "Londonderry, Northern Ireland, United Kingdom", "matched_substring": {"description": [{"offset": 0, "length": 4}]}, "type": "locality"}], "status": "OK"}
{"title": "AddressAutocompleteCollectionResponse", "type": "object", "description": "Address Collection Response containing Localities", "properties": {"predictions": {"type": "array", "items": {"title": "AddressAutocompleteResponse", "type": "object", "description": "Attributes describing an Address.", "properties": {"description": {"description": "Address description to be used as suggestion in drop down list if needed.", "type": "string"}, "public_id": {"description": "Contains a unique ID for each suggestion. Please use this ID if you need to give us feedbacks on results. This ID is also required to perform Address Details request.", "type": "string"}, "matched_substring": {"title": "AddressAutocompleteMatchedFields", "type": "object", "description": "Contains a set of substrings for description. Each substring is identified by an `offset` and a `length`.`", "properties": {"description": {"description": "match substrings for `description`", "type": "array", "items": {"title": "MatchedSubstring", "type": "object", "properties": {"length": {"description": "Length of the matched substring in the prediction result text.", "type": "number"}, "offset": {"description": "Start location of the matched substring in the prediction result text.", "type": "number"}}}}}}, "type": {"title": "AddressTypes", "type": "string", "description": "Contains the type of result.", "enum": ["house_number", "route address_block", "locality", "admin_level", "country"]}, "status": {"title": "AddressStatus", "type": "string", "description": "Returns more info on if the request was successful or not, valid responses.\n * `OK` indicates the response contains a valid result.\n * `INVALID_REQUEST` indicates that the provided request was invalid (e.g. wrong URL syntax).\n * `REQUEST_DENIED` indicates that the service denied use of the Address API (e.g. wrong API Key, wrong/no referer, \u2026).\n * `UNKNOWN_ERROR` indicates an Address API request could not be processed due to a server error. The request may succeed if you try again.\n", "enum": ["OK", "INVALID_REQUEST", "REQUEST_DENIED", "UNKNOWN_ERROR"]}}}}, "status": {"title": "AddressStatus", "type": "string", "description": "Returns more info on if the request was successful or not, valid responses.\n * `OK` indicates the response contains a valid result.\n * `INVALID_REQUEST` indicates that the provided request was invalid (e.g. wrong URL syntax).\n * `REQUEST_DENIED` indicates that the service denied use of the Address API (e.g. wrong API Key, wrong/no referer, \u2026).\n * `UNKNOWN_ERROR` indicates an Address API request could not be processed due to a server error. The request may succeed if you try again.\n", "enum": ["OK", "INVALID_REQUEST", "REQUEST_DENIED", "UNKNOWN_ERROR"]}}}
975b58f7-85ea-4e68-b0ce-868ac028542a/e75d39bb-4f44-407a-abf9-1e04b6879915/1/0
Woosmap
Location-based Search Platform
7
addressAutocomplete
Autocomplete on worldwide suggestions for a for text-based geographic searches. It can match on full words as well as substrings.
429
null
{"detail": "The rate limit for this endpoint has been exceeded"}
{"title": "Error429", "type": "object", "description": "Over Query Limit. Check the API Documentation for available QPS.", "properties": {"detail": {"description": "Details for the Over Query Limit error message", "type": "string"}}}
975b58f7-85ea-4e68-b0ce-868ac028542a/e75d39bb-4f44-407a-abf9-1e04b6879915/2/0
Woosmap
Location-based Search Platform
7
addressAutocomplete
Autocomplete on worldwide suggestions for a for text-based geographic searches. It can match on full words as well as substrings.
403
null
{"detail": "This Woosmap API is not enabled for this project."}
{"title": "Error403", "type": "object", "description": "API Request is authenticated but API Key don't have permission to access the resources", "properties": {"detail": {"description": "Details for the forbidden error message", "type": "string"}}}
975b58f7-85ea-4e68-b0ce-868ac028542a/e75d39bb-4f44-407a-abf9-1e04b6879915/3/0
Woosmap
Location-based Search Platform
7
addressAutocomplete
Autocomplete on worldwide suggestions for a for text-based geographic searches. It can match on full words as well as substrings.
401
null
{"detail": "Incorrect authentication credentials. Please check or use a valid API Key"}
{"title": "Error401", "type": "object", "description": "Authentication credentials are incorrect", "properties": {"detail": {"description": "Details for the credentials error", "type": "string"}}}
975b58f7-85ea-4e68-b0ce-868ac028542a/e8ca5bc2-5347-4343-9ed3-474cbb2a6d23/0/0
Woosmap
Location-based Search Platform
7
getMerchantsBrand
Retrieve clean names and logos in response to a dirty transactions POST.
403
null
{"detail": "This Woosmap API is not enabled for this project."}
{"title": "Error403", "type": "object", "description": "API Request is authenticated but API Key don't have permission to access the resources", "properties": {"detail": {"description": "Details for the forbidden error message", "type": "string"}}}
975b58f7-85ea-4e68-b0ce-868ac028542a/e8ca5bc2-5347-4343-9ed3-474cbb2a6d23/1/0
Woosmap
Location-based Search Platform
7
getMerchantsBrand
Retrieve clean names and logos in response to a dirty transactions POST.
400
null
{"status": "error", "value": "The request is invalid, the data is not a valid JSON."}
{"title": "Error400", "type": "object", "description": "The request is invalid", "properties": {"status": {"type": "string", "description": "the status of the request"}, "value": {"description": "the value of request", "type": "string"}}}
975b58f7-85ea-4e68-b0ce-868ac028542a/e8ca5bc2-5347-4343-9ed3-474cbb2a6d23/2/0
Woosmap
Location-based Search Platform
7
getMerchantsBrand
Retrieve clean names and logos in response to a dirty transactions POST.
429
null
{"detail": "The rate limit for this endpoint has been exceeded"}
{"title": "Error429", "type": "object", "description": "Over Query Limit. Check the API Documentation for available QPS.", "properties": {"detail": {"description": "Details for the Over Query Limit error message", "type": "string"}}}
975b58f7-85ea-4e68-b0ce-868ac028542a/e8ca5bc2-5347-4343-9ed3-474cbb2a6d23/3/0
Woosmap
Location-based Search Platform
7
getMerchantsBrand
Retrieve clean names and logos in response to a dirty transactions POST.
200
null
{"merchants": [{"dirty_name": "MCDO UK 2231 EP", "clean_name": "McDonald's", "status": "OK", "logo": "956bcb3591a8976ff94871a59b09eecc", "logo_url": "https://api.woosmap.com/merchants/logos/956bcb3591a8976ff94871a59b09eecc.png", "country": "GB"}, {"dirty_name": "Zara Fashion Retail, S.A.", "clean_name": "Zara", "status": "OK", "logo": "72fc39033e0d9e923a0236cb874c9309", "logo_url": "https://api.woosmap.com/merchants/logos/72fc39033e0d9e923a0236cb874c9309.png", "country": "IT"}, {"status": "OK", "clean_name": "Apollo Pharmacy", "logo": "c776d3336e0d8c2b9e893e9e92b2caf7", "logo_url": "https://api.woosmap.com/merchants/logos/c776d3336e0d8c2b9e893e9e92b2caf7.png", "country": "IN", "dirty_name": "APOLLO PHARMACY BANGALORE IN"}, {"dirty_name": "PIZZA HUT - SHOP 157", "clean_name": "Pizza Hut", "status": "OK", "logo": "d5463410f32a5f497459ac79552d3ce3", "logo_url": "https://api.woosmap.com/merchants/logos/d5463410f32a5f497459ac79552d3ce3.png", "country": ""}, {"dirty_name": "CARREFOUR CITY 3112846", "clean_name": "Carrefour City", "status": "OK", "logo": "08ee8a3cecbcd3b7d9103bcf0e04db7e", "logo_url": "https://api.woosmap.com/merchants/logos/08ee8a3cecbcd3b7d9103bcf0e04db7e.png", "country": "FR"}, {"dirty_name": "ITUNES.COM/BILL", "clean_name": "Apple", "status": "OK", "logo": "5eb75a5239b76287f44021f8e6e1bd41", "logo_url": "https://api.woosmap.com/merchants/logos/5eb75a5239b76287f44021f8e6e1bd41.png", "country": "IE"}, {"status": "NOT_FOUND", "clean_name": "", "logo": "", "logo_url": "", "country": "ES", "dirty_name": "Pepa SL Gracia"}]}
{"title": "MerchantsBrandResponse", "type": "object", "description": "Attributes describing a Merchant Brand response", "properties": {"merchants": {"description": "The list of cleaned transactions", "type": "array", "items": {"title": "MerchantsBrandClean", "type": "object", "description": "Attributes describing each Merchant Brand cleaned", "properties": {"dirty_name": {"description": "The dirty name is the unique merchant identifier which is provided on transactions by a payment provider.", "type": "string"}, "clean_name": {"description": "a clean name for the above merchant.", "type": "string"}, "country": {"description": "The merchant\u2019s country.", "type": "string"}, "logo": {"description": "This is a hash generated for the logo based on the image.", "type": "string"}, "logo_url": {"type": "string", "description": "The logo image with content-type `image/png`."}, "status": {"description": "Status Code for Logo.\n * OK when there is a clean name or a clean name and a logo.\n * NOT_FOUND when there is no clean name or clean name and logo for the specified dirty merchant.\n", "enum": ["OK", "NOT_FOUND"]}, "custom_id": {"description": "Provided in request and returned if specified.", "type": "string"}}}}}}
975b58f7-85ea-4e68-b0ce-868ac028542a/e8ca5bc2-5347-4343-9ed3-474cbb2a6d23/4/0
Woosmap
Location-based Search Platform
7
getMerchantsBrand
Retrieve clean names and logos in response to a dirty transactions POST.
401
null
{"detail": "Incorrect authentication credentials. Please check or use a valid API Key"}
{"title": "Error401", "type": "object", "description": "Authentication credentials are incorrect", "properties": {"detail": {"description": "Details for the credentials error", "type": "string"}}}
975b58f7-85ea-4e68-b0ce-868ac028542a/8686ac07-1fb5-4883-a980-d5ba1e626590/0/0
Woosmap
Location-based Search Platform
7
addressDetails
Provides details of an address autocomplete suggestion (using the suggestion’s public_id).
401
null
{"detail": "Incorrect authentication credentials. Please check or use a valid API Key"}
{"title": "Error401", "type": "object", "description": "Authentication credentials are incorrect", "properties": {"detail": {"description": "Details for the credentials error", "type": "string"}}}
975b58f7-85ea-4e68-b0ce-868ac028542a/8686ac07-1fb5-4883-a980-d5ba1e626590/1/0
Woosmap
Location-based Search Platform
7
addressDetails
Provides details of an address autocomplete suggestion (using the suggestion’s public_id).
429
null
{"detail": "The rate limit for this endpoint has been exceeded"}
{"title": "Error429", "type": "object", "description": "Over Query Limit. Check the API Documentation for available QPS.", "properties": {"detail": {"description": "Details for the Over Query Limit error message", "type": "string"}}}
975b58f7-85ea-4e68-b0ce-868ac028542a/8686ac07-1fb5-4883-a980-d5ba1e626590/2/0
Woosmap
Location-based Search Platform
7
addressDetails
Provides details of an address autocomplete suggestion (using the suggestion’s public_id).
200
null
{"result": {"formatted_address": "London, England, United Kingdom", "types": ["locality"], "public_id": "aGVyZTpjbTpuYW1lZHBsYWNlOjIwMzM3NDU0", "address_components": [{"types": ["country"], "long_name": "United Kingdom", "short_name": "GBR"}, {"types": ["state"], "long_name": "England", "short_name": "England"}, {"types": ["county"], "long_name": "London", "short_name": "LDN"}, {"long_name": "London", "short_name": "London", "types": ["locality"]}, {"long_name": "SW1A 2", "short_name": "SW1A 2", "types": ["postal_code"]}], "geometry": {"location_type": "GEOMETRIC_CENTER", "location": {"lat": 51.50643, "lng": -0.12719}, "viewport": {"northeast": {"lat": 51.68629, "lng": 0.28206}, "southwest": {"lat": 51.28043, "lng": -0.56316}}}}, "status": "OK"}
{"title": "AddressDetailsResponse", "type": "object", "description": "Address Details Response", "properties": {"status": {"title": "AddressStatus", "type": "string", "description": "Returns more info on if the request was successful or not, valid responses.\n * `OK` indicates the response contains a valid result.\n * `INVALID_REQUEST` indicates that the provided request was invalid (e.g. wrong URL syntax).\n * `REQUEST_DENIED` indicates that the service denied use of the Address API (e.g. wrong API Key, wrong/no referer, \u2026).\n * `UNKNOWN_ERROR` indicates an Address API request could not be processed due to a server error. The request may succeed if you try again.\n", "enum": ["OK", "INVALID_REQUEST", "REQUEST_DENIED", "UNKNOWN_ERROR"]}, "result": {"description": "the root node of address details", "type": "object", "properties": {"formatted_address": {"description": "Contains the text description of the proposal to be used as suggestion in drop down list if needed.", "type": "string"}, "types": {"description": "available address types", "type": "array", "items": {"title": "AddressTypes", "type": "string", "description": "Contains the type of result.", "enum": ["house_number", "route address_block", "locality", "admin_level", "country"]}}, "public_id": {"description": "Contains a unique ID for each suggestion. Please use this ID to give feedbacks on results.", "type": "string"}, "address_components": {"description": "An array containing the separate components applicable to this address.", "type": "array", "items": {"title": "AddressComponents", "type": "object", "description": "Address Components with additional information", "properties": {"long_name": {"type": "string", "description": "The full text description or name of the address component as returned by the Details."}, "short_name": {"description": "An abbreviated textual name for the address component, if available. For example, an address component for the state of United Kingdom may have a `long_name` of `United Kingdom` and a `short_name` of `UK` using the 2-letter postal abbreviation.", "type": "string"}, "types": {"description": "An array indicating the type of the address component. Those fields are provided when no fields parameter is set in the request.", "type": "array", "items": {"type": "string"}}}}}, "geometry": {"description": "The location of the result, in latitude and logitude. Accuracy is also provided.", "type": "object", "properties": {"location_type": {"type": "string", "enum": ["ROOFTOP", "RANGE_INTERPOLATED", "GEOMETRIC_CENTER", "APPROXIMATE"]}, "location": {"title": "LatLngLiteral", "type": "object", "description": "An object describing a specific location with Latitude and Longitude in decimal degrees.", "required": ["lat", "lng"], "properties": {"lat": {"type": "number", "description": "Latitude in decimal degrees"}, "lng": {"type": "number", "description": "Longitude in decimal degrees"}}}, "viewport": {"title": "Bounds", "type": "object", "description": "A rectangle in geographical coordinates from points at the southwest and northeast corners.", "properties": {"northeast": {"title": "LatLngLiteral", "type": "object", "description": "An object describing a specific location with Latitude and Longitude in decimal degrees.", "required": ["lat", "lng"], "properties": {"lat": {"type": "number", "description": "Latitude in decimal degrees"}, "lng": {"type": "number", "description": "Longitude in decimal degrees"}}}, "southwest": {"title": "LatLngLiteral", "type": "object", "description": "An object describing a specific location with Latitude and Longitude in decimal degrees.", "required": ["lat", "lng"], "properties": {"lat": {"type": "number", "description": "Latitude in decimal degrees"}, "lng": {"type": "number", "description": "Longitude in decimal degrees"}}}}}}}}}}}
975b58f7-85ea-4e68-b0ce-868ac028542a/8686ac07-1fb5-4883-a980-d5ba1e626590/3/0
Woosmap
Location-based Search Platform
7
addressDetails
Provides details of an address autocomplete suggestion (using the suggestion’s public_id).
403
null
{"detail": "This Woosmap API is not enabled for this project."}
{"title": "Error403", "type": "object", "description": "API Request is authenticated but API Key don't have permission to access the resources", "properties": {"detail": {"description": "Details for the forbidden error message", "type": "string"}}}
975b58f7-85ea-4e68-b0ce-868ac028542a/cfe0468a-d564-4797-823c-00526f62f43d/0/0
Woosmap
Location-based Search Platform
7
getMerchantsPlace
Retrieve clean names, logos and Google Place ID of given dirty merchants name.
429
null
{"detail": "The rate limit for this endpoint has been exceeded"}
{"title": "Error429", "type": "object", "description": "Over Query Limit. Check the API Documentation for available QPS.", "properties": {"detail": {"description": "Details for the Over Query Limit error message", "type": "string"}}}
975b58f7-85ea-4e68-b0ce-868ac028542a/cfe0468a-d564-4797-823c-00526f62f43d/1/0
Woosmap
Location-based Search Platform
7
getMerchantsPlace
Retrieve clean names, logos and Google Place ID of given dirty merchants name.
200
null
{"merchants": [{"dirty_name": "MCDO UK 2231 EP", "clean_name": "McDonald's", "status": "OK", "logo": "956bcb3591a8976ff94871a59b09eecc", "logo_url": "https://api.woosmap.com/merchants/logos/956bcb3591a8976ff94871a59b09eecc.png", "country": "GB", "merchant_id": "234482729011", "place_id": "ChIJGS7Sga0cdkgR46nd-S661TM"}, {"dirty_name": "Zara Fashion Retail, S.A.", "clean_name": "Zara", "status": "OK", "logo": "72fc39033e0d9e923a0236cb874c9309", "logo_url": "https://api.woosmap.com/merchants/logos/72fc39033e0d9e923a0236cb874c9309.png", "country": "IT", "merchant_id": "*44532UY2T33219", "place_id": "ChIJF2vQecLGhkcR83Zbpwpej3I"}, {"dirty_name": "CARREFOUR CITY 3112846", "clean_name": "Carrefour City", "status": "OK", "logo": "08ee8a3cecbcd3b7d9103bcf0e04db7e", "logo_url": "https://api.woosmap.com/merchants/logos/08ee8a3cecbcd3b7d9103bcf0e04db7e.png", "country": "FR", "merchant_id": "9651781125", "place_id": "ChIJJ7ZEZDUnVQ0Ru5gudUqdvKM"}, {"dirty_name": "ITUNES.COM/BILL", "clean_name": "Apple", "status": "OK", "logo": "5eb75a5239b76287f44021f8e6e1bd41", "logo_url": "https://api.woosmap.com/merchants/logos/5eb75a5239b76287f44021f8e6e1bd41.png", "country": "IE", "merchant_id": "2070070200925", "place_id": ""}, {"status": "OK", "clean_name": "", "logo": "", "logo_url": "", "country": "ES", "dirty_name": "Pepa SL Gracia", "merchant_id": "34J21189", "place_id": "ChIJZ9fQvb2ipBIRyaZy8wUqRGQ"}]}
{"title": "MerchantsPlaceResponse", "type": "object", "description": "Attributes describing a Merchant Place Response", "properties": {"merchants": {"description": "The list of cleaned transactions", "type": "array", "items": {"title": "MerchantsPlaceClean", "description": "Attributes describing each Merchant Brand cleaned", "type": "object", "properties": {"merchant_id": {"type": "string", "description": "Textual identifier for Merchant"}, "place_id": {"type": "string", "description": "The [Google Maps Place ID](https://developers.google.com/maps/documentation/places/web-service/place-id)"}, "dirty_name": {"description": "The dirty name is the unique merchant identifier which is provided on transactions by a payment provider.", "type": "string"}, "clean_name": {"description": "a clean name for the above merchant.", "type": "string"}, "country": {"description": "The merchant\u2019s country.", "type": "string"}, "logo": {"description": "This is a hash generated for the logo based on the image.", "type": "string"}, "logo_url": {"type": "string", "description": "The logo image with content-type `image/png`."}, "status": {"description": "Status Code for Logo.\n * OK when there is a clean name or a clean name and a logo.\n * NOT_FOUND when there is no clean name or clean name and logo for the specified dirty merchant.\n", "enum": ["OK", "NOT_FOUND"]}, "custom_id": {"description": "Provided in request and returned if specified.", "type": "string"}}}}}}
975b58f7-85ea-4e68-b0ce-868ac028542a/cfe0468a-d564-4797-823c-00526f62f43d/2/0
Woosmap
Location-based Search Platform
7
getMerchantsPlace
Retrieve clean names, logos and Google Place ID of given dirty merchants name.
403
null
{"detail": "This Woosmap API is not enabled for this project."}
{"title": "Error403", "type": "object", "description": "API Request is authenticated but API Key don't have permission to access the resources", "properties": {"detail": {"description": "Details for the forbidden error message", "type": "string"}}}
975b58f7-85ea-4e68-b0ce-868ac028542a/cfe0468a-d564-4797-823c-00526f62f43d/3/0
Woosmap
Location-based Search Platform
7
getMerchantsPlace
Retrieve clean names, logos and Google Place ID of given dirty merchants name.
400
null
{"status": "error", "value": "The request is invalid, the data is not a valid JSON."}
{"title": "Error400", "type": "object", "description": "The request is invalid", "properties": {"status": {"type": "string", "description": "the status of the request"}, "value": {"description": "the value of request", "type": "string"}}}
975b58f7-85ea-4e68-b0ce-868ac028542a/cfe0468a-d564-4797-823c-00526f62f43d/4/0
Woosmap
Location-based Search Platform
7
getMerchantsPlace
Retrieve clean names, logos and Google Place ID of given dirty merchants name.
401
null
{"detail": "Incorrect authentication credentials. Please check or use a valid API Key"}
{"title": "Error401", "type": "object", "description": "Authentication credentials are incorrect", "properties": {"detail": {"description": "Details for the credentials error", "type": "string"}}}
975b58f7-85ea-4e68-b0ce-868ac028542a/96fc9f20-e55d-40a9-b4f4-fed1923de661/0/0
Woosmap
Location-based Search Platform
7
getDistanceMatrix
Get distances and durations for a matrix of origins and destinations, based on the recommended route between start and end points for a specified travel mode.
401
null
{"detail": "Incorrect authentication credentials. Please check or use a valid API Key"}
{"title": "Error401", "type": "object", "description": "Authentication credentials are incorrect", "properties": {"detail": {"description": "Details for the credentials error", "type": "string"}}}
975b58f7-85ea-4e68-b0ce-868ac028542a/96fc9f20-e55d-40a9-b4f4-fed1923de661/1/0
Woosmap
Location-based Search Platform
7
getDistanceMatrix
Get distances and durations for a matrix of origins and destinations, based on the recommended route between start and end points for a specified travel mode.
429
null
{"detail": "The rate limit for this endpoint has been exceeded"}
{"title": "Error429", "type": "object", "description": "Over Query Limit. Check the API Documentation for available QPS.", "properties": {"detail": {"description": "Details for the Over Query Limit error message", "type": "string"}}}
975b58f7-85ea-4e68-b0ce-868ac028542a/96fc9f20-e55d-40a9-b4f4-fed1923de661/2/0
Woosmap
Location-based Search Platform
7
getDistanceMatrix
Get distances and durations for a matrix of origins and destinations, based on the recommended route between start and end points for a specified travel mode.
403
null
{"detail": "This Woosmap API is not enabled for this project."}
{"title": "Error403", "type": "object", "description": "API Request is authenticated but API Key don't have permission to access the resources", "properties": {"detail": {"description": "Details for the forbidden error message", "type": "string"}}}
975b58f7-85ea-4e68-b0ce-868ac028542a/96fc9f20-e55d-40a9-b4f4-fed1923de661/3/0
Woosmap
Location-based Search Platform
7
getDistanceMatrix
Get distances and durations for a matrix of origins and destinations, based on the recommended route between start and end points for a specified travel mode.
200
null
{"status": "OK", "rows": [{"elements": [{"status": "OK", "duration": {"value": 866, "text": "14 mins"}, "distance": {"value": 10613, "text": "10.6 km"}}, {"status": "OK", "duration": {"value": 935, "text": "16 mins"}, "distance": {"value": 10287, "text": "10.3 km"}}]}]}
{"title": "DistanceMatrixResponse", "type": "object", "description": "Attributes describing an distance Matrix response.", "properties": {"status": {"title": "DistanceStatus", "type": "string", "description": "Returns more info on if the request was successful or not.\n * `OK` indicates the response contains a valid result.\n * `INVALID_REQUEST` indicates that the provided request was invalid (e.g. wrong URL syntax).\n * `MAX_ELEMENTS_EXCEEDED` indicates that the product of origins and destinations exceeds the per-query limit (fixed at 200 elts/q).\n * `MAX_ROUTE_LENGTH_EXCEEDED` indicates that at least one of requested route is too long and the matrix cannot be processed (>1000km).\n * `REQUEST_DENIED` indicates that the service denied use of the Distance API service (e.g. wrong API Key, wrong/no referer, \u2026).\n * `UNKNOWN_ERROR` indicates a Distance API request could not be processed due to a server error. The request may succeed if you try again.\n * `OVER_QUERY_LIMIT` (associated to a 429 status code) indicates that the number of queries per second (QPS) or the number of elements per second (EPS) exceed the [usage limits](https://developers.woosmap.com/products/distance-api/distance-matrix-endpoint/#usage-limits)\n", "enum": ["OK", "INVALID_REQUEST", "MAX_ELEMENTS_EXCEEDED", "MAX_ROUTE_LENGTH_EXCEEDED", "REQUEST_DENIED", "UNKNOWN_ERROR", "OVER_QUERY_LIMIT"]}, "rows": {"description": "Contains an array of elements for each pair of origin and destination", "type": "array", "items": {"title": "DistanceMatrixElementsResponse", "type": "object", "description": "Attributes describing elements of origin and destination returned in distance Matrix response.", "properties": {"elements": {"type": "array", "description": "the route element", "items": {"title": "DistanceMatrixElementResponse", "type": "object", "description": "Attributes describing an element of origin and destination returned in distance Matrix response.", "properties": {"status": {"type": "string", "description": "Status returned for Distance Matrix Element Response.\n - `OK` indicates the response contains a valid result.\n - `NOT_FOUND` indicates that the origin and/or destination of this pairing could not be matched to the network.\n - `ZERO_RESULTS` indicates no route could be found between the origin and destination.\n", "enum": ["OK", "NOT_FOUND", "ZERO_RESULTS"]}, "duration": {"description": "The total duration to travel this route, expressed in seconds (value) and as text. The textual value gives a structured string for duration in the specified language (if available).", "type": "object", "properties": {"value": {"description": "The duration in seconds", "type": "number"}, "text": {"type": "string"}}}, "distance": {"description": "The total distance of this route, expressed in meters (value) and as text. The textual value uses the unit system specified with the units parameter of the original request.", "type": "object", "properties": {"value": {"description": "The distance in meter", "type": "number"}, "text": {"type": "string"}}}}}}}}}}}
975b58f7-85ea-4e68-b0ce-868ac028542a/1c5ac99f-3b82-4ddc-b491-411e98abfaee/0/0
Woosmap
Location-based Search Platform
7
getRoute
Get distance, duration and path (as a polyline) for a pair of origin and destination, based on the recommended route between those two points for a specified travel mode.
200
null
{"status": "OK", "routes": [{"overview_polyline": {"points": "iohhH_gtMA?a@ME?I?GAOEKCQEUGCAIE}@c@UKIEmAm@UOs@]e@U[O[OA?OKiAk@WIAGAECCCAE@C@CIGIaAm@YIQKe@_@m@i@UWq@s@{@kAe@m@_@o@u@oAo@iA_@u@[w@Yw@So@Y}@[y@MYO[Ua@{AmC]k@UYMQ]e@Wa@m@cAU_@S]Oa@Wm@Wo@Wo@]o@_AaBm@eAKSCCQ]EEYi@IKeAoBiCgF[s@Og@_@sA@CBC?E?EAEAECACAC?CW]_BK_@Sk@M[cAuB[o@IOQa@Ma@YcAOk@gAuEg@uBWaAEOI]WaA[_Bi@kDa@uB_@wBCQEUg@sCk@eDo@uDEOJO?QAEGk@m@yHOeDEe@CW?U?e@MyDGo@AQAOEmAWuB_AkIUyAGSGQCIAM?KCSI_@EOO}@S}AGUGMIIi@SoA[YIuCu@]OOI@a@?]E}@GaAKwASwCIm@IUIM@E?GAICEEEEAC?Ua@MSSa@Wc@IOQ_@QQIUKe@C]C]@c@Da@ZkBzAqJHg@NcA@IJq@DUc@[y@i@u@g@aAq@a@YQKMGa@MMECACACCKI?IAGPUf@Eb@IAS@I?C?C@EBIFQ^aAFSBEBGBIBO@KAKCKUq@Ya@e@m@IQEKGWOw@Q}@?Q@UHSLSHEH@t@NzBf@VDP?PE|Ae@VGRIB@B?DABCBE@E?G?GCGCEE]?GE[[oAAGmAoFqAoFAEScAYgASk@GKIUM[CE_@i@k@_AAAU]q@_Ag@w@qBwCi@w@c@s@g@aA[y@e@mAOe@[c@eEiH_AcB[i@cB_DOWUc@aB_DWe@[k@MU{EyJO[Sc@KS}BeFi@aB[qAw@aEG][oAg@yAmAwCQ_@BI@M?KCIEIGEGAG@GFWYm@mAc@_AQ_@q@iAg@i@g@e@eBgBaCqBKI_BqAsAgAECO_@G]?yA@g@Z}FHgBDs@B[HeB?GD{@XqFEi@AUDCBG@I?IAGCGEEECE?E@EDCOKg@YqCYcCIu@k@aGIiAEiB?oBC{DQwGGmBMcEMkEGaBO_BC[DEBKAQEIICGBGc@E]WiBS_BGaA@mAJ{Ar@sJHuBC_AM_Bi@qGc@mFCQFEDKBMAMEIEGGAGc@ImAOuAEk@McBYuCC[Im@Ow@I_@I_@]qAKa@o@wBIYOa@GOSk@KY]eAgBuFe@sAqA_Dg@_Am@y@CES[OSEG{@oAWa@Y_@U]GKU[_AuAcAaBaA}A}BuDKMO]K[KUa@{@KSeBsBGOYm@Sq@GU?GKyBEy@AUE]AEMa@[u@g@eAo@}@y@kAQWIWOYOWMQOSi@cASi@Y{@cAyCK[mC{HSu@Ik@CWEc@AKO}AIk@AE@G?UDG@I@I?ICICGEEGAG@EDEFAHKEIEGCcK{Ok@{@a@o@SWsAmBe@i@cF{FgAmAkAuAu@}@GIKMQYCCs@cAoAgBgCmDiDyES]MUDABC@CBG?E?GAGCECCCCE?E@CBCFMMWSSU[g@oCgEIMYc@OUe@y@o@eAKQBC@E@GAI?ECECECAGAEBCBQ[cCyEcH{M[c@EGe@o@[[mLiISOUQ]UqCoBw@k@_@W}BaBUO_@YiBqAKIwB{AaBmAm@a@IGsCqBUQgBoAaBmAKKIKGGIMCGQW]i@GMUi@IMWw@O_@IWGSaAkCSg@a@cAGMISi@uAk@gBGSiA_DoCmIQi@Sw@y@wCiCoJwGoVEOESK_@QaAc@oCG]M{@U{Ag@cEOwAGi@Eu@i@uM?a@Au@CaAC{ACs@ASC_AQaEAWAOAMFUDUD[Dg@Fc@?ELo@ViAn@qCrAqFPy@j@qCF]F_@BUD]Hu@F{@Dw@LmB@YDm@NiC?AJ_B?I@QBc@F{@FoAJ}ABe@HgADYDe@BYBSD_@^qDHu@Js@BSL{@BUHu@Fk@LmANkBD_@B]Hm@JeATgAL]JMJIHMFQDU?WCUIQKOOIOAOFMJQDMBIAUEc@GEEGICGCIAKAO?I@K@KLwALiAFc@D]VuA@KYGkB_@IAgB_@MAq@?G?EACACEACCEAI?I?G@UDq@Be@H_B@ID_A?IAOGk@Go@?IAG@K?G@I?G?GRmDDy@FaA?KAKAIAEY}@GWCGMa@_A}CQe@AIAG@MLo@F]RmABKLw@Hg@BW@U?EJmCDq@?W?q@Ai@G{A?ECYAWLIJIl@]NIXMASAKEQOUEOEUCk@KoEC{@?EA]AE?E?KAg@A]?]?[@a@@e@BaB@{@ByBBw@?E?C?ODmE@g@?W@OJuABS@QBQRqANcAF[Hg@BWBW@Y?k@?IDCBC@G@G?GAGCECCEAC@AKKiC?A?]CcBEoBCeB?C?WAa@C_B?EAY?a@?ULy@Lg@FKHCFEFKDKBM@OAOLa@FSXy@D_@BY@Y@]A]Ae@E[CWEUIa@KWISa@u@mAqBSa@S]qAuBiBwCEIGIFMDQBQ?SAQCOGOEKIIIGKCKAI@KD[KOM_@k@Yk@Wq@Y}@M{@oAwJG_AIgAO{C]mIEw@CaAIwAIeAIu@Iq@[uBSy@Qu@Qo@_BsFYgAWgA_@sBeBwKIi@{@kFkCsPIe@Mw@YeBKa@K_@[}@O]KWMUQU_@g@wA_BeDsDQUY]_@_AEICIAG?EAE?I?M?G?GAGAGAGAECGCOEOE_@E[E[C[K}ACg@Ci@?k@Ak@@wB@q@@iE@}D?_AAq@?[Es@G}@KqAMeAIi@Cq@A_@DGBI@K?KAKBOBO?]?YCkAA]AYA]C_@?EQyACWGg@Cc@AS?U@Y@SJm@Ls@F_@@A?C?AAC?AAA?AAA?C?CAC?CEqA?QGeBAo@Cu@?GEaAAe@IsCAU?I?G?GAGAEAECMCEAE?A?A?AA??A?A?A?A@E@E?C@EAE?E?EAEACACCc@EmAC}@Em@E_AQ_DSsDAa@O}CG}@QsDGkAYqFC_@Eu@AOAOCe@Ce@AW?MAO@SBYDkABe@NkEBe@@Y@]HeC?EBi@@e@HgBH{BBs@BYDuABm@JeCDc@BW?_@?_@FoBD}@PgF@KFkAJ_DBq@Bq@ZkIFoBD}A@uA?uG?qH@iF?aA?o@FmJ@{A@oB?kAAk@Ak@?]@[H?DEBGBI?IAKCEEGCAG?C@EDABQe@I_@GWc@qBg@}BaCoK_@kBgBwIsCyM{Ge\\WmAGWCOS_A}@gEOs@Ki@Ia@o@{CI_@YsAQw@ISGKMKIEIAiA?CCCCCECEWuCGq@?g@?q@BsBHsODwJF_CDaABg@Bm@@e@@MBOBQDEDKDM@O?UAQGUQMMs@@eGZyl@CqAKkAwGwWm@{BsBqHgBkGkDgMqCiQk@sD{F{^yCsR}@{FUoAiBcKeBmIyBcLwHm`@SeBIgCIuHAy@EyC?IQcOSaRsBeSgF}d@?A}B{NsAsIg@}CkA{DYiAc@{BSoBK}AEyA@wA@mB?wAEuAIkAMgASgASq@Us@Ue@a@s@]a@c@]s@k@k@Uo@QcAKo@?qBRy@Bs@GMA_AUu@o@e@g@[i@EIqAqDg@aBI]Oq@E[GWaAmFm@_D[sBCu@HaBFo@ZeDN}A\\wDH}A@uA@cABsF?mDAgCM}Ck@wGEq@U_F[wEk@uEw@}Fc@wDQsAaAqI[yD_@wIGcAQeB]uC_@cCCa@BS@O?UCYK]QSMEMASMOKUi@kA_DAKSuAYiCSqB]yBw@{DmBsJGWwH}_@{AyHy@_EU_BKsAA_@?e@@_@JQDQD_@Ei@K[QS_@GUHIFILWR[Aa@Um@e@SW[q@eAaB{@}@sIeH{CyB}@m@wAo@aBo@o@WkEsAqOwEa@KeD{@sAe@w@Y}B}@gFyBke@_R}D}AwAg@i@MaCWcBDaJh@aEPuAJa@Cc@C_BQmAM}AQ{ASuAMiAGkBKiA[a@U_@W}@m@]K[AEGGCMOOYkBsKaAgFwE}WOcA[iBQ{@Ga@Ic@Q_AKm@[cBC[kAgGHMDQ?OCOEKGIKCK?CBUaAeAaDaAwCk@eAuA}AkBiB}BwAm@i@oBaDcCgDaAoAMKyBmBUY@k@v@mCHg@?a@Ke@qBuB_BgB]k@Uo@BuAPu@lBoHr@oDN}@t@{Ef@qDBU\\_Cv@aL^{@_CsDiAeBqAqBDKd@qAhAwC~@_CDKk@s@}A_ByB}Ba@a@OQKMo@k@QQOOGEKKHYTw@N_A^qCh@qFZoC\\kCtA{KvA{Kx@sGpCeTJ}@Bc@d@uNNcEB{@DeA@c@PgFBk@DwARwIVsEB{B@O@cA@W@i@Bu@BuA?iEAmAA{@HyKDcGHeB@yBFgC@YNuBJoBHcAp@oHLoALeCB[nAmMNmBBgA@]LaEAqAAUGeAUgCEoAJ}@Ro@\\gADMbB_Cd@k@rByCxCkE|@cAhA}@|BgBnDyBfGwDrEaDl@i@f@u@d@u@b@kAp@yBxBwHxBuHpEkO^oAzC{JnKs^FUfHeVvHwWrDgM|@kG|BoUtDi_@XkDfCuVx@aIrCmY`CiUbBeQXuCHwB@gAAmAG{A@cAFa@DO?QAQCMGKAY@i@LkA\\{Ad@qAn@iAd@oAXqAnMupA~Emf@pDc^~BoUvCkYFi@N_BBOb@sEHmAJeALq@RuBD_@T}BLgABa@Fe@LmAZ}CPcB^wDB[d@iEn@kB`ByEr@qBpBuFPg@X}@nC{HRi@N_@Rm@dByEx@}BDMBIjAgD`@mARo@dDeJPi@Z}@Xw@Tm@pAoDRo@n@kBPc@t@sB`H{RlBmFlDyJ`@kArAyDHWTeATsAd@oEHm@`BeNvCsVpBwPJaArDk[PsANgAj@_FR_BJw@NaA`AyCJ]v@aCJYx@iC`@wATw@M@IKCSi@sEM}@EYNy@l@aDr@mDDQ^iBv@{D?WAYEYGKIIs@g@OKa@QYEUQGEgAuBUQc@YkAc@CEGSESHyAFq@VqBBKFa@FQA_@?WC{@O]UUC]Ci@X_@V[RWLWDHHBF?FEDGBG?G?G?ICIEGEC?[MoCIkBImBI{Aq@{Pm@{Nk@iNASAGeA_WA_@KuBCeAGsAKcC}@eUAYHEFGFKBO@MAOAMEKIIKEK?KDCQGk@@sB?k@G}@qBwQEc@uAgMYeCQ_BE]Eg@SaBgFie@E_@K}@MkAy@uHSuASiAYmAcB{GU{@u@{Cc@gBmE}PI]kDcNk@{BgBaHU_ASw@m@_CKg@a@_ByA{Fq@uCMq@CQAU@E?G?GAGAECEEAEAGMGKCEGYOg@Y_A}AeG{Lof@{F_U{BaJyBuIEOiBmHs@qCw@}CkAuEKe@sBkIaGsUiCeKuBoIEMyFcU_GuUKa@yB{IuGoWkCmKwCkLwCiL}Ik^IYOm@k@wBI]aIk[uJ{_@UsAMaAi@uKqGiwA?G]cIa@wIGsA?w@Bm@No@Ti@p@w@DSA_@i@k@Su@So@Mi@a@uFSuDI_@Ok@b@MVKlAa@X_@Ro@LgADc@B[X}A]o@g@k@w@uAQ[eBqDg@wDy@yG]sCKu@YcCAa@?k@@[D]FKDO@QCQIQMIOMMQOe@O_@QgAK{AYuN_@mRSmHEaAKeAq@wE{G_f@q@_F}Fua@oSayAiF}^{DiYuAuJC_ANwAx@qEd@oBp@yAb@m@j@wAvDmLl@mAjAgD`AiDb@qCv@sHF_AEeDUaDe@mCkAkEgByFk@sBWcBKkB?aBNeCZcB|@qDhCeJh@eCVkCBmCBmH@aA?oHCgIn@HvCA`@Hx@j@N@RAt@Gn@Bf@L\\Pp@XZHZ@d@Mn@`@^x@\\~AVj@n@v@j@^|@ZrDzEdBdBx@b@l@DX?b@@dAXpD~@~DfAlAn@x@j@v@l@xB|@bBh@Ac@PoBb@oHRuETcEXwDXaDhAaJR}AFkABqCBcBDg@BUT{@`@o@t@i@fA{@fAmA`B{C`@eAr@uBfAaCz@sB`@eAHK|@GdAoABSC]qAsJE]gB\\]qDy@iFIi@Gk@@sAFsDJk@JGDAPITSHY^cCkAk@cBs@gBm@_@K]YW]Me@cAeFgBoIc@uBy@kCk@oB[_BSaBM}ACkAKsGGgJ?k@D{@Ry@~AsCVi@Pw@PmA\\mELaBPyAX{ATy@VkAFm@BaACgAW}CMgBEeBGs@Oy@w@{Cm@cDKe@Wo@oA{B]aAQe@[yAQeAIs@I_AMw@U{@_CuI}AsGi@iCS_B[gECi@AeBB_BFgAv@kHNaBBaA?aAMaECcCPgO@wCEaCUeMQwM@]NcAf@mBHi@Hm@@s@Au@OwEs@oUq@uTMeBSgAiA}EsDaOQu@Ce@~Dgs@vDmp@}Dy@aCy@aB}@iJiGk@Gq@Mm@W]]e@k@oAiBQsAMs@IUiGiCyEkAOKAJ]~Cs@zCr@{C\\_D@KNJxEjAhGhCHTLr@PrAnAhBd@j@\\\\l@Vp@Lj@FbDxBdEnC`B|@`Cx@|Dx@wDlp@_Efs@Bd@Pt@rD`OhA|ERfALdBp@tTr@nUNvE@t@Ar@Il@Ih@g@lBObAA\\PvMTdMD`CAvCQfOBbCL`E?`AC`AO`Bw@jHGfAC~A@dBBh@ZfER~Ah@hC|ArG~BtITz@Lv@H~@Hr@PdAZxAPd@\\`AnAzBVn@Jd@l@bDv@zCNx@Fr@DdBLfBV|CBfAC`AGl@WjAUx@YzAQxAM`B]lEQlAQv@Wh@_BrCSx@Ez@?j@FfJJrGBjAL|AR`BZ~Aj@nBx@jCb@tBfBnIbAdFLd@V\\\\X^JfBl@bBr@jAj@lAt@p@h@P\\j@z@^h@z@t@b@j@hBnCj@x@x@hAN`@d@hB`@rAFAb@vDNrAJb@lFhNRt@Lb@LlAFdBJfDfAb\\t@jUpDlg@p@hJJnHh@|e@|@r|@VrVBfCM|SC|AKhBa@|Gg@pHiBzVUfCMjASfAYbAoEnLa@pAUdAMbAE|@WzUc@~ZGlBMfA[|A_E|Oe@dB[bAy@hBeClFW~@sGtTaBbGa@hB[pBeAbJYpA]r@kA|B[fAEpA?nCKzA[jBWbAi@xAeChFeAxBu@jE_@hFG`FC|Ay@EqF]wCOM@KJWr@gAzFSfAQl@Y|ACZEb@MfASn@Y^mA`@WJc@LNj@H^RtD`@tFLh@Rn@Rt@J|@E`@Qv@Uh@On@Cl@?v@FrA`@vI\\bI?FpGhwAh@tKL`ATrAtJz_@`Ij[H\\j@vBNl@HX|Ij^vChLvCjLjClKtGnWxBzIJ`@~FtUxFbUDLtBnIhCdK`GrUrBjIJd@jAtEv@|Cr@pChBlHDNxBtIzB`JzF~TzLnf@|AdGRdATbABN@PBFAD?D?D?F@DBBBDB@D@L\\Vh@p@tCxAzF`@~AJf@l@~BRv@T~@fB`Hj@zBjDbNH\\lE|Pb@fBt@zCTz@bBzGXlARhARtAx@tHLjAJ|@D^fFhe@R`BDf@D\\P~AXdCtAfMDb@pBvQF|@?j@ArBFj@BPIJELCP@PBNDLHHHBJ@@X|@dUJbCFrABdAJtB@^dA~V@F@Rj@hNl@zNp@zPHzAHlBHjBLnC?ZGAG@EDEFAHAJ@JBFMVSVWZY^g@n@oA`BQJWDB`@@j@JCG`BI|BCv@???NKtCM|AMVPZ\\p@~@dBR`@^n@r@pAl@fALRLRHPFXDX@Pf@rDFd@^lCDXL|@h@rEBRBd@AZa@vAy@hCKXw@`CK\\aAxCO`AKv@S~Ak@~EOfAQrAsDj[K`AqBvPwCrVaBdNIl@e@nEUrAUdAIVsAxDa@jAmDxJmBlFaHzRu@rBQb@o@jBSn@qAnDUl@Yv@[|@Qh@eDdJSn@a@lAkAfDCHELy@|BeBxESl@O^Sh@oCzHY|@Qf@qBtFs@pBaBxEo@jBe@hECZ_@vDQbB[|CMlAGd@C`@MfAU|BE^StBMp@KdAIlAc@rECNO~AGh@wCjY_CnUqDb^_Flf@oMtpAYpAe@nAo@hAe@pA]zAc@lBKVIFGJENAP@PDNFJHFF@VnAFzA@lAAfAIvBYtCcBdQaChUsClYy@`IgCtVYjDuDh_@}BnU}@jGsDfMwHvWgHdVGToKr^{CzJ_@nAqEjOyBtHyBvHq@xBc@jAe@t@g@t@m@h@sE`DgGvDoDxB}BfBiA|@}@bAyCjEsBxCe@j@cB~BEL]fASn@K|@DnATfCFdA@T@pAM`EA\\CfAOlBoAlMCZY~BMlAWnCg@fFGv@KvAAjACd@CtAEpB@`DEbGIxKCz@A`AEdFA|@CtA?NAZC`AM|GA`ASvIEvACj@QfFAb@EdACz@ObEe@tNCb@K|@qCdTy@rGwAzKuAzK]jC[nC{@pFOrA?^E\\Ox@Sv@IXDDJJFDNNPPn@j@JLNP`@`@xB|B|A~Aj@r@LPpA~Al@t@LDLCJENQLIb@YPCN?NDh@f@NRDJ@J@PEVETIXCJCHIXs@~AOZc@~@{@|BYp@g@rA_@z@w@`L]~BCTg@pDu@zEO|@s@nDmBnHQt@CtATn@\\j@~AfBpBtBJd@?`@If@w@lCAj@TXxBlBLJ`AnAbCfDnB`Dl@h@|BvAjBhBtA|Aj@dA`AvCdA`DT`AEBGLCNAPDTFHFFH@HAFEjAfGBZZbBJl@P~@Hb@F`@Pz@ZhBNbAvE|W`AfFjBrK?`@A`@AJAJBLBHDHHDF?L\\Hd@f@fDJl@r@~DP~@ZzA^`BxAdIl@jDRdAJj@Pp@Pl@Tl@Pf@P`@Vh@Zl@l@dAn@|@h@`AV^NZRb@L\\L`@J^H\\H^F^D^D`@Bh@Dr@@h@?l@?hABvF?jAAj@Aj@Ch@Cn@Gx@MlAKr@wArHGXG\\CLCFSdA}@rFoA|Ge@`D[|CMlBGn@E~@Et@EnD?X?lCD|B?PBbAFbBHjB?\\?HCFAFAH@H@HDFDDB@Jb@Z|BNbATxATnA`@nBLh@Nr@vAvF\\rAjAhEPr@Ld@dD~LNl@h@nBbAxDv@vCLV\\nAd@jBT|@Pd@b@lA`@nA`@nA^tAdAzD@LBPX~ALp@Jb@Tp@`@|ATf@Hn@DTn@dCVv@j@|AVr@FJ|BpIB\\d@fCNl@HPf@jBLd@JPBd@BHv@vCb@jAj@bBFFjAtEhAfGjAzFlFdWP`ANx@BN@L@\\A`@ILELELCNANAN@N@NBNBNDJDHFHFHFDHBNDNAFHBFFF|@dD`@dCNrAHp@Dd@@NDn@Fp@RdGXxHHhB?DDfBF`CNdEd@dND~@JrDDhE?zRAxRA`L?~VExIG|SArBAf@AZCLCBG@C@AF@F@^@`@@z@BbC@tB?|@b@hOFdBH~BFnBZfJV`I\\bKNbEFtBBz@R~FLnDLtDHtBJtBLzBJnBLrBPxCd@pDXzBHhADbAL`CHxD?pCzA`Tb@nF?L?L?P?TAZEVENAN@PBLFJHFDLFP@HJn@@JNfBLdBBZThDNjB^fFB`APzBBb@Dh@Fp@LdAlAnP@h@HjADj@B`@TnCB\\JtAL`BB`@B`@XzDDl@B^f@hHHxADjA@\\AXIPEP?R@RDNDHFHFDL@LAJIJOHQNOHAH?p@ApBLd@HVPZTz@l@Xd@Xp@XbBXxBFjAJrBBnA?xAClAJ`@QxHElAQnIsBf{@UnJyCboAI`D]tOc@lRMpFIzFG`HMtJBfK?~@@tB@bAB~CDjCBjCDjBBhBFjCJnDV~IJlCPlFj@zOPvEH|B|@jVr@fSbBdd@Bt@PdFH`CPxFJ~AP`GHfCHzDFxCD|BBjBB~BBrE@bB?pE?`DAfD?b@CrCEnEIvEOjGI`CIlCSrFq@bMi@dI_@tE_@zEO`BIp@O~Ao@lGy@nHeHhn@g@tE[vCe@~E_@lE]fEg@lHGdAa@vHYtHMlE_@jQO`GIpEMjFYvMc@xVO`H[jPGhCATYlOkAvl@a@lRAz@IlDKVGrBKdCQxAYxAYpAa@|AGTEDO@SPIRAX?JFZFLPHVALKHQRC\\AnBEH?FFFFBJBHFFFDF@HAFCFI@ABGBMJEFERCL@lAPTB@p@AlACz@Cp@Kt@UjAUhAIf@C`@Cv@@pDCVIZKLGPCV@TFTHLJXDpFD~AJxARrAVnAbAzClAlDFRfClHzAvDpAnC`CtEPXCL?P@PKj@[zAOx@Y`BCDG^Id@JXN\\rAxBrBzDVd@`CrEjBbD~AjCnCfE~BrDr@vAf@tAVz@P|@L`AFp@@LDh@Dn@Bn@@NVlERtEPbF?~A?FCl@Ez@?FC\\MlBAt@Ax@?`@?D@dA@|@BfA@xAExA?VIrEAx@AXCj@AvBAZAJEz@AHIf@StAC^Ad@Bz@B\\?HBVTrBRvANt@Hd@Pv@Jf@P`AV|ATnAxBxKpAnGbAbFR~@v@xDh@nBFVJh@BLh@nCx@jEb@zBj@pCJd@H`@h@tCF\\p@`DTjADRh@jC@FLn@^hBDXH\\DR@HJ`@H^Hd@BNb@xBf@fCJf@P|@DTDTBJb@tBz@fELp@H\\^pBDTz@hEBPBh@DVFX\\pBN|ABL@HH~@@TFn@@x@?lBDHH?N?F@~@FPBL@r@DL@J@fBLz@Fn@Dl@DL@\\DZ@tCRd@Bf@FXDJBTFd@VpBvAZTPLNJ`D~BJFtDdCJHLHjAx@RNDBtBvAlA|@^VTNLHEV}@dFCNFDh@^PLbBjAHFJFdAt@xAdAHFJHTNjCjBHFFB~DpCZVGTKRF`@jApGHd@@z@@bA@P?b@P?t@EXATAp@CFAZA\\E`BKr@GvDWXAPATA~@E^A^?fAQxAYrAWdASb@KB?JCN?PBJDNDVH^PnCtAXVN\\HZFl@^rHL`CLdBJxAF~@FnAFpAB\\Lv@Nd@BL^n@JPh@h@`BrAdB`BdA~@PFPFf@LrAf@zAn@ZTZT`@^|@v@zEbENL`AlA@@Vd@\\l@Rb@RZTr@b@tAFV\\nANf@Nf@vAvEHVpBfHJ`@V`AvA|Eb@|A^`BRv@Pf@JVf@t@X\\bAz@vAbAxD`DhA|@d@`@RPFDFFXTxE`EbAt@xC`CtFtEzAlA@@NLd@d@@?dAx@tAdAlGhFhDrCxAnAd@`@VTNLDDhCpBlB~AtExDpC~BxHjGXVVPFBAF?^F\\FPPRPHT?HVNb@v@xDrAlGj@nCHj@Jt@Hn@Jb@Lb@BHjCtLjGf[nAlGJl@rCtN~@tEBJDXH`@h@rC`@nBF^H^j@hCH\\ZtAf@jCH^d@~BN~@FV^jBLr@Px@l@|CJb@Hd@@BHd@F\\Jt@Jl@BLRrALx@BHBJVv@h@zCn@zDf@pCHf@RhAHj@BXD^@JNv@DRv@zDJd@Jb@Tp@DJRj@Ld@Ld@^~ALt@J^BJLh@FRBHFTH\\lAbGz@~DBP`A|EBJBHBFBJFNNTb@h@d@\\ZVxC|BlBxArAbAl@b@l@f@DDHJTf@Nf@Jj@Jb@xA`IJl@xAlHbBfJ@BHb@Jh@tBvKj@rCn@vDX|ABNBFNl@?B?H?F@HDJDHFDHBVNB@l@`@XRl@n@h@t@PZLZPh@Rp@Pt@ZpAv@bEb@vCD|@PdDLhBJfAXlB`@bB\\fAdAtDDXVx@Px@Hh@H|@D~@DnBC|CGvCGlCw@xQInCG`BAxA?zCFnE?v@B`AFpJ@xBB~BHrI@fBDzG?|@GjQAjC@pADhBBfBErCMzC?HSxEWrEo@~ImAlO[|DcAvMa@zCi@bCQZm@jBg@`Ai@|@u@`AsAdB_@f@oBfCuBlC_@j@Yd@Sh@Qp@Mr@Gv@Ev@Al@?l@Fp@Fl@Jj@Nj@^dA\\j@`@f@d@\\b@Tf@Tn@T^T\\VhAbAJ?vHvGvBnB`BzAd@\\d@l@`JxHhHpGzCrCdCbCxGpG~A|ArCpCdHdH~ChDzEdF`AdAHRz@~@d@h@fDzDdDpD`CxBdChBtBjAvAp@dBn@vC~@p@Jh@XdAj@lBpAbB`B`DxE\\j@pTt_@bBtCvBvDdGpKF`@DJBDr@vA`CpGLRpAvD^~@Tj@Zn@Xb@X`@PPt@h@hA^NDD@LFlNhALArDXbCRpGh@N@r@FL@V@F?Z@lBLpFd@dALlBPrBRj@DF@PDb@NvA^D?F?JERORIRCh@@`@DH?RBH@ZBb@DJ@F@F?vAJr@DPB\\B|CVb@BnCRVBXB@U?G?C?[C[K[CW?Wz@cOFaADu@RqDP_BP}@Ja@N]R[XWVQXMXCV?J?ARB\\QbD"}, "bounds": {"northeast": {"lat": 48.8633, "lng": 3.41451}, "southwest": {"lat": 48.70878, "lng": 2.29759}}, "summary": "", "legs": [{"distance": {"text": "80.6 km", "value": 80595}, "duration": {"text": "1 hour 39 mins", "value": 5952.1}, "start_location": {"lat": 48.709165, "lng": 2.402555}, "end_location": {"lat": 48.850036, "lng": 3.312646}}, {"distance": {"text": "10.4 km", "value": 10389.8}, "duration": {"text": "20 mins", "value": 1228.1}, "start_location": {"lat": 48.850036, "lng": 3.312646}, "end_location": {"lat": 48.850165, "lng": 3.41085}}, {"distance": {"text": "96.9 km", "value": 96859.3}, "duration": {"text": "1 hour 56 mins", "value": 6989.7}, "start_location": {"lat": 48.850165, "lng": 3.41085}, "end_location": {"lat": 48.708871, "lng": 2.302968}}]}]}
{"title": "DistanceRouteResponse", "type": "object", "description": "Attributes describing a distance route response.", "properties": {"status": {"title": "DistanceStatus", "type": "string", "description": "Returns more info on if the request was successful or not.\n * `OK` indicates the response contains a valid result.\n * `INVALID_REQUEST` indicates that the provided request was invalid (e.g. wrong URL syntax).\n * `MAX_ELEMENTS_EXCEEDED` indicates that the product of origins and destinations exceeds the per-query limit (fixed at 200 elts/q).\n * `MAX_ROUTE_LENGTH_EXCEEDED` indicates that at least one of requested route is too long and the matrix cannot be processed (>1000km).\n * `REQUEST_DENIED` indicates that the service denied use of the Distance API service (e.g. wrong API Key, wrong/no referer, \u2026).\n * `UNKNOWN_ERROR` indicates a Distance API request could not be processed due to a server error. The request may succeed if you try again.\n * `OVER_QUERY_LIMIT` (associated to a 429 status code) indicates that the number of queries per second (QPS) or the number of elements per second (EPS) exceed the [usage limits](https://developers.woosmap.com/products/distance-api/distance-matrix-endpoint/#usage-limits)\n", "enum": ["OK", "INVALID_REQUEST", "MAX_ELEMENTS_EXCEEDED", "MAX_ROUTE_LENGTH_EXCEEDED", "REQUEST_DENIED", "UNKNOWN_ERROR", "OVER_QUERY_LIMIT"]}, "routes": {"description": "Contains an array of routes from origin to destination (only one if alternatives is not specified)", "type": "array", "items": {"title": "DistanceRouteElementsResponse", "type": "object", "description": "Attributes describing routes from an origin to a destination returned in distance route response.", "properties": {"overview_polyline": {"type": "object", "description": "The polyline of the route (encoded with the [poyline algorithm](https://developers.google.com/maps/documentation/utilities/polylinealgorithm)).", "properties": {"points": {"type": "string"}}}, "bounds": {"title": "Bounds", "type": "object", "description": "A rectangle in geographical coordinates from points at the southwest and northeast corners.", "properties": {"northeast": {"title": "LatLngLiteral", "type": "object", "description": "An object describing a specific location with Latitude and Longitude in decimal degrees.", "required": ["lat", "lng"], "properties": {"lat": {"type": "number", "description": "Latitude in decimal degrees"}, "lng": {"type": "number", "description": "Longitude in decimal degrees"}}}, "southwest": {"title": "LatLngLiteral", "type": "object", "description": "An object describing a specific location with Latitude and Longitude in decimal degrees.", "required": ["lat", "lng"], "properties": {"lat": {"type": "number", "description": "Latitude in decimal degrees"}, "lng": {"type": "number", "description": "Longitude in decimal degrees"}}}}}, "summary": {"type": "string", "description": "A short name for the route."}, "legs": {"type": "array", "description": "Legs part of the route response", "items": {"title": "DistanceLeg", "type": "object", "description": "Leg in a route", "properties": {"distance": {"description": "The total distance covered by this leg.", "type": "object", "properties": {"value": {"description": "The distance in meter", "type": "number"}, "text": {"type": "string"}}}, "duration": {"description": "The total duration of this leg.", "type": "object", "properties": {"value": {"description": "The duration in seconds", "type": "number"}, "text": {"type": "string"}}}, "start_location": {"title": "LatLngLiteral", "type": "object", "description": "An object describing a specific location with Latitude and Longitude in decimal degrees.", "required": ["lat", "lng"], "properties": {"lat": {"type": "number", "description": "Latitude in decimal degrees"}, "lng": {"type": "number", "description": "Longitude in decimal degrees"}}}, "end_location": {"title": "LatLngLiteral", "type": "object", "description": "An object describing a specific location with Latitude and Longitude in decimal degrees.", "required": ["lat", "lng"], "properties": {"lat": {"type": "number", "description": "Latitude in decimal degrees"}, "lng": {"type": "number", "description": "Longitude in decimal degrees"}}}}}}}}}}}
975b58f7-85ea-4e68-b0ce-868ac028542a/1c5ac99f-3b82-4ddc-b491-411e98abfaee/1/0
Woosmap
Location-based Search Platform
7
getRoute
Get distance, duration and path (as a polyline) for a pair of origin and destination, based on the recommended route between those two points for a specified travel mode.
429
null
{"detail": "The rate limit for this endpoint has been exceeded"}
{"title": "Error429", "type": "object", "description": "Over Query Limit. Check the API Documentation for available QPS.", "properties": {"detail": {"description": "Details for the Over Query Limit error message", "type": "string"}}}
975b58f7-85ea-4e68-b0ce-868ac028542a/1c5ac99f-3b82-4ddc-b491-411e98abfaee/2/0
Woosmap
Location-based Search Platform
7
getRoute
Get distance, duration and path (as a polyline) for a pair of origin and destination, based on the recommended route between those two points for a specified travel mode.
403
null
{"detail": "This Woosmap API is not enabled for this project."}
{"title": "Error403", "type": "object", "description": "API Request is authenticated but API Key don't have permission to access the resources", "properties": {"detail": {"description": "Details for the forbidden error message", "type": "string"}}}
975b58f7-85ea-4e68-b0ce-868ac028542a/1c5ac99f-3b82-4ddc-b491-411e98abfaee/3/0
Woosmap
Location-based Search Platform
7
getRoute
Get distance, duration and path (as a polyline) for a pair of origin and destination, based on the recommended route between those two points for a specified travel mode.
401
null
{"detail": "Incorrect authentication credentials. Please check or use a valid API Key"}
{"title": "Error401", "type": "object", "description": "Authentication credentials are incorrect", "properties": {"detail": {"description": "Details for the credentials error", "type": "string"}}}
975b58f7-85ea-4e68-b0ce-868ac028542a/af49988f-db6d-46ef-81c1-ca1ffa159db9/0/0
Woosmap
Location-based Search Platform
7
postDistanceMatrix
Get distances and durations for a matrix of origins and destinations, based on the recommended route between start and end points for a specified travel mode. If the URL size is too short for your origins and destinations, you should request the server using this POST method and passing arguments as json.
403
null
{"detail": "This Woosmap API is not enabled for this project."}
{"title": "Error403", "type": "object", "description": "API Request is authenticated but API Key don't have permission to access the resources", "properties": {"detail": {"description": "Details for the forbidden error message", "type": "string"}}}
975b58f7-85ea-4e68-b0ce-868ac028542a/af49988f-db6d-46ef-81c1-ca1ffa159db9/1/0
Woosmap
Location-based Search Platform
7
postDistanceMatrix
Get distances and durations for a matrix of origins and destinations, based on the recommended route between start and end points for a specified travel mode. If the URL size is too short for your origins and destinations, you should request the server using this POST method and passing arguments as json.
401
null
{"detail": "Incorrect authentication credentials. Please check or use a valid API Key"}
{"title": "Error401", "type": "object", "description": "Authentication credentials are incorrect", "properties": {"detail": {"description": "Details for the credentials error", "type": "string"}}}
975b58f7-85ea-4e68-b0ce-868ac028542a/af49988f-db6d-46ef-81c1-ca1ffa159db9/2/0
Woosmap
Location-based Search Platform
7
postDistanceMatrix
Get distances and durations for a matrix of origins and destinations, based on the recommended route between start and end points for a specified travel mode. If the URL size is too short for your origins and destinations, you should request the server using this POST method and passing arguments as json.
429
null
{"detail": "The rate limit for this endpoint has been exceeded"}
{"title": "Error429", "type": "object", "description": "Over Query Limit. Check the API Documentation for available QPS.", "properties": {"detail": {"description": "Details for the Over Query Limit error message", "type": "string"}}}
975b58f7-85ea-4e68-b0ce-868ac028542a/af49988f-db6d-46ef-81c1-ca1ffa159db9/3/0
Woosmap
Location-based Search Platform
7
postDistanceMatrix
Get distances and durations for a matrix of origins and destinations, based on the recommended route between start and end points for a specified travel mode. If the URL size is too short for your origins and destinations, you should request the server using this POST method and passing arguments as json.
200
null
{"status": "OK", "rows": [{"elements": [{"status": "OK", "duration": {"value": 866, "text": "14 mins"}, "distance": {"value": 10613, "text": "10.6 km"}}, {"status": "OK", "duration": {"value": 935, "text": "16 mins"}, "distance": {"value": 10287, "text": "10.3 km"}}]}]}
{"title": "DistanceMatrixResponse", "type": "object", "description": "Attributes describing an distance Matrix response.", "properties": {"status": {"title": "DistanceStatus", "type": "string", "description": "Returns more info on if the request was successful or not.\n * `OK` indicates the response contains a valid result.\n * `INVALID_REQUEST` indicates that the provided request was invalid (e.g. wrong URL syntax).\n * `MAX_ELEMENTS_EXCEEDED` indicates that the product of origins and destinations exceeds the per-query limit (fixed at 200 elts/q).\n * `MAX_ROUTE_LENGTH_EXCEEDED` indicates that at least one of requested route is too long and the matrix cannot be processed (>1000km).\n * `REQUEST_DENIED` indicates that the service denied use of the Distance API service (e.g. wrong API Key, wrong/no referer, \u2026).\n * `UNKNOWN_ERROR` indicates a Distance API request could not be processed due to a server error. The request may succeed if you try again.\n * `OVER_QUERY_LIMIT` (associated to a 429 status code) indicates that the number of queries per second (QPS) or the number of elements per second (EPS) exceed the [usage limits](https://developers.woosmap.com/products/distance-api/distance-matrix-endpoint/#usage-limits)\n", "enum": ["OK", "INVALID_REQUEST", "MAX_ELEMENTS_EXCEEDED", "MAX_ROUTE_LENGTH_EXCEEDED", "REQUEST_DENIED", "UNKNOWN_ERROR", "OVER_QUERY_LIMIT"]}, "rows": {"description": "Contains an array of elements for each pair of origin and destination", "type": "array", "items": {"title": "DistanceMatrixElementsResponse", "type": "object", "description": "Attributes describing elements of origin and destination returned in distance Matrix response.", "properties": {"elements": {"type": "array", "description": "the route element", "items": {"title": "DistanceMatrixElementResponse", "type": "object", "description": "Attributes describing an element of origin and destination returned in distance Matrix response.", "properties": {"status": {"type": "string", "description": "Status returned for Distance Matrix Element Response.\n - `OK` indicates the response contains a valid result.\n - `NOT_FOUND` indicates that the origin and/or destination of this pairing could not be matched to the network.\n - `ZERO_RESULTS` indicates no route could be found between the origin and destination.\n", "enum": ["OK", "NOT_FOUND", "ZERO_RESULTS"]}, "duration": {"description": "The total duration to travel this route, expressed in seconds (value) and as text. The textual value gives a structured string for duration in the specified language (if available).", "type": "object", "properties": {"value": {"description": "The duration in seconds", "type": "number"}, "text": {"type": "string"}}}, "distance": {"description": "The total distance of this route, expressed in meters (value) and as text. The textual value uses the unit system specified with the units parameter of the original request.", "type": "object", "properties": {"value": {"description": "The distance in meter", "type": "number"}, "text": {"type": "string"}}}}}}}}}}}
975b58f7-85ea-4e68-b0ce-868ac028542a/af49988f-db6d-46ef-81c1-ca1ffa159db9/4/0
Woosmap
Location-based Search Platform
7
postDistanceMatrix
Get distances and durations for a matrix of origins and destinations, based on the recommended route between start and end points for a specified travel mode. If the URL size is too short for your origins and destinations, you should request the server using this POST method and passing arguments as json.
400
null
{"status": "error", "value": "The request is invalid, the data is not a valid JSON."}
{"title": "Error400", "type": "object", "description": "The request is invalid", "properties": {"status": {"type": "string", "description": "the status of the request"}, "value": {"description": "the value of request", "type": "string"}}}
975b58f7-85ea-4e68-b0ce-868ac028542a/2de36abe-2813-41e6-9b55-791b25efe460/0/0
Woosmap
Location-based Search Platform
7
getStoresFromGeolocationPosition
Retrieve the stores nearby an ip location. Stores are returned only if a relevant ip location is found - for an accuracy of 20km or less.
200
null
{"country_code": "US", "country_name": "United States", "continent": "North America", "latitude": 38.7304, "longitude": -77.0634, "accuracy": 5, "viewport": {"northeast": {"lat": 38.77531576420598, "lng": -77.00582296106178}, "southwest": {"lat": 38.68548423579403, "lng": -77.12097703893822}}, "city": "Alexandria", "region_state": "Virginia", "postal_code": "22308", "timezone": "America/New_York", "stores": {"type": "FeatureCollection", "features": [{"type": "Feature", "properties": {"store_id": "STORE_ID_123456", "name": "My Cool Store", "contact": {"email": "[email protected]", "phone": "+44 20 7693 4000", "website": "https://www.woosmap.com"}, "address": {"lines": ["Building Centre", "26 Store Street"], "country_code": "UK", "city": "London", "zipcode": "WC1E 7BT"}, "user_properties": {"some_user_properties": "associated user value"}, "tags": ["wifi", "covered_parking"], "types": ["drive", "click_and_collect"], "distance": 3972.39013285, "open": {"open_now": false, "open_hours": [], "week_day": 1, "next_opening": {"end": "22:00", "start": "08:30", "day": "2021-12-21"}}, "weekly_opening": {"1": {"hours": [], "isSpecial": false}, "2": {"hours": [{"end": "22:00", "start": "08:30"}], "isSpecial": false}, "3": {"hours": [{"end": "22:00", "start": "08:30"}], "isSpecial": false}, "4": {"hours": [{"end": "22:00", "start": "08:30"}], "isSpecial": false}, "5": {"hours": [{"end": "22:00", "start": "08:30"}], "isSpecial": false}, "6": {"hours": [{"end": "22:00", "start": "08:30"}], "isSpecial": false}, "7": {"hours": [{"end": "22:00", "start": "08:30"}], "isSpecial": false}, "timezone": "Europe/London"}, "opening_hours": {"usual": {"1": [], "default": [{"end": "22:00", "start": "08:30"}]}, "special": {"2015-02-07": [{"end": "23:00", "start": "08:00"}]}, "timezone": "Europe/London"}}, "geometry": {"type": "Point", "coordinates": [-77.1067, 38.719]}}, {"type": "Feature", "properties": {"store_id": "STORE_ID_45678", "name": "My Cool Store 2", "contact": {"email": "[email protected]", "phone": "+44 20 7693 4000", "website": "https://www.woosmap.com"}, "address": {"lines": ["1805-1899", "Orchard St"], "country_code": "US", "city": "Alexandria", "zipcode": "22309"}, "user_properties": {"some_user_properties": "associated user value"}, "tags": ["covered_parking"], "types": ["drive"], "distance": 23296.5115883, "open": {"open_now": false, "open_hours": [], "week_day": 1, "next_opening": {"end": "22:00", "start": "08:30", "day": "2021-12-21"}}, "weekly_opening": {"1": {"hours": [], "isSpecial": false}, "2": {"hours": [{"end": "22:00", "start": "08:30"}], "isSpecial": false}, "3": {"hours": [{"end": "22:00", "start": "08:30"}], "isSpecial": false}, "4": {"hours": [{"end": "22:00", "start": "08:30"}], "isSpecial": false}, "5": {"hours": [{"end": "22:00", "start": "08:30"}], "isSpecial": false}, "6": {"hours": [{"end": "22:00", "start": "08:30"}], "isSpecial": false}, "7": {"hours": [{"end": "22:00", "start": "08:30"}], "isSpecial": false}, "timezone": "America/New_York"}, "opening_hours": {"usual": {"1": [], "default": [{"end": "22:00", "start": "08:30"}]}, "timezone": "America/New_York"}}, "geometry": {"type": "Point", "coordinates": [-77.0157, 38.5239]}}], "pagination": {"page": 1, "pageCount": 1}}}
{"title": "GeolocationStoresResponse", "description": "A successful geolocation request will return a JSON-formatted response defining a location and radius.", "type": "object", "properties": {"stores": {"title": "AssetFeatureCollectionResponse", "type": "object", "description": "Assets Collection Response as a GeoJSon FeatureCollection with Asset properties", "properties": {"type": {"description": "the Geojson Type (only 'FeatureCollection')", "type": "string", "enum": ["FeatureCollection"]}, "features": {"description": "the Assets Features", "type": "array", "items": {"title": "AssetFeatureResponse", "type": "object", "description": "Asset Response as a GeoJSon Feature with Asset properties", "properties": {"type": {"description": "the Geojson Type (only 'Feature')", "type": "string", "enum": ["Feature"]}, "properties": {"title": "AssetResponse", "type": "object", "description": "Attributes describing an Asset.", "properties": {"name": {"description": "The asset's name.", "type": "string"}, "store_id": {"title": "AssetId", "description": "A textual identifier that uniquely identifies an Asset. It must matches the following regexp `[A-Za-z0-9]+`\n", "type": "string"}, "address": {"title": "AssetAddressResponse", "type": "object", "description": "An object containing the separate components applicable to this address.", "properties": {"lines": {"description": "An Array for lines of an Asset Address", "type": "array", "items": {"type": "string"}}, "country_code": {"description": "An ISO_3166-1 Country Code where the Asset is located (see <https://en.wikipedia.org/wiki/ISO_3166-1> for full list)", "type": ["string", "null"]}, "city": {"description": "A City where belongs an Asset", "type": "string"}, "zipcode": {"description": "An Zipcode / Postal code of an Asset Address", "type": "string"}}}, "contact": {"title": "AssetContact", "type": "object", "description": "An object containing the asset's contact available information.", "properties": {"website": {"description": "The website contact for this Asset, such as a business' homepage.", "type": "string"}, "phone": {"description": "Contains the Asset's phone number in its [local format](https://en.wikipedia.org/wiki/Local_conventions_for_writing_telephone_numbers).", "type": "string"}, "email": {"description": "Contains the Asset's email contact.", "type": "string"}}}, "open": {"title": "AssetOpenResponse", "type": "object", "description": "The Current opening status for an Asset", "properties": {"current_slice": {"title": "AssetOpeningHoursPeriod", "type": "object", "description": "The hours for an opening period. To define a slice of time where the asset is open you must define a `start` and `end` keys. `start` and `end` must belong to the same day (crossing midnight may result in open_now being always false.)", "required": ["start", "end"], "properties": {"start": {"description": "Contains a time of day in 24-hour hh:mm format for the begin of opening period. Values are in the range 00:00\u201323:59", "type": "string"}, "end": {"description": "Contains a time of day in 24-hour hh:mm format for the end of opening period. Values are in the range 00:00\u201323:59", "type": "string"}}}, "open_hours": {"description": "the opening hours for the day", "type": "array", "items": {"title": "AssetOpeningHoursPeriod", "type": "object", "description": "The hours for an opening period. To define a slice of time where the asset is open you must define a `start` and `end` keys. `start` and `end` must belong to the same day (crossing midnight may result in open_now being always false.)", "required": ["start", "end"], "properties": {"start": {"description": "Contains a time of day in 24-hour hh:mm format for the begin of opening period. Values are in the range 00:00\u201323:59", "type": "string"}, "end": {"description": "Contains a time of day in 24-hour hh:mm format for the end of opening period. Values are in the range 00:00\u201323:59", "type": "string"}}}}, "open_now": {"description": "Boolean value indicating the status of the opening hours", "type": "boolean"}, "next_opening": {"description": "the next opening hours period", "type": "object", "properties": {"end": {"description": "the hours of next opening", "type": "string"}, "start": {"description": "the hours of next closing", "type": "string"}, "day": {"type": "string", "description": "the day of next opening"}}}, "week_day": {"description": "the day of the week starting from 1 to 7", "type": "number", "enum": [1, 2, 3, 4, 5, 6, 7]}}}, "weekly_opening": {"title": "AssetWeeklyOpeningResponse", "type": "object", "description": "The current Weekly Opening taking into account the special hours", "properties": {"1": {"title": "AssetWeeklyOpeningHoursPeriod", "type": "object", "description": "The opening Hours for Monday", "properties": {"hours": {"type": "array", "items": {"title": "AssetOpeningHoursPeriod", "type": "object", "description": "The hours for an opening period. To define a slice of time where the asset is open you must define a `start` and `end` keys. `start` and `end` must belong to the same day (crossing midnight may result in open_now being always false.)", "required": ["start", "end"], "properties": {"start": {"description": "Contains a time of day in 24-hour hh:mm format for the begin of opening period. Values are in the range 00:00\u201323:59", "type": "string"}, "end": {"description": "Contains a time of day in 24-hour hh:mm format for the end of opening period. Values are in the range 00:00\u201323:59", "type": "string"}}}}, "isSpecial": {"type": "boolean", "description": "Define if the hours comes from a special opening hours day."}}}, "2": {"title": "AssetWeeklyOpeningHoursPeriod", "type": "object", "description": "The opening Hours for Monday", "properties": {"hours": {"type": "array", "items": {"title": "AssetOpeningHoursPeriod", "type": "object", "description": "The hours for an opening period. To define a slice of time where the asset is open you must define a `start` and `end` keys. `start` and `end` must belong to the same day (crossing midnight may result in open_now being always false.)", "required": ["start", "end"], "properties": {"start": {"description": "Contains a time of day in 24-hour hh:mm format for the begin of opening period. Values are in the range 00:00\u201323:59", "type": "string"}, "end": {"description": "Contains a time of day in 24-hour hh:mm format for the end of opening period. Values are in the range 00:00\u201323:59", "type": "string"}}}}, "isSpecial": {"type": "boolean", "description": "Define if the hours comes from a special opening hours day."}}}, "3": {"title": "AssetWeeklyOpeningHoursPeriod", "type": "object", "description": "The opening Hours for Monday", "properties": {"hours": {"type": "array", "items": {"title": "AssetOpeningHoursPeriod", "type": "object", "description": "The hours for an opening period. To define a slice of time where the asset is open you must define a `start` and `end` keys. `start` and `end` must belong to the same day (crossing midnight may result in open_now being always false.)", "required": ["start", "end"], "properties": {"start": {"description": "Contains a time of day in 24-hour hh:mm format for the begin of opening period. Values are in the range 00:00\u201323:59", "type": "string"}, "end": {"description": "Contains a time of day in 24-hour hh:mm format for the end of opening period. Values are in the range 00:00\u201323:59", "type": "string"}}}}, "isSpecial": {"type": "boolean", "description": "Define if the hours comes from a special opening hours day."}}}, "4": {"title": "AssetWeeklyOpeningHoursPeriod", "type": "object", "description": "The opening Hours for Monday", "properties": {"hours": {"type": "array", "items": {"title": "AssetOpeningHoursPeriod", "type": "object", "description": "The hours for an opening period. To define a slice of time where the asset is open you must define a `start` and `end` keys. `start` and `end` must belong to the same day (crossing midnight may result in open_now being always false.)", "required": ["start", "end"], "properties": {"start": {"description": "Contains a time of day in 24-hour hh:mm format for the begin of opening period. Values are in the range 00:00\u201323:59", "type": "string"}, "end": {"description": "Contains a time of day in 24-hour hh:mm format for the end of opening period. Values are in the range 00:00\u201323:59", "type": "string"}}}}, "isSpecial": {"type": "boolean", "description": "Define if the hours comes from a special opening hours day."}}}, "5": {"title": "AssetWeeklyOpeningHoursPeriod", "type": "object", "description": "The opening Hours for Monday", "properties": {"hours": {"type": "array", "items": {"title": "AssetOpeningHoursPeriod", "type": "object", "description": "The hours for an opening period. To define a slice of time where the asset is open you must define a `start` and `end` keys. `start` and `end` must belong to the same day (crossing midnight may result in open_now being always false.)", "required": ["start", "end"], "properties": {"start": {"description": "Contains a time of day in 24-hour hh:mm format for the begin of opening period. Values are in the range 00:00\u201323:59", "type": "string"}, "end": {"description": "Contains a time of day in 24-hour hh:mm format for the end of opening period. Values are in the range 00:00\u201323:59", "type": "string"}}}}, "isSpecial": {"type": "boolean", "description": "Define if the hours comes from a special opening hours day."}}}, "6": {"title": "AssetWeeklyOpeningHoursPeriod", "type": "object", "description": "The opening Hours for Monday", "properties": {"hours": {"type": "array", "items": {"title": "AssetOpeningHoursPeriod", "type": "object", "description": "The hours for an opening period. To define a slice of time where the asset is open you must define a `start` and `end` keys. `start` and `end` must belong to the same day (crossing midnight may result in open_now being always false.)", "required": ["start", "end"], "properties": {"start": {"description": "Contains a time of day in 24-hour hh:mm format for the begin of opening period. Values are in the range 00:00\u201323:59", "type": "string"}, "end": {"description": "Contains a time of day in 24-hour hh:mm format for the end of opening period. Values are in the range 00:00\u201323:59", "type": "string"}}}}, "isSpecial": {"type": "boolean", "description": "Define if the hours comes from a special opening hours day."}}}, "7": {"title": "AssetWeeklyOpeningHoursPeriod", "type": "object", "description": "The opening Hours for Monday", "properties": {"hours": {"type": "array", "items": {"title": "AssetOpeningHoursPeriod", "type": "object", "description": "The hours for an opening period. To define a slice of time where the asset is open you must define a `start` and `end` keys. `start` and `end` must belong to the same day (crossing midnight may result in open_now being always false.)", "required": ["start", "end"], "properties": {"start": {"description": "Contains a time of day in 24-hour hh:mm format for the begin of opening period. Values are in the range 00:00\u201323:59", "type": "string"}, "end": {"description": "Contains a time of day in 24-hour hh:mm format for the end of opening period. Values are in the range 00:00\u201323:59", "type": "string"}}}}, "isSpecial": {"type": "boolean", "description": "Define if the hours comes from a special opening hours day."}}}, "timezone": {"description": "Timezone for the Opening Hours of an Asset. It is used to compute the `open_now` property of an asset. see <https://en.wikipedia.org/wiki/List_of_tz_database_time_zones>", "type": "string"}}}, "types": {"description": "Contains an array of types describing the Asset.", "type": "array", "items": {"type": "string"}}, "tags": {"description": "Contains an array of tags describing the Asset. For example a list of available amenities.", "type": "array", "items": {"type": "string"}}, "user_properties": {"description": "Contains all additional information relative to an Asset", "type": ["object", "null"]}, "opening_hours": {"title": "AssetOpeningHours", "type": ["object", "null"], "description": "An object describing the opening hours of an Asset.", "properties": {"timezone": {"description": "Timezone for the Opening Hours of an Asset. It is used to compute the `open_now` property of an asset. see <https://en.wikipedia.org/wiki/List_of_tz_database_time_zones>", "type": "string"}, "usual": {"title": "AssetOpeningHoursUsual", "description": "An object describing the usual opening hours of an Asset.", "type": "object", "properties": {"1": {"description": "The opening Hours for Monday", "type": "array", "items": {"title": "AssetOpeningHoursPeriod", "type": "object", "description": "The hours for an opening period. To define a slice of time where the asset is open you must define a `start` and `end` keys. `start` and `end` must belong to the same day (crossing midnight may result in open_now being always false.)", "required": ["start", "end"], "properties": {"start": {"description": "Contains a time of day in 24-hour hh:mm format for the begin of opening period. Values are in the range 00:00\u201323:59", "type": "string"}, "end": {"description": "Contains a time of day in 24-hour hh:mm format for the end of opening period. Values are in the range 00:00\u201323:59", "type": "string"}}}}, "2": {"description": "The opening Hours for Tuesday", "type": "array", "items": {"title": "AssetOpeningHoursPeriod", "type": "object", "description": "The hours for an opening period. To define a slice of time where the asset is open you must define a `start` and `end` keys. `start` and `end` must belong to the same day (crossing midnight may result in open_now being always false.)", "required": ["start", "end"], "properties": {"start": {"description": "Contains a time of day in 24-hour hh:mm format for the begin of opening period. Values are in the range 00:00\u201323:59", "type": "string"}, "end": {"description": "Contains a time of day in 24-hour hh:mm format for the end of opening period. Values are in the range 00:00\u201323:59", "type": "string"}}}}, "3": {"description": "The opening Hours for Wednesday", "type": "array", "items": {"title": "AssetOpeningHoursPeriod", "type": "object", "description": "The hours for an opening period. To define a slice of time where the asset is open you must define a `start` and `end` keys. `start` and `end` must belong to the same day (crossing midnight may result in open_now being always false.)", "required": ["start", "end"], "properties": {"start": {"description": "Contains a time of day in 24-hour hh:mm format for the begin of opening period. Values are in the range 00:00\u201323:59", "type": "string"}, "end": {"description": "Contains a time of day in 24-hour hh:mm format for the end of opening period. Values are in the range 00:00\u201323:59", "type": "string"}}}}, "4": {"description": "The opening Hours for Thursday", "type": "array", "items": {"title": "AssetOpeningHoursPeriod", "type": "object", "description": "The hours for an opening period. To define a slice of time where the asset is open you must define a `start` and `end` keys. `start` and `end` must belong to the same day (crossing midnight may result in open_now being always false.)", "required": ["start", "end"], "properties": {"start": {"description": "Contains a time of day in 24-hour hh:mm format for the begin of opening period. Values are in the range 00:00\u201323:59", "type": "string"}, "end": {"description": "Contains a time of day in 24-hour hh:mm format for the end of opening period. Values are in the range 00:00\u201323:59", "type": "string"}}}}, "5": {"description": "The opening Hours for Friday", "type": "array", "items": {"title": "AssetOpeningHoursPeriod", "type": "object", "description": "The hours for an opening period. To define a slice of time where the asset is open you must define a `start` and `end` keys. `start` and `end` must belong to the same day (crossing midnight may result in open_now being always false.)", "required": ["start", "end"], "properties": {"start": {"description": "Contains a time of day in 24-hour hh:mm format for the begin of opening period. Values are in the range 00:00\u201323:59", "type": "string"}, "end": {"description": "Contains a time of day in 24-hour hh:mm format for the end of opening period. Values are in the range 00:00\u201323:59", "type": "string"}}}}, "6": {"description": "The opening Hours for Saturday", "type": "array", "items": {"title": "AssetOpeningHoursPeriod", "type": "object", "description": "The hours for an opening period. To define a slice of time where the asset is open you must define a `start` and `end` keys. `start` and `end` must belong to the same day (crossing midnight may result in open_now being always false.)", "required": ["start", "end"], "properties": {"start": {"description": "Contains a time of day in 24-hour hh:mm format for the begin of opening period. Values are in the range 00:00\u201323:59", "type": "string"}, "end": {"description": "Contains a time of day in 24-hour hh:mm format for the end of opening period. Values are in the range 00:00\u201323:59", "type": "string"}}}}, "7": {"description": "The opening Hours for Sunday", "type": "array", "items": {"title": "AssetOpeningHoursPeriod", "type": "object", "description": "The hours for an opening period. To define a slice of time where the asset is open you must define a `start` and `end` keys. `start` and `end` must belong to the same day (crossing midnight may result in open_now being always false.)", "required": ["start", "end"], "properties": {"start": {"description": "Contains a time of day in 24-hour hh:mm format for the begin of opening period. Values are in the range 00:00\u201323:59", "type": "string"}, "end": {"description": "Contains a time of day in 24-hour hh:mm format for the end of opening period. Values are in the range 00:00\u201323:59", "type": "string"}}}}, "default": {"description": "Contains the default opening hours to apply to all week days", "type": "array", "items": {"$ref": "#/components/schemas/AssetOpeningHoursPeriod"}}}}, "special": {"title": "AssetOpeningHoursSpecial", "description": "An object describing the special opening hours of an Asset.", "type": "object", "properties": {"2015-02-07": {"description": "The format for defining opening and closing hours for a particular day is the same as the usual. Instead of using numeric week day for keys you must use a date YYYY-MM-DD like \"2015-03-08\" (see ISO-8601).\n", "type": "array", "items": {"title": "AssetOpeningHoursPeriod", "type": "object", "description": "The hours for an opening period. To define a slice of time where the asset is open you must define a `start` and `end` keys. `start` and `end` must belong to the same day (crossing midnight may result in open_now being always false.)", "required": ["start", "end"], "properties": {"start": {"description": "Contains a time of day in 24-hour hh:mm format for the begin of opening period. Values are in the range 00:00\u201323:59", "type": "string"}, "end": {"description": "Contains a time of day in 24-hour hh:mm format for the end of opening period. Values are in the range 00:00\u201323:59", "type": "string"}}}}, "2015-02-08": {"type": "array", "items": {"title": "AssetOpeningHoursPeriod", "type": "object", "description": "The hours for an opening period. To define a slice of time where the asset is open you must define a `start` and `end` keys. `start` and `end` must belong to the same day (crossing midnight may result in open_now being always false.)", "required": ["start", "end"], "properties": {"start": {"description": "Contains a time of day in 24-hour hh:mm format for the begin of opening period. Values are in the range 00:00\u201323:59", "type": "string"}, "end": {"description": "Contains a time of day in 24-hour hh:mm format for the end of opening period. Values are in the range 00:00\u201323:59", "type": "string"}}}}}}}}, "distance": {"description": "The distance in meters from the geolocated position or searched position if exist", "type": "number"}}}, "geometry": {"title": "GeoJsonPoint", "type": "object", "description": "GeoJSon Point Geometry", "properties": {"type": {"type": "string", "enum": ["Point"], "description": "the geometry type"}, "coordinates": {"title": "LatLngArrayString", "description": "An array of comma separated {latitude,longitude} strings.", "type": "array", "items": {"type": "number", "minItems": 2, "maxItems": 2}}}}}}}, "pagination": {"title": "Pagination", "type": "object", "description": "Pagination to reach all returned assets. max 300 assets par page.", "properties": {"page": {"type": "integer", "description": "the request page"}, "pageCount": {"type": "integer", "description": "the number of available pages"}}}}}, "viewport": {"title": "Bounds", "type": "object", "description": "A rectangle in geographical coordinates from points at the southwest and northeast corners.", "properties": {"northeast": {"title": "LatLngLiteral", "type": "object", "description": "An object describing a specific location with Latitude and Longitude in decimal degrees.", "required": ["lat", "lng"], "properties": {"lat": {"type": "number", "description": "Latitude in decimal degrees"}, "lng": {"type": "number", "description": "Longitude in decimal degrees"}}}, "southwest": {"title": "LatLngLiteral", "type": "object", "description": "An object describing a specific location with Latitude and Longitude in decimal degrees.", "required": ["lat", "lng"], "properties": {"lat": {"type": "number", "description": "Latitude in decimal degrees"}, "lng": {"type": "number", "description": "Longitude in decimal degrees"}}}}}, "accuracy": {"description": "The accuracy of the estimated location, in meters. This represents the radius of a circle around the given `location` where the IP address is likely to be. If your Geolocation response shows a low value in the `accuracy` field (<=50), the IP has strong chance to be correctly located.", "type": "number"}, "latitude": {"description": "Approximate latitude of the geographical area associated with the IP address", "type": "number"}, "longitude": {"description": "Approximate longitude of the geographical area associated with the IP address", "type": "number"}, "country_code": {"description": "ISO 3166-1 Alpha-2 compatible country code", "type": ["string", "null"]}, "country_name": {"description": "Country name", "type": "string"}, "continent": {"description": "Continent name", "type": "string"}, "region_state": {"description": "Region name when available", "type": "string"}, "city": {"description": "City name when available", "type": "string"}, "postal_code": {"description": "A postal code close to the user's location, when available", "type": "string"}, "timezone": {"description": "The time zone associated with location, as specified by the IANA Time Zone Database", "type": "string"}}}
975b58f7-85ea-4e68-b0ce-868ac028542a/2de36abe-2813-41e6-9b55-791b25efe460/1/0
Woosmap
Location-based Search Platform
7
getStoresFromGeolocationPosition
Retrieve the stores nearby an ip location. Stores are returned only if a relevant ip location is found - for an accuracy of 20km or less.
401
null
{"detail": "Incorrect authentication credentials. Please check or use a valid API Key"}
{"title": "Error401", "type": "object", "description": "Authentication credentials are incorrect", "properties": {"detail": {"description": "Details for the credentials error", "type": "string"}}}
975b58f7-85ea-4e68-b0ce-868ac028542a/2de36abe-2813-41e6-9b55-791b25efe460/2/0
Woosmap
Location-based Search Platform
7
getStoresFromGeolocationPosition
Retrieve the stores nearby an ip location. Stores are returned only if a relevant ip location is found - for an accuracy of 20km or less.
403
null
{"detail": "This Woosmap API is not enabled for this project."}
{"title": "Error403", "type": "object", "description": "API Request is authenticated but API Key don't have permission to access the resources", "properties": {"detail": {"description": "Details for the forbidden error message", "type": "string"}}}
975b58f7-85ea-4e68-b0ce-868ac028542a/2de36abe-2813-41e6-9b55-791b25efe460/3/0
Woosmap
Location-based Search Platform
7
getStoresFromGeolocationPosition
Retrieve the stores nearby an ip location. Stores are returned only if a relevant ip location is found - for an accuracy of 20km or less.
429
null
{"detail": "The rate limit for this endpoint has been exceeded"}
{"title": "Error429", "type": "object", "description": "Over Query Limit. Check the API Documentation for available QPS.", "properties": {"detail": {"description": "Details for the Over Query Limit error message", "type": "string"}}}
975b58f7-85ea-4e68-b0ce-868ac028542a/bd13f92b-e1d5-4121-9f08-e95aa812f928/0/0
Woosmap
Location-based Search Platform
7
getGeolocationPosition
The /position returns JSON location of your users thanks to IP address of their devices.
403
null
{"detail": "This Woosmap API is not enabled for this project."}
{"title": "Error403", "type": "object", "description": "API Request is authenticated but API Key don't have permission to access the resources", "properties": {"detail": {"description": "Details for the forbidden error message", "type": "string"}}}
975b58f7-85ea-4e68-b0ce-868ac028542a/bd13f92b-e1d5-4121-9f08-e95aa812f928/1/0
Woosmap
Location-based Search Platform
7
getGeolocationPosition
The /position returns JSON location of your users thanks to IP address of their devices.
429
null
{"detail": "The rate limit for this endpoint has been exceeded"}
{"title": "Error429", "type": "object", "description": "Over Query Limit. Check the API Documentation for available QPS.", "properties": {"detail": {"description": "Details for the Over Query Limit error message", "type": "string"}}}
975b58f7-85ea-4e68-b0ce-868ac028542a/bd13f92b-e1d5-4121-9f08-e95aa812f928/2/0
Woosmap
Location-based Search Platform
7
getGeolocationPosition
The /position returns JSON location of your users thanks to IP address of their devices.
401
null
{"detail": "Incorrect authentication credentials. Please check or use a valid API Key"}
{"title": "Error401", "type": "object", "description": "Authentication credentials are incorrect", "properties": {"detail": {"description": "Details for the credentials error", "type": "string"}}}
975b58f7-85ea-4e68-b0ce-868ac028542a/bd13f92b-e1d5-4121-9f08-e95aa812f928/3/0
Woosmap
Location-based Search Platform
7
getGeolocationPosition
The /position returns JSON location of your users thanks to IP address of their devices.
200
null
{"country_code": "US", "country_name": "United States", "continent": "North America", "latitude": 38.7304, "longitude": -77.0634, "accuracy": 5, "viewport": {"northeast": {"lat": 38.77531576420598, "lng": -77.00582296106178}, "southwest": {"lat": 38.68548423579403, "lng": -77.12097703893822}}, "city": "Alexandria", "region_state": "Virginia", "postal_code": "22308", "timezone": "America/New_York"}
{"title": "GeolocationResponse", "type": "object", "description": "A successful geolocation request will return a JSON-formatted response defining a location and radius.", "properties": {"viewport": {"title": "Bounds", "type": "object", "description": "A rectangle in geographical coordinates from points at the southwest and northeast corners.", "properties": {"northeast": {"title": "LatLngLiteral", "type": "object", "description": "An object describing a specific location with Latitude and Longitude in decimal degrees.", "required": ["lat", "lng"], "properties": {"lat": {"type": "number", "description": "Latitude in decimal degrees"}, "lng": {"type": "number", "description": "Longitude in decimal degrees"}}}, "southwest": {"title": "LatLngLiteral", "type": "object", "description": "An object describing a specific location with Latitude and Longitude in decimal degrees.", "required": ["lat", "lng"], "properties": {"lat": {"type": "number", "description": "Latitude in decimal degrees"}, "lng": {"type": "number", "description": "Longitude in decimal degrees"}}}}}, "accuracy": {"description": "The accuracy of the estimated location, in meters. This represents the radius of a circle around the given `location` where the IP address is likely to be. If your Geolocation response shows a low value in the `accuracy` field (<=50), the IP has strong chance to be correctly located.", "type": "number"}, "latitude": {"description": "Approximate latitude of the geographical area associated with the IP address", "type": "number"}, "longitude": {"description": "Approximate longitude of the geographical area associated with the IP address", "type": "number"}, "country_code": {"description": "ISO 3166-1 Alpha-2 compatible country code", "type": ["string", "null"]}, "country_name": {"description": "Country name", "type": "string"}, "continent": {"description": "Continent name", "type": "string"}, "region_state": {"description": "Region name when available", "type": "string"}, "city": {"description": "City name when available", "type": "string"}, "postal_code": {"description": "A postal code close to the user's location, when available", "type": "string"}, "timezone": {"description": "The time zone associated with location, as specified by the IANA Time Zone Database", "type": "string"}}}
975b58f7-85ea-4e68-b0ce-868ac028542a/86abfb72-2f3f-4596-bdd6-d202544d28af/0/0
Woosmap
Location-based Search Platform
7
storeAutocomplete
Autocomplete on localizedNames with highlighted results on asset name. Use the field localized in your query parameter to search for localized names.
403
null
{"detail": "This Woosmap API is not enabled for this project."}
{"title": "Error403", "type": "object", "description": "API Request is authenticated but API Key don't have permission to access the resources", "properties": {"detail": {"description": "Details for the forbidden error message", "type": "string"}}}
975b58f7-85ea-4e68-b0ce-868ac028542a/86abfb72-2f3f-4596-bdd6-d202544d28af/1/0
Woosmap
Location-based Search Platform
7
storeAutocomplete
Autocomplete on localizedNames with highlighted results on asset name. Use the field localized in your query parameter to search for localized names.
401
null
{"detail": "Incorrect authentication credentials. Please check or use a valid API Key"}
{"title": "Error401", "type": "object", "description": "Authentication credentials are incorrect", "properties": {"detail": {"description": "Details for the credentials error", "type": "string"}}}
975b58f7-85ea-4e68-b0ce-868ac028542a/86abfb72-2f3f-4596-bdd6-d202544d28af/2/0
Woosmap
Location-based Search Platform
7
storeAutocomplete
Autocomplete on localizedNames with highlighted results on asset name. Use the field localized in your query parameter to search for localized names.
429
null
{"detail": "The rate limit for this endpoint has been exceeded"}
{"title": "Error429", "type": "object", "description": "Over Query Limit. Check the API Documentation for available QPS.", "properties": {"detail": {"description": "Details for the Over Query Limit error message", "type": "string"}}}
975b58f7-85ea-4e68-b0ce-868ac028542a/86abfb72-2f3f-4596-bdd6-d202544d28af/3/0
Woosmap
Location-based Search Platform
7
storeAutocomplete
Autocomplete on localizedNames with highlighted results on asset name. Use the field localized in your query parameter to search for localized names.
200
null
{"predictions": [{"store_id": "2670", "name": "Sun Street", "types": ["Coffee shop"], "matched_substrings": [{"offset": 4, "length": 6}], "highlighted": "Sun <b>Street</b>"}, {"store_id": "16069", "name": "7th Street", "types": ["Coffee shop"], "matched_substrings": [{"offset": 4, "length": 6}], "highlighted": "7th <b>Street</b>"}, {"store_id": "1013873", "name": "The Street", "types": ["Coffee shop"], "matched_substrings": [{"offset": 4, "length": 6}], "highlighted": "The <b>Street</b>"}, {"store_id": "1008896", "name": "12th Street", "types": ["Coffee shop"], "matched_substrings": [{"offset": 5, "length": 6}], "highlighted": "12th <b>Street</b>"}, {"store_id": "1023565", "name": "Doha Street", "types": ["Coffee shop"], "matched_substrings": [{"offset": 5, "length": 6}], "highlighted": "Doha <b>Street</b>"}]}
{"title": "AssetAutocompleteResponse", "type": "object", "description": "Asset Autocomplete Response with highlighted results on asset name.", "properties": {"predictions": {"description": "A list of predictions based on similarity in all the `localizedNames` passed in query (or similarity to `store_name` if no `localizedNames` exist)", "items": {"type": "object", "properties": {"name": {"description": "The `name` property of each prediction will be filled with the localized name of your asset in the `language` you provided in your query if it exists, or else the default name property.\n", "type": "string"}, "highlighted": {"type": "string", "description": "an HTML formatted string with, if it exists, the matched substring(s) in bold font."}, "store_id": {"title": "AssetId", "description": "A textual identifier that uniquely identifies an Asset. It must matches the following regexp `[A-Za-z0-9]+`\n", "type": "string"}, "types": {"description": "Contains an array of types describing the Asset.", "type": "array", "items": {"type": "string"}}, "matched_substrings": {"type": "array", "items": {"title": "MatchedSubstring", "type": "object", "properties": {"length": {"description": "Length of the matched substring in the prediction result text.", "type": "number"}, "offset": {"description": "Start location of the matched substring in the prediction result text.", "type": "number"}}}}}}}}}
975b58f7-85ea-4e68-b0ce-868ac028542a/7b0b1424-f712-4bf7-ac45-c68f828226c4/0/0
Woosmap
Location-based Search Platform
7
storeSearch
Used to retrieve assets from query
200
null
{"type": "FeatureCollection", "features": [{"type": "Feature", "properties": {"store_id": "2354", "name": "Berkeley Street/Berkeley Square", "contact": {"phone": "02076295779", "website": "https://www.starbucks.com/store-locator/store/2354/berkeley-street-berkeley-square-27-berkeley-st-berkeley-square-london-eng-w-1-x-5-"}, "address": {"lines": ["27 Berkeley St", "London, ENG W1X 5AD"], "country_code": "GB", "city": "London", "zipcode": "W1X 5AD"}, "user_properties": null, "tags": ["WA", "WF", "CD", "DR", "XO", "UE"], "types": ["Coffee shop"], "distance": 135.28682936, "open": {"open_now": true, "open_hours": [{"end": "18:00", "start": "06:30"}], "week_day": 1, "current_slice": {"end": "18:00", "start": "06:30"}}, "weekly_opening": {"1": {"hours": [{"end": "18:00", "start": "06:30"}], "isSpecial": false}, "2": {"hours": [{"end": "18:00", "start": "06:30"}], "isSpecial": false}, "3": {"hours": [{"end": "18:00", "start": "06:30"}], "isSpecial": false}, "4": {"hours": [{"end": "18:00", "start": "06:30"}], "isSpecial": false}, "5": {"hours": [{"end": "18:00", "start": "06:30"}], "isSpecial": false}, "6": {"hours": [{"end": "17:00", "start": "08:00"}], "isSpecial": false}, "7": {"hours": [{"end": "17:00", "start": "08:00"}], "isSpecial": false}, "timezone": "Europe/London"}, "opening_hours": {"usual": {"1": [{"end": "18:00", "start": "06:30"}], "2": [{"end": "18:00", "start": "06:30"}], "3": [{"end": "18:00", "start": "06:30"}], "4": [{"end": "18:00", "start": "06:30"}], "5": [{"end": "18:00", "start": "06:30"}], "6": [{"end": "17:00", "start": "08:00"}], "7": [{"end": "17:00", "start": "08:00"}]}, "timezone": "Europe/London"}}, "geometry": {"type": "Point", "coordinates": [-0.14408, 51.5088]}}, {"type": "Feature", "properties": {"store_id": "2671", "name": "Berkeley Street", "contact": {"phone": "02076294911", "website": "https://www.starbucks.com/store-locator/store/2671/berkeley-street-52-berkeley-st-london-eng-w-1-j-8-et-gb"}, "address": {"lines": ["52 Berkeley St.", "London, ENG W1J 8ET"], "country_code": "GB", "city": "London", "zipcode": "W1J 8ET"}, "user_properties": null, "tags": ["WA", "WF", "CD", "DR", "XO", "NB", "WC", "BC"], "types": ["Coffee shop"], "distance": 334.31148224, "open": {"open_now": true, "open_hours": [{"end": "18:00", "start": "06:30"}], "week_day": 1, "current_slice": {"end": "18:00", "start": "06:30"}}, "weekly_opening": {"1": {"hours": [{"end": "18:00", "start": "06:30"}], "isSpecial": false}, "2": {"hours": [{"end": "18:00", "start": "06:30"}], "isSpecial": false}, "3": {"hours": [{"end": "18:00", "start": "06:30"}], "isSpecial": false}, "4": {"hours": [{"end": "18:00", "start": "06:30"}], "isSpecial": false}, "5": {"hours": [{"end": "18:00", "start": "06:30"}], "isSpecial": false}, "6": {"hours": [{"end": "18:00", "start": "07:00"}], "isSpecial": false}, "7": {"hours": [{"end": "18:00", "start": "07:00"}], "isSpecial": false}, "timezone": "Europe/London"}, "opening_hours": {"usual": {"1": [{"end": "18:00", "start": "06:30"}], "2": [{"end": "18:00", "start": "06:30"}], "3": [{"end": "18:00", "start": "06:30"}], "4": [{"end": "18:00", "start": "06:30"}], "5": [{"end": "18:00", "start": "06:30"}], "6": [{"end": "18:00", "start": "07:00"}], "7": [{"end": "18:00", "start": "07:00"}]}, "timezone": "Europe/London"}}, "geometry": {"type": "Point", "coordinates": [-0.1424, 51.50735]}}, {"type": "Feature", "properties": {"store_id": "2888", "name": "Vigo Street", "contact": {"phone": "02077347632", "website": "https://www.starbucks.com/store-locator/store/2888/vigo-street-6-a-vigo-street-london-eng-w-1-s-3-hf-gb"}, "address": {"lines": ["6A Vigo Street", "London", "London, ENG W1S 3HF"], "country_code": "GB", "city": "London", "zipcode": "W1S 3HF"}, "user_properties": null, "tags": ["WA", "WF", "CD", "DR", "XO", "NB", "LU", "BA"], "types": ["Coffee shop"], "distance": 431.58415682, "open": {"open_now": true, "open_hours": [{"end": "18:00", "start": "07:00"}], "week_day": 1, "current_slice": {"end": "18:00", "start": "07:00"}}, "weekly_opening": {"1": {"hours": [{"end": "18:00", "start": "07:00"}], "isSpecial": false}, "2": {"hours": [{"end": "18:00", "start": "07:00"}], "isSpecial": false}, "3": {"hours": [{"end": "18:00", "start": "07:00"}], "isSpecial": false}, "4": {"hours": [{"end": "18:00", "start": "07:00"}], "isSpecial": false}, "5": {"hours": [{"end": "18:00", "start": "07:00"}], "isSpecial": false}, "6": {"hours": [{"end": "18:00", "start": "08:00"}], "isSpecial": false}, "7": {"hours": [{"end": "18:00", "start": "08:00"}], "isSpecial": false}, "timezone": "Europe/London"}, "opening_hours": {"usual": {"1": [{"end": "18:00", "start": "07:00"}], "2": [{"end": "18:00", "start": "07:00"}], "3": [{"end": "18:00", "start": "07:00"}], "4": [{"end": "18:00", "start": "07:00"}], "5": [{"end": "18:00", "start": "07:00"}], "6": [{"end": "18:00", "start": "08:00"}], "7": [{"end": "18:00", "start": "08:00"}]}, "timezone": "Europe/London"}}, "geometry": {"type": "Point", "coordinates": [-0.13912, 51.5103]}}, {"type": "Feature", "properties": {"store_id": "3047", "name": "West One Centre", "contact": {"phone": "020 76295404", "website": "https://www.starbucks.com/store-locator/store/3047/west-one-centre-381-oxford-street-west-one-centre-london-eng-w-1-c"}, "address": {"lines": ["381 Oxford Street", "Unit G13", "London, ENG W1C 2JS"], "country_code": "GB", "city": "London", "zipcode": "W1C 2JS"}, "user_properties": null, "tags": ["WA", "XO"], "types": ["Coffee shop"], "distance": 541.85737556, "open": {"open_now": true, "open_hours": [{"end": "18:00", "start": "08:00"}], "week_day": 1, "current_slice": {"end": "18:00", "start": "08:00"}}, "weekly_opening": {"1": {"hours": [{"end": "18:00", "start": "08:00"}], "isSpecial": false}, "2": {"hours": [{"end": "18:00", "start": "08:00"}], "isSpecial": false}, "3": {"hours": [{"end": "18:00", "start": "08:00"}], "isSpecial": false}, "4": {"hours": [{"end": "18:00", "start": "08:00"}], "isSpecial": false}, "5": {"hours": [{"end": "18:00", "start": "08:00"}], "isSpecial": false}, "6": {"hours": [{"end": "18:00", "start": "08:00"}], "isSpecial": false}, "7": {"hours": [{"end": "18:00", "start": "10:00"}], "isSpecial": false}, "timezone": "Europe/London"}, "opening_hours": {"usual": {"1": [{"end": "18:00", "start": "08:00"}], "2": [{"end": "18:00", "start": "08:00"}], "3": [{"end": "18:00", "start": "08:00"}], "4": [{"end": "18:00", "start": "08:00"}], "5": [{"end": "18:00", "start": "08:00"}], "6": [{"end": "18:00", "start": "08:00"}], "7": [{"end": "18:00", "start": "10:00"}]}, "timezone": "Europe/London"}}, "geometry": {"type": "Point", "coordinates": [-0.149374, 51.513905]}}, {"type": "Feature", "properties": {"store_id": "2606", "name": "Princes Street W1", "contact": {"phone": "02074958370", "website": "https://www.starbucks.com/store-locator/store/2606/princes-street-w-1-22-23-princes-st-london-eng-w-1-b-2-ly-gb"}, "address": {"lines": ["22-23 Princes St", "London, ENG W1B 2LY"], "country_code": "GB", "city": "London", "zipcode": "W1B 2LY"}, "user_properties": null, "tags": ["WA", "WF", "CD", "DR", "XO", "NB", "LU", "BA", "WC", "BC"], "types": ["Coffee shop"], "distance": 544.58185978, "open": {"open_now": true, "open_hours": [{"end": "18:00", "start": "07:00"}], "week_day": 1, "current_slice": {"end": "18:00", "start": "07:00"}}, "weekly_opening": {"1": {"hours": [{"end": "18:00", "start": "07:00"}], "isSpecial": false}, "2": {"hours": [{"end": "18:00", "start": "07:00"}], "isSpecial": false}, "3": {"hours": [{"end": "18:00", "start": "07:00"}], "isSpecial": false}, "4": {"hours": [{"end": "18:00", "start": "07:00"}], "isSpecial": false}, "5": {"hours": [{"end": "18:00", "start": "07:00"}], "isSpecial": false}, "6": {"hours": [{"end": "18:00", "start": "08:00"}], "isSpecial": false}, "7": {"hours": [{"end": "18:00", "start": "08:00"}], "isSpecial": false}, "timezone": "Europe/London"}, "opening_hours": {"usual": {"1": [{"end": "18:00", "start": "07:00"}], "2": [{"end": "18:00", "start": "07:00"}], "3": [{"end": "18:00", "start": "07:00"}], "4": [{"end": "18:00", "start": "07:00"}], "5": [{"end": "18:00", "start": "07:00"}], "6": [{"end": "18:00", "start": "08:00"}], "7": [{"end": "18:00", "start": "08:00"}]}, "timezone": "Europe/London"}}, "geometry": {"type": "Point", "coordinates": [-0.142534, 51.514346]}}, {"type": "Feature", "properties": {"store_id": "91351", "name": "Harewood Place", "contact": {"phone": "02074953936", "website": "https://www.starbucks.com/store-locator/store/91351/harewood-place-13-b-hanover-square-london-eng-w-1-s-1-hn-gb"}, "address": {"lines": ["13b Hanover Square", "London, ENG W1S 1HN"], "country_code": "GB", "city": "London", "zipcode": "W1S 1HN"}, "user_properties": null, "tags": ["WA", "WF", "RW", "CD", "DR", "XO", "NB", "LU", "BA", "BC"], "types": ["Coffee shop"], "distance": 554.73026581, "open": {"open_now": true, "open_hours": [{"end": "18:00", "start": "07:30"}], "week_day": 1, "current_slice": {"end": "18:00", "start": "07:30"}}, "weekly_opening": {"1": {"hours": [{"end": "18:00", "start": "07:30"}], "isSpecial": false}, "2": {"hours": [{"end": "18:00", "start": "07:30"}], "isSpecial": false}, "3": {"hours": [{"end": "18:00", "start": "07:30"}], "isSpecial": false}, "4": {"hours": [{"end": "18:00", "start": "07:30"}], "isSpecial": false}, "5": {"hours": [{"end": "18:00", "start": "07:30"}], "isSpecial": false}, "6": {"hours": [{"end": "18:00", "start": "08:00"}], "isSpecial": false}, "7": {"hours": [{"end": "18:00", "start": "08:00"}], "isSpecial": false}, "timezone": "Europe/London"}, "opening_hours": {"usual": {"1": [{"end": "18:00", "start": "07:30"}], "2": [{"end": "18:00", "start": "07:30"}], "3": [{"end": "18:00", "start": "07:30"}], "4": [{"end": "18:00", "start": "07:30"}], "5": [{"end": "18:00", "start": "07:30"}], "6": [{"end": "18:00", "start": "08:00"}], "7": [{"end": "18:00", "start": "08:00"}]}, "timezone": "Europe/London"}}, "geometry": {"type": "Point", "coordinates": [-0.14402, 51.514684]}}, {"type": "Feature", "properties": {"store_id": "2353", "name": "Carnaby Street", "contact": {"phone": "02074340778", "website": "https://www.starbucks.com/store-locator/store/2353/carnaby-street-34-great-marlborough-st-london-eng-w-1-f-7-jd-gb"}, "address": {"lines": ["34 Great Marlborough St", "(Carnaby Street)", "London, ENG W1F 7JD"], "country_code": "GB", "city": "London", "zipcode": "W1F 7JD"}, "user_properties": null, "tags": ["WA", "WF", "CD", "DR", "XO", "NB", "LU", "BA"], "types": ["Coffee shop"], "distance": 632.17523247, "open": {"open_now": true, "open_hours": [{"end": "18:00", "start": "07:30"}], "week_day": 1, "current_slice": {"end": "18:00", "start": "07:30"}}, "weekly_opening": {"1": {"hours": [{"end": "18:00", "start": "07:30"}], "isSpecial": false}, "2": {"hours": [{"end": "18:00", "start": "07:30"}], "isSpecial": false}, "3": {"hours": [{"end": "18:00", "start": "07:30"}], "isSpecial": false}, "4": {"hours": [{"end": "18:00", "start": "07:30"}], "isSpecial": false}, "5": {"hours": [{"end": "18:00", "start": "07:30"}], "isSpecial": false}, "6": {"hours": [{"end": "18:00", "start": "08:00"}], "isSpecial": false}, "7": {"hours": [{"end": "18:00", "start": "08:00"}], "isSpecial": false}, "timezone": "Europe/London"}, "opening_hours": {"usual": {"1": [{"end": "18:00", "start": "07:30"}], "2": [{"end": "18:00", "start": "07:30"}], "3": [{"end": "18:00", "start": "07:30"}], "4": [{"end": "18:00", "start": "07:30"}], "5": [{"end": "18:00", "start": "07:30"}], "6": [{"end": "18:00", "start": "08:00"}], "7": [{"end": "18:00", "start": "08:00"}]}, "timezone": "Europe/London"}}, "geometry": {"type": "Point", "coordinates": [-0.13925, 51.51402]}}, {"type": "Feature", "properties": {"store_id": "2626", "name": "James Street", "contact": {"phone": "02074956680", "website": "https://www.starbucks.com/store-locator/store/2626/james-street-14-james-street-london-eng-w-1-u-1-ef-gb"}, "address": {"lines": ["14 James Street", "London, ENG W1U 1EF"], "country_code": "GB", "city": "London", "zipcode": "W1U 1EF"}, "user_properties": null, "tags": ["WA", "WF", "CD", "DR", "XO", "NB"], "types": ["Coffee shop"], "distance": 649.62722685, "open": {"open_now": true, "open_hours": [{"end": "18:00", "start": "08:00"}], "week_day": 1, "current_slice": {"end": "18:00", "start": "08:00"}}, "weekly_opening": {"1": {"hours": [{"end": "18:00", "start": "08:00"}], "isSpecial": false}, "2": {"hours": [{"end": "18:00", "start": "08:00"}], "isSpecial": false}, "3": {"hours": [{"end": "18:00", "start": "08:00"}], "isSpecial": false}, "4": {"hours": [{"end": "18:00", "start": "08:00"}], "isSpecial": false}, "5": {"hours": [{"end": "18:00", "start": "08:00"}], "isSpecial": false}, "6": {"hours": [{"end": "18:00", "start": "08:00"}], "isSpecial": false}, "7": {"hours": [{"end": "18:00", "start": "08:00"}], "isSpecial": false}, "timezone": "Europe/London"}, "opening_hours": {"usual": {"1": [{"end": "18:00", "start": "08:00"}], "2": [{"end": "18:00", "start": "08:00"}], "3": [{"end": "18:00", "start": "08:00"}], "4": [{"end": "18:00", "start": "08:00"}], "5": [{"end": "18:00", "start": "08:00"}], "6": [{"end": "18:00", "start": "08:00"}], "7": [{"end": "18:00", "start": "08:00"}]}, "timezone": "Europe/London"}}, "geometry": {"type": "Point", "coordinates": [-0.15029, 51.51469]}}, {"type": "Feature", "properties": {"store_id": "2379", "name": "Cavendish Square", "contact": {"phone": "02076290191", "website": "https://www.starbucks.com/store-locator/store/2379/cavendish-square-33-cavendish-square-london-eng-w-1-g-0-pw-gb"}, "address": {"lines": ["33 Cavendish Square", "Unit 1", "London, ENG W1G 0PW"], "country_code": "GB", "city": "London", "zipcode": "W1G 0PW"}, "user_properties": null, "tags": ["WA", "WF", "CD", "DR", "XO", "NB", "LU", "BA", "BC"], "types": ["Coffee shop"], "distance": 714.77455167, "open": {"open_now": true, "open_hours": [{"end": "18:00", "start": "07:00"}], "week_day": 1, "current_slice": {"end": "18:00", "start": "07:00"}}, "weekly_opening": {"1": {"hours": [{"end": "18:00", "start": "07:00"}], "isSpecial": false}, "2": {"hours": [{"end": "18:00", "start": "07:00"}], "isSpecial": false}, "3": {"hours": [{"end": "18:00", "start": "07:00"}], "isSpecial": false}, "4": {"hours": [{"end": "18:00", "start": "07:00"}], "isSpecial": false}, "5": {"hours": [{"end": "18:00", "start": "07:00"}], "isSpecial": false}, "6": {"hours": [{"end": "18:00", "start": "08:00"}], "isSpecial": false}, "7": {"hours": [{"end": "18:00", "start": "09:00"}], "isSpecial": false}, "timezone": "Europe/London"}, "opening_hours": {"usual": {"1": [{"end": "18:00", "start": "07:00"}], "2": [{"end": "18:00", "start": "07:00"}], "3": [{"end": "18:00", "start": "07:00"}], "4": [{"end": "18:00", "start": "07:00"}], "5": [{"end": "18:00", "start": "07:00"}], "6": [{"end": "18:00", "start": "08:00"}], "7": [{"end": "18:00", "start": "09:00"}]}, "timezone": "Europe/London"}}, "geometry": {"type": "Point", "coordinates": [-0.14389, 51.516126]}}, {"type": "Feature", "properties": {"store_id": "2779", "name": "Langham Place W1", "contact": {"phone": "02075806199", "website": "https://www.starbucks.com/store-locator/store/2779/langham-place-w-1-1-2-langham-place-london-eng-w-1-b-3-de-gb"}, "address": {"lines": ["1 - 2 Langham Place", "London, ENG W1B 3DE"], "country_code": "GB", "city": "London", "zipcode": "W1B 3DE"}, "user_properties": null, "tags": ["WA", "WF", "CD", "DR", "XO", "NB", "LU", "BA", "BC"], "types": ["Coffee shop"], "distance": 877.89870518, "open": {"open_now": true, "open_hours": [{"end": "18:00", "start": "07:00"}], "week_day": 1, "current_slice": {"end": "18:00", "start": "07:00"}}, "weekly_opening": {"1": {"hours": [{"end": "18:00", "start": "07:00"}], "isSpecial": false}, "2": {"hours": [{"end": "18:00", "start": "07:00"}], "isSpecial": false}, "3": {"hours": [{"end": "18:00", "start": "07:00"}], "isSpecial": false}, "4": {"hours": [{"end": "18:00", "start": "07:00"}], "isSpecial": false}, "5": {"hours": [{"end": "18:00", "start": "07:00"}], "isSpecial": false}, "6": {"hours": [{"end": "18:00", "start": "08:00"}], "isSpecial": false}, "7": {"hours": [{"end": "18:00", "start": "08:00"}], "isSpecial": false}, "timezone": "Europe/London"}, "opening_hours": {"usual": {"1": [{"end": "18:00", "start": "07:00"}], "2": [{"end": "18:00", "start": "07:00"}], "3": [{"end": "18:00", "start": "07:00"}], "4": [{"end": "18:00", "start": "07:00"}], "5": [{"end": "18:00", "start": "07:00"}], "6": [{"end": "18:00", "start": "08:00"}], "7": [{"end": "18:00", "start": "08:00"}]}, "timezone": "Europe/London"}}, "geometry": {"type": "Point", "coordinates": [-0.142683, 51.517483]}}, {"type": "Feature", "properties": {"store_id": "2714", "name": "Wardour Street/Brewer Street", "contact": {"phone": "02072874834", "website": "https://www.starbucks.com/store-locator/store/2714/wardour-street-brewer-street-60-66-wardour-street-london-eng-w-1-f-0-ta-gb"}, "address": {"lines": ["60 - 66 Wardour Street", "Ground Floor", "London, ENG W1F 0TA"], "country_code": "GB", "city": "London", "zipcode": "W1F 0TA"}, "user_properties": null, "tags": ["WA", "WF", "CD", "DR", "XO", "NB", "LU", "BA", "WC"], "types": ["Coffee shop"], "distance": 893.47601826, "open": {"open_now": true, "open_hours": [{"end": "18:00", "start": "07:30"}], "week_day": 1, "current_slice": {"end": "18:00", "start": "07:30"}}, "weekly_opening": {"1": {"hours": [{"end": "18:00", "start": "07:30"}], "isSpecial": false}, "2": {"hours": [{"end": "18:00", "start": "07:30"}], "isSpecial": false}, "3": {"hours": [{"end": "18:00", "start": "07:30"}], "isSpecial": false}, "4": {"hours": [{"end": "18:00", "start": "07:30"}], "isSpecial": false}, "5": {"hours": [{"end": "18:00", "start": "07:30"}], "isSpecial": false}, "6": {"hours": [{"end": "18:00", "start": "08:00"}], "isSpecial": false}, "7": {"hours": [{"end": "18:00", "start": "08:00"}], "isSpecial": false}, "timezone": "Europe/London"}, "opening_hours": {"usual": {"1": [{"end": "18:00", "start": "07:30"}], "2": [{"end": "18:00", "start": "07:30"}], "3": [{"end": "18:00", "start": "07:30"}], "4": [{"end": "18:00", "start": "07:30"}], "5": [{"end": "18:00", "start": "07:30"}], "6": [{"end": "18:00", "start": "08:00"}], "7": [{"end": "18:00", "start": "08:00"}]}, "timezone": "Europe/London"}}, "geometry": {"type": "Point", "coordinates": [-0.133316, 51.512726]}}, {"type": "Feature", "properties": {"store_id": "2364", "name": "Wardour Street/Hollen Street", "contact": {"phone": "02072871956", "website": "https://www.starbucks.com/store-locator/store/2364/wardour-street-hollen-street-170-wardour-street-london-eng-w-1-v-4-la-gb"}, "address": {"lines": ["170 Wardour Street", "London, ENG W1V 4LA"], "country_code": "GB", "city": "London", "zipcode": "W1V 4LA"}, "user_properties": null, "tags": ["WA", "WF", "CD", "DR", "XO", "NB", "LU", "BA", "BC"], "types": ["Coffee shop"], "distance": 925.6334785, "open": {"open_now": true, "open_hours": [{"end": "18:00", "start": "07:00"}], "week_day": 1, "current_slice": {"end": "18:00", "start": "07:00"}}, "weekly_opening": {"1": {"hours": [{"end": "18:00", "start": "07:00"}], "isSpecial": false}, "2": {"hours": [{"end": "18:00", "start": "07:00"}], "isSpecial": false}, "3": {"hours": [{"end": "18:00", "start": "07:00"}], "isSpecial": false}, "4": {"hours": [{"end": "18:00", "start": "07:00"}], "isSpecial": false}, "5": {"hours": [{"end": "18:00", "start": "07:00"}], "isSpecial": false}, "6": {"hours": [{"end": "18:00", "start": "08:00"}], "isSpecial": false}, "7": {"hours": [{"end": "18:00", "start": "08:00"}], "isSpecial": false}, "timezone": "Europe/London"}, "opening_hours": {"usual": {"1": [{"end": "18:00", "start": "07:00"}], "2": [{"end": "18:00", "start": "07:00"}], "3": [{"end": "18:00", "start": "07:00"}], "4": [{"end": "18:00", "start": "07:00"}], "5": [{"end": "18:00", "start": "07:00"}], "6": [{"end": "18:00", "start": "08:00"}], "7": [{"end": "18:00", "start": "08:00"}]}, "timezone": "Europe/London"}}, "geometry": {"type": "Point", "coordinates": [-0.1353, 51.51528]}}], "pagination": {"page": 1, "pageCount": 1}}
{"title": "AssetFeatureCollectionResponse", "type": "object", "description": "Assets Collection Response as a GeoJSon FeatureCollection with Asset properties", "properties": {"type": {"description": "the Geojson Type (only 'FeatureCollection')", "type": "string", "enum": ["FeatureCollection"]}, "features": {"description": "the Assets Features", "type": "array", "items": {"title": "AssetFeatureResponse", "type": "object", "description": "Asset Response as a GeoJSon Feature with Asset properties", "properties": {"type": {"description": "the Geojson Type (only 'Feature')", "type": "string", "enum": ["Feature"]}, "properties": {"title": "AssetResponse", "type": "object", "description": "Attributes describing an Asset.", "properties": {"name": {"description": "The asset's name.", "type": "string"}, "store_id": {"title": "AssetId", "description": "A textual identifier that uniquely identifies an Asset. It must matches the following regexp `[A-Za-z0-9]+`\n", "type": "string"}, "address": {"title": "AssetAddressResponse", "type": "object", "description": "An object containing the separate components applicable to this address.", "properties": {"lines": {"description": "An Array for lines of an Asset Address", "type": "array", "items": {"type": "string"}}, "country_code": {"description": "An ISO_3166-1 Country Code where the Asset is located (see <https://en.wikipedia.org/wiki/ISO_3166-1> for full list)", "type": ["string", "null"]}, "city": {"description": "A City where belongs an Asset", "type": "string"}, "zipcode": {"description": "An Zipcode / Postal code of an Asset Address", "type": "string"}}}, "contact": {"title": "AssetContact", "type": "object", "description": "An object containing the asset's contact available information.", "properties": {"website": {"description": "The website contact for this Asset, such as a business' homepage.", "type": "string"}, "phone": {"description": "Contains the Asset's phone number in its [local format](https://en.wikipedia.org/wiki/Local_conventions_for_writing_telephone_numbers).", "type": "string"}, "email": {"description": "Contains the Asset's email contact.", "type": "string"}}}, "open": {"title": "AssetOpenResponse", "type": "object", "description": "The Current opening status for an Asset", "properties": {"current_slice": {"title": "AssetOpeningHoursPeriod", "type": "object", "description": "The hours for an opening period. To define a slice of time where the asset is open you must define a `start` and `end` keys. `start` and `end` must belong to the same day (crossing midnight may result in open_now being always false.)", "required": ["start", "end"], "properties": {"start": {"description": "Contains a time of day in 24-hour hh:mm format for the begin of opening period. Values are in the range 00:00\u201323:59", "type": "string"}, "end": {"description": "Contains a time of day in 24-hour hh:mm format for the end of opening period. Values are in the range 00:00\u201323:59", "type": "string"}}}, "open_hours": {"description": "the opening hours for the day", "type": "array", "items": {"title": "AssetOpeningHoursPeriod", "type": "object", "description": "The hours for an opening period. To define a slice of time where the asset is open you must define a `start` and `end` keys. `start` and `end` must belong to the same day (crossing midnight may result in open_now being always false.)", "required": ["start", "end"], "properties": {"start": {"description": "Contains a time of day in 24-hour hh:mm format for the begin of opening period. Values are in the range 00:00\u201323:59", "type": "string"}, "end": {"description": "Contains a time of day in 24-hour hh:mm format for the end of opening period. Values are in the range 00:00\u201323:59", "type": "string"}}}}, "open_now": {"description": "Boolean value indicating the status of the opening hours", "type": "boolean"}, "next_opening": {"description": "the next opening hours period", "type": "object", "properties": {"end": {"description": "the hours of next opening", "type": "string"}, "start": {"description": "the hours of next closing", "type": "string"}, "day": {"type": "string", "description": "the day of next opening"}}}, "week_day": {"description": "the day of the week starting from 1 to 7", "type": "number", "enum": [1, 2, 3, 4, 5, 6, 7]}}}, "weekly_opening": {"title": "AssetWeeklyOpeningResponse", "type": "object", "description": "The current Weekly Opening taking into account the special hours", "properties": {"1": {"title": "AssetWeeklyOpeningHoursPeriod", "type": "object", "description": "The opening Hours for Monday", "properties": {"hours": {"type": "array", "items": {"title": "AssetOpeningHoursPeriod", "type": "object", "description": "The hours for an opening period. To define a slice of time where the asset is open you must define a `start` and `end` keys. `start` and `end` must belong to the same day (crossing midnight may result in open_now being always false.)", "required": ["start", "end"], "properties": {"start": {"description": "Contains a time of day in 24-hour hh:mm format for the begin of opening period. Values are in the range 00:00\u201323:59", "type": "string"}, "end": {"description": "Contains a time of day in 24-hour hh:mm format for the end of opening period. Values are in the range 00:00\u201323:59", "type": "string"}}}}, "isSpecial": {"type": "boolean", "description": "Define if the hours comes from a special opening hours day."}}}, "2": {"title": "AssetWeeklyOpeningHoursPeriod", "type": "object", "description": "The opening Hours for Monday", "properties": {"hours": {"type": "array", "items": {"title": "AssetOpeningHoursPeriod", "type": "object", "description": "The hours for an opening period. To define a slice of time where the asset is open you must define a `start` and `end` keys. `start` and `end` must belong to the same day (crossing midnight may result in open_now being always false.)", "required": ["start", "end"], "properties": {"start": {"description": "Contains a time of day in 24-hour hh:mm format for the begin of opening period. Values are in the range 00:00\u201323:59", "type": "string"}, "end": {"description": "Contains a time of day in 24-hour hh:mm format for the end of opening period. Values are in the range 00:00\u201323:59", "type": "string"}}}}, "isSpecial": {"type": "boolean", "description": "Define if the hours comes from a special opening hours day."}}}, "3": {"title": "AssetWeeklyOpeningHoursPeriod", "type": "object", "description": "The opening Hours for Monday", "properties": {"hours": {"type": "array", "items": {"title": "AssetOpeningHoursPeriod", "type": "object", "description": "The hours for an opening period. To define a slice of time where the asset is open you must define a `start` and `end` keys. `start` and `end` must belong to the same day (crossing midnight may result in open_now being always false.)", "required": ["start", "end"], "properties": {"start": {"description": "Contains a time of day in 24-hour hh:mm format for the begin of opening period. Values are in the range 00:00\u201323:59", "type": "string"}, "end": {"description": "Contains a time of day in 24-hour hh:mm format for the end of opening period. Values are in the range 00:00\u201323:59", "type": "string"}}}}, "isSpecial": {"type": "boolean", "description": "Define if the hours comes from a special opening hours day."}}}, "4": {"title": "AssetWeeklyOpeningHoursPeriod", "type": "object", "description": "The opening Hours for Monday", "properties": {"hours": {"type": "array", "items": {"title": "AssetOpeningHoursPeriod", "type": "object", "description": "The hours for an opening period. To define a slice of time where the asset is open you must define a `start` and `end` keys. `start` and `end` must belong to the same day (crossing midnight may result in open_now being always false.)", "required": ["start", "end"], "properties": {"start": {"description": "Contains a time of day in 24-hour hh:mm format for the begin of opening period. Values are in the range 00:00\u201323:59", "type": "string"}, "end": {"description": "Contains a time of day in 24-hour hh:mm format for the end of opening period. Values are in the range 00:00\u201323:59", "type": "string"}}}}, "isSpecial": {"type": "boolean", "description": "Define if the hours comes from a special opening hours day."}}}, "5": {"title": "AssetWeeklyOpeningHoursPeriod", "type": "object", "description": "The opening Hours for Monday", "properties": {"hours": {"type": "array", "items": {"title": "AssetOpeningHoursPeriod", "type": "object", "description": "The hours for an opening period. To define a slice of time where the asset is open you must define a `start` and `end` keys. `start` and `end` must belong to the same day (crossing midnight may result in open_now being always false.)", "required": ["start", "end"], "properties": {"start": {"description": "Contains a time of day in 24-hour hh:mm format for the begin of opening period. Values are in the range 00:00\u201323:59", "type": "string"}, "end": {"description": "Contains a time of day in 24-hour hh:mm format for the end of opening period. Values are in the range 00:00\u201323:59", "type": "string"}}}}, "isSpecial": {"type": "boolean", "description": "Define if the hours comes from a special opening hours day."}}}, "6": {"title": "AssetWeeklyOpeningHoursPeriod", "type": "object", "description": "The opening Hours for Monday", "properties": {"hours": {"type": "array", "items": {"title": "AssetOpeningHoursPeriod", "type": "object", "description": "The hours for an opening period. To define a slice of time where the asset is open you must define a `start` and `end` keys. `start` and `end` must belong to the same day (crossing midnight may result in open_now being always false.)", "required": ["start", "end"], "properties": {"start": {"description": "Contains a time of day in 24-hour hh:mm format for the begin of opening period. Values are in the range 00:00\u201323:59", "type": "string"}, "end": {"description": "Contains a time of day in 24-hour hh:mm format for the end of opening period. Values are in the range 00:00\u201323:59", "type": "string"}}}}, "isSpecial": {"type": "boolean", "description": "Define if the hours comes from a special opening hours day."}}}, "7": {"title": "AssetWeeklyOpeningHoursPeriod", "type": "object", "description": "The opening Hours for Monday", "properties": {"hours": {"type": "array", "items": {"title": "AssetOpeningHoursPeriod", "type": "object", "description": "The hours for an opening period. To define a slice of time where the asset is open you must define a `start` and `end` keys. `start` and `end` must belong to the same day (crossing midnight may result in open_now being always false.)", "required": ["start", "end"], "properties": {"start": {"description": "Contains a time of day in 24-hour hh:mm format for the begin of opening period. Values are in the range 00:00\u201323:59", "type": "string"}, "end": {"description": "Contains a time of day in 24-hour hh:mm format for the end of opening period. Values are in the range 00:00\u201323:59", "type": "string"}}}}, "isSpecial": {"type": "boolean", "description": "Define if the hours comes from a special opening hours day."}}}, "timezone": {"description": "Timezone for the Opening Hours of an Asset. It is used to compute the `open_now` property of an asset. see <https://en.wikipedia.org/wiki/List_of_tz_database_time_zones>", "type": "string"}}}, "types": {"description": "Contains an array of types describing the Asset.", "type": "array", "items": {"type": "string"}}, "tags": {"description": "Contains an array of tags describing the Asset. For example a list of available amenities.", "type": "array", "items": {"type": "string"}}, "user_properties": {"description": "Contains all additional information relative to an Asset", "type": ["object", "null"]}, "opening_hours": {"title": "AssetOpeningHours", "type": ["object", "null"], "description": "An object describing the opening hours of an Asset.", "properties": {"timezone": {"description": "Timezone for the Opening Hours of an Asset. It is used to compute the `open_now` property of an asset. see <https://en.wikipedia.org/wiki/List_of_tz_database_time_zones>", "type": "string"}, "usual": {"title": "AssetOpeningHoursUsual", "description": "An object describing the usual opening hours of an Asset.", "type": "object", "properties": {"1": {"description": "The opening Hours for Monday", "type": "array", "items": {"title": "AssetOpeningHoursPeriod", "type": "object", "description": "The hours for an opening period. To define a slice of time where the asset is open you must define a `start` and `end` keys. `start` and `end` must belong to the same day (crossing midnight may result in open_now being always false.)", "required": ["start", "end"], "properties": {"start": {"description": "Contains a time of day in 24-hour hh:mm format for the begin of opening period. Values are in the range 00:00\u201323:59", "type": "string"}, "end": {"description": "Contains a time of day in 24-hour hh:mm format for the end of opening period. Values are in the range 00:00\u201323:59", "type": "string"}}}}, "2": {"description": "The opening Hours for Tuesday", "type": "array", "items": {"title": "AssetOpeningHoursPeriod", "type": "object", "description": "The hours for an opening period. To define a slice of time where the asset is open you must define a `start` and `end` keys. `start` and `end` must belong to the same day (crossing midnight may result in open_now being always false.)", "required": ["start", "end"], "properties": {"start": {"description": "Contains a time of day in 24-hour hh:mm format for the begin of opening period. Values are in the range 00:00\u201323:59", "type": "string"}, "end": {"description": "Contains a time of day in 24-hour hh:mm format for the end of opening period. Values are in the range 00:00\u201323:59", "type": "string"}}}}, "3": {"description": "The opening Hours for Wednesday", "type": "array", "items": {"title": "AssetOpeningHoursPeriod", "type": "object", "description": "The hours for an opening period. To define a slice of time where the asset is open you must define a `start` and `end` keys. `start` and `end` must belong to the same day (crossing midnight may result in open_now being always false.)", "required": ["start", "end"], "properties": {"start": {"description": "Contains a time of day in 24-hour hh:mm format for the begin of opening period. Values are in the range 00:00\u201323:59", "type": "string"}, "end": {"description": "Contains a time of day in 24-hour hh:mm format for the end of opening period. Values are in the range 00:00\u201323:59", "type": "string"}}}}, "4": {"description": "The opening Hours for Thursday", "type": "array", "items": {"title": "AssetOpeningHoursPeriod", "type": "object", "description": "The hours for an opening period. To define a slice of time where the asset is open you must define a `start` and `end` keys. `start` and `end` must belong to the same day (crossing midnight may result in open_now being always false.)", "required": ["start", "end"], "properties": {"start": {"description": "Contains a time of day in 24-hour hh:mm format for the begin of opening period. Values are in the range 00:00\u201323:59", "type": "string"}, "end": {"description": "Contains a time of day in 24-hour hh:mm format for the end of opening period. Values are in the range 00:00\u201323:59", "type": "string"}}}}, "5": {"description": "The opening Hours for Friday", "type": "array", "items": {"title": "AssetOpeningHoursPeriod", "type": "object", "description": "The hours for an opening period. To define a slice of time where the asset is open you must define a `start` and `end` keys. `start` and `end` must belong to the same day (crossing midnight may result in open_now being always false.)", "required": ["start", "end"], "properties": {"start": {"description": "Contains a time of day in 24-hour hh:mm format for the begin of opening period. Values are in the range 00:00\u201323:59", "type": "string"}, "end": {"description": "Contains a time of day in 24-hour hh:mm format for the end of opening period. Values are in the range 00:00\u201323:59", "type": "string"}}}}, "6": {"description": "The opening Hours for Saturday", "type": "array", "items": {"title": "AssetOpeningHoursPeriod", "type": "object", "description": "The hours for an opening period. To define a slice of time where the asset is open you must define a `start` and `end` keys. `start` and `end` must belong to the same day (crossing midnight may result in open_now being always false.)", "required": ["start", "end"], "properties": {"start": {"description": "Contains a time of day in 24-hour hh:mm format for the begin of opening period. Values are in the range 00:00\u201323:59", "type": "string"}, "end": {"description": "Contains a time of day in 24-hour hh:mm format for the end of opening period. Values are in the range 00:00\u201323:59", "type": "string"}}}}, "7": {"description": "The opening Hours for Sunday", "type": "array", "items": {"title": "AssetOpeningHoursPeriod", "type": "object", "description": "The hours for an opening period. To define a slice of time where the asset is open you must define a `start` and `end` keys. `start` and `end` must belong to the same day (crossing midnight may result in open_now being always false.)", "required": ["start", "end"], "properties": {"start": {"description": "Contains a time of day in 24-hour hh:mm format for the begin of opening period. Values are in the range 00:00\u201323:59", "type": "string"}, "end": {"description": "Contains a time of day in 24-hour hh:mm format for the end of opening period. Values are in the range 00:00\u201323:59", "type": "string"}}}}, "default": {"description": "Contains the default opening hours to apply to all week days", "type": "array", "items": {"$ref": "#/components/schemas/AssetOpeningHoursPeriod"}}}}, "special": {"title": "AssetOpeningHoursSpecial", "description": "An object describing the special opening hours of an Asset.", "type": "object", "properties": {"2015-02-07": {"description": "The format for defining opening and closing hours for a particular day is the same as the usual. Instead of using numeric week day for keys you must use a date YYYY-MM-DD like \"2015-03-08\" (see ISO-8601).\n", "type": "array", "items": {"title": "AssetOpeningHoursPeriod", "type": "object", "description": "The hours for an opening period. To define a slice of time where the asset is open you must define a `start` and `end` keys. `start` and `end` must belong to the same day (crossing midnight may result in open_now being always false.)", "required": ["start", "end"], "properties": {"start": {"description": "Contains a time of day in 24-hour hh:mm format for the begin of opening period. Values are in the range 00:00\u201323:59", "type": "string"}, "end": {"description": "Contains a time of day in 24-hour hh:mm format for the end of opening period. Values are in the range 00:00\u201323:59", "type": "string"}}}}, "2015-02-08": {"type": "array", "items": {"title": "AssetOpeningHoursPeriod", "type": "object", "description": "The hours for an opening period. To define a slice of time where the asset is open you must define a `start` and `end` keys. `start` and `end` must belong to the same day (crossing midnight may result in open_now being always false.)", "required": ["start", "end"], "properties": {"start": {"description": "Contains a time of day in 24-hour hh:mm format for the begin of opening period. Values are in the range 00:00\u201323:59", "type": "string"}, "end": {"description": "Contains a time of day in 24-hour hh:mm format for the end of opening period. Values are in the range 00:00\u201323:59", "type": "string"}}}}}}}}, "distance": {"description": "The distance in meters from the geolocated position or searched position if exist", "type": "number"}}}, "geometry": {"title": "GeoJsonPoint", "type": "object", "description": "GeoJSon Point Geometry", "properties": {"type": {"type": "string", "enum": ["Point"], "description": "the geometry type"}, "coordinates": {"title": "LatLngArrayString", "description": "An array of comma separated {latitude,longitude} strings.", "type": "array", "items": {"type": "number", "minItems": 2, "maxItems": 2}}}}}}}, "pagination": {"title": "Pagination", "type": "object", "description": "Pagination to reach all returned assets. max 300 assets par page.", "properties": {"page": {"type": "integer", "description": "the request page"}, "pageCount": {"type": "integer", "description": "the number of available pages"}}}}}
975b58f7-85ea-4e68-b0ce-868ac028542a/7b0b1424-f712-4bf7-ac45-c68f828226c4/1/0
Woosmap
Location-based Search Platform
7
storeSearch
Used to retrieve assets from query
401
null
{"detail": "Incorrect authentication credentials. Please check or use a valid API Key"}
{"title": "Error401", "type": "object", "description": "Authentication credentials are incorrect", "properties": {"detail": {"description": "Details for the credentials error", "type": "string"}}}
975b58f7-85ea-4e68-b0ce-868ac028542a/7b0b1424-f712-4bf7-ac45-c68f828226c4/2/0
Woosmap
Location-based Search Platform
7
storeSearch
Used to retrieve assets from query
403
null
{"detail": "This Woosmap API is not enabled for this project."}
{"title": "Error403", "type": "object", "description": "API Request is authenticated but API Key don't have permission to access the resources", "properties": {"detail": {"description": "Details for the forbidden error message", "type": "string"}}}
975b58f7-85ea-4e68-b0ce-868ac028542a/7b0b1424-f712-4bf7-ac45-c68f828226c4/3/0
Woosmap
Location-based Search Platform
7
storeSearch
Used to retrieve assets from query
429
null
{"detail": "The rate limit for this endpoint has been exceeded"}
{"title": "Error429", "type": "object", "description": "Over Query Limit. Check the API Documentation for available QPS.", "properties": {"detail": {"description": "Details for the Over Query Limit error message", "type": "string"}}}
85ac8588-c1bb-4cde-af5c-befac19a670b/b5983572-b378-44b1-9091-e8739f248b72/0/0
HONG KONG ID Card OCR
Extraction of information including name, gender, English name, identity card number, name code, head portrait, etc. from Hong Kong Identity Card images.
6.6
HONG KONG ID Card OCR
Support jpg, png, bmp, pdf, tiff, single-frame gif and other formats, the image size does not exceed 10M.
200
Response
{"code": "200", "status": "SUCCESS", "date": "11/22/2023 11:41:32 PM", "result": {"rotated_image_height": 491, "image_angle": 0, "rotated_image_width": 781, "item_list": [{"value": "/9j/4AAQSkZJRgABAQAAAQABAAD/2wBDAAIBAQEBAQIBAQECAgICAgQDAgICAgUEBAMEBgUGBgYFBgYGBwkIBgcJBwYGCAsICQoKCgoKBggLDAsKDAkKCgr/2wBDAQICAgICAgUDAwUKBwYHCgoKCgoKCgoKCgoKCgoKCgoKCgoKCgoKCgoKCgoKCgoKCgoKCgoKCgoKCgoKCgoKCgr/wAARCAD3AMMDASIAAhEBAxEB/8QAHwAAAQUBAQEBAQEAAAAAAAAAAAECAwQFBgcICQoL/8QAtRAAAgEDAwIEAwUFBAQAAAF9AQIDAAQRBRIhMUEGE1FhByJxFDKBkaEII0KxwRVS0fAkM2JyggkKFhcYGRolJicoKSo0NTY3ODk6Q0RFRkdISUpTVFVWV1hZWmNkZWZnaGlqc3R1dnd4eXqDhIWGh4iJipKTlJWWl5iZmqKjpKWmp6ipqrKztLW2t7i5usLDxMXGx8jJytLT1NXW19jZ2uHi4+Tl5ufo6erx8vP09fb3+Pn6/8QAHwEAAwEBAQEBAQEBAQAAAAAAAAECAwQFBgcICQoL/8QAtREAAgECBAQDBAcFBAQAAQJ3AAECAxEEBSExBhJBUQdhcRMiMoEIFEKRobHBCSMzUvAVYnLRChYkNOEl8RcYGRomJygpKjU2Nzg5OkNERUZHSElKU1RVVldYWVpjZGVmZ2hpanN0dXZ3eHl6goOEhYaHiImKkpOUlZaXmJmaoqOkpaanqKmqsrO0tba3uLm6wsPExcbHyMnK0tPU1dbX2Nna4uPk5ebn6Onq8vP09fb3+Pn6/9oADAMBAAIRAxEAPwD66fXJrxTBp9uWLH74HAqzBoqXEQN9IXbuD0qxYwWthEUjAUdarz6mZJTbaeNx7lRmvmJb6H2TkiwzQWcSs7LGF/Wmq+oanKsWmW5IYffI4FWtJ8Lvqkgm1YkqOq5rqdL0m30xNseFX3pJc2iOWpWUUY+g+DJIH/0/94cdxwTW3PHb2kZLyqoHVe5qwL0rOsFkhY92AyBViLw9buou70bieqmt44dT3PIq4l30Ma6j1HUp/Ks02xj7xPfNTWXhj7OgkeX5++a272O1skbzGVEAGMVh3XiaO7Y22ng/LwWx1rohhUkjy61ROV2LfzxWAPnyLkDO0d6oSyXmr2gaJfLjLYIbqB6026ls3G+7O5gOCTVHU/GGlWFtlryNAgydzgZH41v7BWOOTnJGhDptlaKGEu5u+6lvb20t1VTKGcdvSvOdX+Ofhc3HlweILdQhw2ZVxn86rW/xu+G7fvG8X2DSNwd12vB/OnGlB7GThJx91HoU63GpqYpJAsXardhb21oRHDHnHevPE/aA+F8My2MvjjS1lP3Yzepn+ddFpXjzTbyQSWOoQyIcY8uVW/lWioQuzOVCUbNnW+XIH3qgJPbFXbaFlt8OcHHNYUevRzMEjnUt6Bq2NPv4rmAkyjg4PPeqlRuiHF8zLFnEwfjnnrip2tiu5tvU0llsL/K1W/mdtoIwBVfV1YyUdLlcQsYsBep5p0VqWYDGPpWhBbpJHgDGOamhtVL5ApKgKzvoZS2rK5TGecDNTPbEgZHIGMCtD7IC574PpUhsVkJZT2pyoNq5Lje+pnW8XlqQfWo2ScT7RHxjPStOGw2ghuefWo3hC5bd06VPsnHUzaSKnynlnwe4oqUxxsdxQH8KKz9mw5WeQWmk6j4ht/8ASiYod3UDBxW7pmh2FggWBBkDBdu9E+o2VhHtM4JJ4RagkttT1JxJE5iix90HkV4E6jnKz2P0+rI1o9StoZPIgQux6belX9N0/UNSuBLeSBUU/Ko7/wCeKp6Jp1tYqN0eW/vHrWuNXhsoyIlJkP3Vrsw0VY87ES927NaC1trVWVYgvHDYqlqevRQ7jaqZABwF7mqj3d/qVqzXRMIAyMcVQvL+206N/KQDaOCxr04RPJlJyeg2/upfmkv5clxwmegrjPiL8U/Cfw60aXV9b1OCzgiQszSSAE15b+2D+254K/Z40oLfXi3GoXC/ureFhkeufzFfmR+0x+2d47/aD1mVLjUZYdMDEJbRTfeH+12FV5IUaak9T6z/AGhf+CtVjoepnQfhVp0d6xjP+lSNkKT9K+WviR+3/wDG34gTPY6pqSwlx87WrkBBXhyeJ7JJBHZyrJnhrpxj8qyp/E2jfa3snH2lkkOXU8U1C/xFKnBM7y++O/jIx41DxFcuZMjmZsfnmub1b4ka7eSkf27LHjk7Z2x/OuO1TU9R1CUwNdrFEp4wnQVBb6XYXkuVvJyTwSRxWsYpIppJHQT+Krx7lb6+8R3DSA/K6zsMY/Gu8+HP7aHxa+FDSR+F/HOoFZAuxfNLg47HNeSNZWyTJApJCH5i/Ap+oaZaxbCluHkP3VilxkVTjGW5MlpY+u/Af/BXb4+2exvENxbyWynkRRAyEf1r7W/ZB/4KHaN8bW/sbW5lt7xwjRtt2hs54x68V+K4hu9P1FlCNBMmSqs3eu6+Ev7SfiL4aahFf6BqTW9zHKN0n3h8pz+FQ4SWsSZUaco2sf0P+HvFENzGkgmySm7Ga6Sx1FZiGD8NX45/Cj/gs14l03WLTTvEbW8cQZY7id1JJHqBX3t+yr+2d4I+PPhb+07DxNayXgnZRaxSjeYweGIPtV+011OOeE5Vc+r7W4ixgN261ciXcMR9zXG6B4qtZ1Vd3BTP48V1FhfhlDL0zWys3qcjpWZdFm4YFXHXmpJoVHAbHvTbcNIdxY+tTuitwwzTT1M/Zsjt48tsDA57mo5bQDdyOtWYoCvKetV2BDFSTuz0pSMpwWzKjFFONv6UVI4+Y/J+tFc/KzO1M8rs/DcAffdZklBzzV29v0sYiHcBmbpVGXXmvEaHTo2Zs4LdADTLLQpY5Gu7+4Ls3RD0FfKat+9sfpM3YuWd/d6pIVtlZEU8MeM10Om6fHFiWZtze/asi1ubazi86bbGo96c2tSTny7XJDA5J7V6GGvZWPPxCtGxoeJPEmn2ERikmGTwBu618yftcftpeDvgVpEr+INSS3mMbvb2iuC8g7A/jXqPxQ8VaL4D8L6j4t1+UGPT7d7iZifuIoyTX4l/tTfFTW/2g/i5qXjXUb6RIrq6Js7V5crFH2HtXrJNnmqPMyL4/wD7RXjP9oHxlL4u8RXOLaSdmijHAjj7D9K8a1nx0rXE+mWrJBahyJFz80x+vatTxX4gsreyXSPImjaHcmQvDHjnr0rlPDugxX16z3kZdQS2TjjPrmtYwiVdJaEl1rd3JArXGoRhAcJBC3KH3PeqVvrbWd1ttLGaaMsDIwbGeaux/De91+6eytbkK5k3Er0UfXpUHiqyi8KWIs59bgV4zgMH5zj2q0khqzK974j8RXWqPG9r9ngyMKW7VXPjHxLYzvbrPGiA/K4k5IrmNS+JN3IfIj1KGUDgu6HJrM1KYXQN19t3TSDmHJA/CrjG72BqSZ2SfEGW4nC3WqYXcQTKe9LqnxPOlBJra5FywP8ArUGNo9K8uc6hcOYH3EI2Qq84p03nKoWNmP8Ae9K1lTW4kr6s7vVPi9qGvXXnXMwVweZB1NU7TxbNaTNIJy8UhHmjHSuLKPOp28Ec8VPaagzwG3H8IwTnrSUbbCae1z0i/mSayXVdLuAWRQ7qDyVHSu9+AP7V3j74Oa3Br3gfWZbe8iZdyr0Kg9CK8e+Hl/JJqS2dyCUkVk68Va1SP+zPFTW1nGqEgkPvwM55pcsXoyUfu5+wZ/wUOj+O3h0t4uubO1ubYxRsXlCsxKrk4+tfa/hnxha6okbQ3KsmByrZBHFfzI/C34hXngXWPMi1+5topjlpIZiMHtxX6/f8E1P2rrDxP4U03wx4j8Wme98plXz5CWbATHWufmdOdmY1KSkro/SKxvN67VP1q5G2W3A5Fcj4V1pNQto5o5Rggc5611trLDjCkVsmcM4lmBztIUkZPUVXcR7y5DkjrxVmJ1UlQAc1DMsvOxeO4zVaSuc1RW1RVeLc5YDrRT2ZQxGaK57My5WeYWtrbW0ICbVC1V1PXRBMsFlGbhv4lUdKgeDVNUBWSTy1J42cHFaNrpkFrEisgYqMbj1r5DmSep+izu1oVrbS5tQYS37scc7Q3FaF55NjZM0SgEDg4p4CRDcq8gdqyvEmptDYlwueeRXqYWTlY4K22h8a/wDBXf41XPgH9nmbw/puupHd67fJbTRKfmMIwWX6Hivx58V+L7x2crdbfKX97k9T2xX1b/wVH+K2sePPj9q2hXWrGez0y522tr52I4n2RAsewI5/Wvib4j6zZFfK0y1aRtuJM9/92vYhyvQ4VctX3ioeIHS61bUWeRVCbs4JA6Vc0rXNMt/LjuZ2MPOUJ+99a89Sa6tLmNGs8uOfLJ3MM+3ar9rba5rd4LeyRfm4GBytbculhONkdR4q+MN9plqNJ0m5EMTD5hCvT8a4iPTtZ8Qs92WuJy5ypKlq9r+C37IGs+PL4XeqRSiIuATICQPzFfZfwn/Yh8D6BawR3mnJJmMBmEYGaOZQjpuKXLvc/NyL4T+JmgF8dGkYDkEwnn9K1JPgt4rnht7+xtpH8xcNHt+63p0r9Xv+GUPAU9kbSLRo1BGBkdKqf8Mb+FbKQJawqqMcufL7/lSVaQOSsfnv8G/2ddT1uJbjVPDUhlAIc7eCMcVH4w/Ze1nSreeQ6M0YDk/d7flX6eeEf2fNA0GwFpaaeCc5c7dvFS+Jf2d/D+uWjWklgELD5sJnNRztk8ytc/HPxb8JJ9BjZUt3EpHKgVwMmlXFnJIkkbK2Txiv1h+Kf7CWlapbyS2JAkI4Kx18mfFz9jTWtG1yXTdO09pCAS8giPH44rWE7x1BtN6Hy94cvZtOv4p95Co+WFWfEU8c+spqIm3eZITkHoCc16Pqv7N2taYjSX4MKhsFwCf0NcD4i8FyaHrBikkkeONiMFCN2D6VompPQa1ROdSurd4IZXIMjgJ64r7F/YO+N+ieBPiBpCeJb8mBJACV6jO0dq+KJhqGoXUUyRyqI2wpdTxXqXwg8UJp2swxm0AYSBWkI+Y8iiqrxJZ/SP8ABnx3pHiPw3Y6jod4JbaeFXiKHOFwCv6Yr1zQ7l7iESF+T1FfAP8AwTH+M6a74Eg8KTOfPtoMq7ScbMDA+uK+7fDFz5tkknmAfLyAayjeyOGquWVjrLVmJHNLLM3IB/Sq+nNIeh79zT3RJGLb2G3qM8Volc46t+hEysxzkUU2RG3nDDH1ornszmsefQ2vlJv6ECkOWXcw4zUyvujYY6VC7kQge9fFauV5H6PLZiSTRD5MHmuC+M/iRPC3gjVNeILNZWE0igtgZEZYH81FdrdSeV+8J4FeOftf6sll8CfE90XK7tJmXKdsqR/WvZwmyOCs+5+IHxI8RX/iLxbq3izWgPtWp3UrPJI+4Hc2T1/CvNfiprXh7w1bRaJp7QXU+z53VBx+Nd/4+XTZ7abU5rchbY/IXYhX7c/lXgOrzyeKPEk19DGBGXG0Zr3KUYs893Or+D/wzvviLrqwiOTEjgmdh0HPFfY3wd/Zi8G6NBC8+lxyzbPnZosgn615z+yJ4LQJFc28DYVASWA5619l/D/wkJbeGRosAkAbetFSeot+hP8AC74ZaZpGUt9MijjXkIRzXsHh7wirJGvkrjPAGaq+D/B07yfvIiBnkivS/C/hkKkTsD15rP5GehW0zwJDIg86FT9P/wBVaT+CbFYgPsmfQEV2VlpEcQCKvGB1q2dOjZcbBT7EXbRwkXhOIjAt1UjvjtSyeFYY+WiH4V2smnLGeF6ntUF5YL5eQuT6U1a+or6Hmeu+FrSMFRHhuxAzXnXjP4S6Rqtw11JYJJkHdhME17xquhGRWdgPXFc3f6OMtlcYHT1pNXGrXPmPxr+z14KuLFjP4ZiODk5HP8q+Hv2xfhjZ+D/FzppGlotvK7BR5fKnJr9QfG+mEW8n+0eeK+Ff28tCeG6lmZfuykq3rmmrRlcqNtj4nk0OSOQB3O4yDag789K7LRvCdreXi6nYS+VtwSvTBA5zXGeJNZlt7rdHIQ0UmVx26iuu+EutSa1NJZvMBujY4PUtxXQ3zu7Kd7n6Ef8ABMnx/rFhqsOkbS8nkgBoRkFeOTX6x/DTWRqFhsfepCKWLjHOK/Jv/gk1oGoXXjOa7lsjJDDbKu8DIB4zX61+AtPhW0DIMF0BI+lJaLQ4a71O4spGODEcjParTqFQsTziqen5iGEGee9XC2Rkr2rRJWOGo9iLap5xRSNJhscCisTM8/LIvGcZ7VHMAF2qDTgV545zwfamMxVdzDPPeviVGzufoc3dFe8TehXA6V89/t86hJpv7N3iJoWw0lsI+GwQCy5P5Z/OvoeVSIiSvevHP2tfATePvgzrvhqWR086yYqY1DHcCCB+hr2cErtXPOrvQ/Cz9oDWjeWUmi2Wlww2/msCY1wMDuQK8S0PThb3xViCA4zivbPjjoOo6Vq1/ZXHzFL51IcgZjB54z9OK8y8JaO+veJlsI4sNJcKu1PrXvQSSdzju9z7a/Yw8HyX3hW3mjh+UhRvZOO/evrv4d+C2tyiPMPlOQBXm37NHgS18L+A9PsltfL2wqXPHJxXqV5480HwyFt47tPOA+ZcEn9BXPdmT3ser+HdFjiY7o4wM9q7LSbKGNVUIuM9BXztF+07pehL5+oRQQxH70k8jLj8xXQeHv20fhRqd1Fp/wDb9qJMjIVmOf0pNq+pNm9UfREVsMDyiOlWRAhUAde+a5Lwp8StG161WbS7uNl254Jrqra5FzGGjYZIB6001bQzasiK4iKk7mHtUMSRMP3hBNWb6SGKEGU89+a5jxJ4s03RoGup9QihjUfekbAq2KzNO8itYgUkVct3rmdeit4AWLKNwPSvGvih+3T8M/A2oNYPrlpNcIcCJWdiT+AriNO/bbh8YGUWqRrziPbG/Q/UVN1bQqEJWdz1nxfHFcRFVZTk9M18b/8ABQHwxNNo/wDaENvkAEPtX07mvoaD4rW+oTxS3NygVvvHaeDXO/HnwvpfxD8GyK8O9ZYnw6j1Xg00veKvy6n48+K2iXUW3MQBMckdxzxWn8IrsW3i6COS5ZUkLAMCeM1q/GbwU/hnxPcafBbHbHLJ9/HUMR/Ss74a2Ukfie1nmhBCvl1OMbc12O0YDbuz9jP+CO/gC90/4fXHia5BZbqTbE+0kuvrmv0Z8I2xt7NW6cY4NfMv/BO/wlYaH+zz4ZSztliaWwR5ApHLFFJ/Wvqvw9bqtsFIrKFrHn1rN6G9ppQD8fSnyCfkBMD1pLGJYmGD1NOZpGcjPFao46jdiLAHDEk96KVkbceKK5Xa5hzHmNldGVR8/wBatmMPHy9c14XuzLEjs3BA3A+uK6KJ9sYLDvXx/K0fojakgaEsvzevFcx4/wBCj1PSprO4kASdWjfrkAg811xkKrlRk+mKyvEcEDWTSyj5Ry5x2Ar1MG9Dgrp8tj8I/wBt34V3fgL4n61aXgPkx3UxjcjIYYUj+deTfsleDpNf+KcUbRK6m6jb5vXNfo5/wUu8H6J8TfCt62gaeF1GCdsSCEfvBhRycegr4/8A+CfvgSW7+MF2kgO20aI4x0Oa9vnvDQ4VzR3P0A8JeGY7Lw7FbeSF2oBgfSoz4AsNRuCzQIX5y0ig5r0Cx0NFsMBS4wOo9q81+N3xJuvh3p4bSdLeabfgKik5rLWxF9diHU/2dvAerYOraLbOV+6cGsVv2WPAum3a6np9rHGytldo6V5T8ePjZ+0p4e+HB8faEI7WL7Th4Gg3sq+uK5z9lz9pD9on40+K10KS8hls0haSSea0MY+XtnpVe8l5DS7M+ufDdk/hpVS2unGFAwDgV6H4c8b6nLZrB9qbK9DnrXjvhXxJrGpRtbaraEXMI/eBR27GvSvh9ZNqCBo14x82e1TZ30FK1jX1/wAY6xFbErcsc8DJ6V5V8SLLXfHUK6fc6k6wE/OA+DXp/i3SPsdizucHPy4rzPx/fz6JprXyyBXYbId6n5mNVfW4lY43RP2evg9pNw1/qOk281w33pbhd7Gur0nwf8M1iFrZaNaRnOFKQY/mK+YP2uYfjl4TNhrei63ff2ROgN3caaA0iMey8Vd/ZP0L4xeL/AGpeKNb8X6tazx3P/Er/tcErKo9j+H509QSjbU+pH8HeHthhsbSNjjk7BxTbvwjv0Oa0WP5OQBxXMfAXxJ451O8k0vxb4fkjnjypkQ/JL/tDPrXtKaE8mmAeRjcORjocU1q7MUtz8hv27vAQ8K/EhSIAI5PNLbcf89Gqv8Asc/s03vxr+KGlW7yfZ7TzgJyR99AVyP1r6Q/4KM/BebXfiH4asNPtQZNTkeI4P3jvJz/AJ9a+m/2Vv2YPDnw/tfD8el6YIpVCG5bGSX4zz+ArdzT0EpWirn2X8DPAuk+C/DGn+HtKtljgsrVYogvQjaBXrOkQFI9pxXM+ENGeCFVPRQACRXZ2FukaYc8jtVJnBUknqi3Zw4YEngUsgEpPO0A96fZkM2wL+FJNEzZQtnByD/SrTVjlqdyNoxnhqKQOB1orn1MOdHh/heNxbA7AAz7gc9RXTwRuV+Vdx9DWdounx2tuIyMEEBVArXRCrbkGR2zXyL+I/QndIlihRl3AduayvF9jM2i3PkdfJb5Txnity1RUIWQnNLqNit1avCxAVhtJz616OFdkcdZK1j4y8afDqPXtPvZtb04kMjBQD3zXzJ+zD8G7PwP+0b4i0uLT5IFYxvED3Wv0A8a6VDHZTJFbj5HIK7evNea6F8Lra38ZS+MHtYxcTQJHvA5+U9a9SD0PPaWx0mmaTAlkiEMCiYGRXNeMvhjouqqLi7t1kwSRu616Fa2rKi7ipIHIzVltOtbyLD2qsehxV3T2M1oz5/1/wCF/h3U9LfR9Si8yCUFWgI4ArH8N/B7wd8Obc2fgvTI7KFwQyxAtnPueete+6j4EsLg7Vg57ArUX/CDWcMQElgnHcd6Tctg91HmvhXwNa6Sk17FHJJJcQ4LMO9d38NvDEtnvDJt3AHrWodPhh+RYVjVeAoFbHh6BXnIgC4C84oQnJ2Mfx5oLS6dvUZxjHNcJ4i8DQ+ItLW01C13mNg0a7hzXrviKzZ7AxuBg965y2MDv5QiU4496pqzF0PGrnwJYTWx0XWtI8+2UnbE2cD8qv6D4L0W102PT7HR2jiQYVFzgHNesSeGd8xm+zI4PbFXtH8JQRqzCBVPBwRRZrUm/U4/wp4FtLTZKLRo5MdSa6p9HFpbKMZy3IzW0loLZtjQLgD71Rz/AGcyMxYZxjb6VTIW9z5a/ar+FNz4o+KvgGex093EN9LJKV5Cqe59OlfSXwZ8PQJqFrA8ZIjfg59MVF4g0EX11FJbWyNcEbImP8APWuz+E+hXNre29sttvaNfnfHVuM018QTbaPXtGhdYRHtIw2fwrfgRdu9V3HoQO1ZumabeqivJgAgEjPStm1YW/wDqY87hjNbtI4pXvdkltGyfMU2sTgCnNKvmbWQH+8QafFHcpl2XLHoKjuYtseI/vE5arSVjnqPQgdYixIzRTlBAxmisOVmNkec28Mcag4+bsTUyLwOOtRI/zdyPWrayosAnHUcDAr4+65kfo07WJbeIsAFXcw74q1La2oj3SOd+chRUNuZYowiH52+9irqRxwQl5FDu3TPavSwyejZwV07aHlvxK0HUY7xpre1xDLJk/LweB/WvPJtH/snUEg+1syZ4JP3a+gvE2g3OraS/mHAHKZrx/wAU6JZRytN5gB/iBPNenotDz27amSsloJmVJ+BjODV2ymZTmB8jHBrnria3tL5ooidgxnNTR3yMN0EpB/KhNIho6KC4d7ktfNtUDnjipLtIVhMkTZB6Vz0niAW4Mc5zkdqhvPEM9vbCWJwykH5SenFXexHKtnqMv7t7i7KRsMA9BWn4du0tFZn+/Xmus/EBNGu5nlXD4yuK5zQPj3fXesyQ32lTW8R/1cjDg+9Ckrg0uTQ98v8AUvOi8uTGCD1rlDI9jeNcQqCGPFcD4s+PY03TPtiW01y5+VY4lyaZ4N+MDeJYzHPpctvIwyI5F5+tN7k20PZbGRTGr7uw5rStp4FjJlblhxXGaNrM4shFMRvPIAq6niERAxTNz2obuhNSbN65mAOFlJXPU1QS5V2k8yMDbIQG9RVJ9VMcWTIDk9M0tneR6jJtYbdp5A709NBJNm3p1hJdzq8K5JGOPpXqXw78PXlpZ28vlYJGSccmuM8C+Gby7uFuUm2wgAEZ57V69ogMUUcMYICjH1renF3uY1HZmnaWkrAJJIwU8Y9q01ENvbeVAxJBqmFmPAUc+9X1g8q3DsBuzjHtWlne5zt6j4DiPe7c9c1DdAN90kZ6mnQMZJDydo6g96bdBSQwIA6gZqlaO5y1GuhUMODguaKVlLMTRXO3ruSqcWjx20vr2NAn28HPQMK0rbUtQiKtNZ+ZHjkxmuYsvEumP8qzhWzyHHetew1Sa3JktnEgfkgGvm6lGzR+kzpu2h0ek+ILZh5zqy4zjcK2tMntrjF6zqwH8Oa5aDU7C/ijhuVGZDzzit2PSbe1gBsJSmenOc104dWPMxEJI0tQu1u4ngjj4PauD8S/Dq01ec3PlshA+6OhrrLddYhYybY5PqcUt9qMaho50IPc4r1LxgrJHkSm+bQ+ePFugmzupEOEZSQQK4y7vrqxuvLRyQTivTviettFrs8aSg7jnrXm+sIRKYwoyDw1Z8z5rMrbVoYLprwFTOdx6GphOqRiG5lyCcc1k20nl3RXPQdK4n4i/FWbQrw2QBAifl9uRT20FZvY7rXNE069G/yI5AUI561U0/wdoU0Ygktg4UfKGHSuW8PfGTwvfWoN5rMKHHTdzmtzQPih4HnneBtciQgfKS3GaqMk1qgldK6NOXwjoMEDBbJFdRwdvSl0PwrodrMLpB8/csapeJfiF4WsIxJcatGxdRgRtnj1rFuPi74Ot4g66tGox1Zqq+uhHK7fkehCe1tmBSUEjpzQZy7ZkHPYV5JbfF+PW9UjttBiknQPzMq/LXplrevcwR3AIDGMbgaV3caik+V9S9F5zTfO2F7E1s6MmJQyt0IP1rFT98mSQcf3a3fDaia4hskX52Ix709b3J0ab6o90+FlpF/ZmbiPBO3B/AV6Jp9taCMBUxz1rjvBtg9tp8SBefLBP5CursBIoVWJ611qOnunK5RkzSiaKEHI3HtmpUaSRt5ztqtbIWb5getaE2dixRkADniiz0RjL35csRgVSyqvHPOO9V7x41Byh4yBirEaOgJByc+lRSyJhlK9RyatLQwqJP0IFQFQcnpRUZbHAI4orF819jm5WzwefSNPnUq1oh55OOaq3OgzQN5mkX0kHPIckj8Kel5qludstuZF/vLzU/8AatpJGFklEbDqrdq8LmkmfqbasU7XUddsrULeWxmEJ5ZOuPWuq8PfEKweAJLKyYPSXisaOSNWE6uCr9RVsWtpKgElojIfvArWlOcb7GFanGUD0DQtcsr6EhGVgVyDmrGq2onR8xZUrjpXnY8NvbBbjQryWB+2HyPyqePxz4n0iQxapbNOgPMi+lejGMajvBnhVcK4O61OO+PvhSa3nXUrJNgMeGI9eK8a1O/u7IH7QhkA6GvpHxVqmj+MtGltVuYxOyZ8pjyK+YfiAJtK1maxd2RVlIwamVNpa6HK4rYZpepxTymRpMMeOeKra/4S03U1lkeGOTzlIO4ZqCG/t5id6L+FXbW2uGIkgmJHULUKzlcl8yPKPEnwj0zSbo3Z00vEDnEWRVXTfh74V1UkWN40L91dyCP1r2DUwbuNra+gCccuRxWBd/DOK5Y3FqinIzlODTTYudONjgbv4X2OiDzNS8RGdM5CiTOB6VBdeBNG1m8htNGtmI43l8kV3Vr8Kbi8uPMvopNoPAJ6102jeCrTRpspEBtX0q1FtotySV0Q+DPA+laHpkVtFYJGVx0XrXVRFIIhEiAcfnVVrgOACo+vTFVbrVYYzhJQSM7s0O8kZxXvK5tafcbDtYjrXbfCXTJNb8UROkZaODJY44FeSW/iBJbny1kFfRH7OWnBPDK6iRhrljlsds0JA9byPY9AtlhhQDsozWxGyZXA71l6WwRAqtmtKFcsvOOa6aa1PNcfeua8DR7CBjPNI7BACxxk4qG02Ftxl7+lTy7HcB/u9fxqr2bFB7i7nU4Vc5qK6XAywGalARMNG2fmqC8DGRgD0BNaJLYyqJKK9Ci8c244XjPFFTodygtwcc8UVzPnvuZrmseHRMrx5DDB7CoL60tJ1HmQqST1xzTpPCiTqZNB1R4WB+UTHI+mPSqN7Jr+jTLHq2miVD/y2i6D8K8yphWtYu5+g0sVSqO17PzFayhAAtbwqo6Kw71ZhvNWshuuIBLB6x9RVaz1rTbhg0UoDE/MrjBrXiJm2mH7p+8vrWcYtaNGs/h0J9J1GK4VhDeBW28JJ1FWrmfzB5c8IIHTtVJtPs7xDI8XluOjDvVLUJdW07mC6WVMfdf7x/GtY6M8+pzXuzL8dXWk6fbSTvp5OwbsxHB96+dvjPBqqsNes94WdC0ccx4A7V694+8STzXS295+6ywA9DXN/Fzwu2u+EYbyyljk8qMEheSOK09vKOnTsYSjF7ng1r4vu9MujB4ij8rjgJzXaaT4sjvLJRpTB3xwCetedeJrGfTpm8yNp1K8nHSsS38SPpJBsr94CpyR6+1XGdORzOnJHvVld2MSK183mM4zgnODWhFNYOhYuIR2I6V4hZ/F27t4lS+jEh/vp3rXtPjBZzwYa8UDH3Sea2aVrmDp73PWzqptlyVjeMfxjrUE/iDS7hStsxLHgg15ifigjJtMoZD6Gqt58SbNVLJOFB7VPvcxDjI9GvtS8iFpBIoAHXNcZrXisCV1gKlh3WuN1P4n39y3kWxLR9jnrT9Ev31T5J42DMeTjj86L3H7ux2ng66n1LVkMvVuuK+qfgh4lm0vSLbQZ0wPLVoj7ECvnj4XeEp5dRt7fA/eNgH2r3ttMj8LLo0iSYZYSkh9+KqKV9TOo7xt0PctElkmVXU46V0EKlUGTz61w/g3xTZ3CR25dWYoDkH6V2+n31tKF574610qcrmHuLYt2WNwDEYJq5NtELYI4FZznY/GcE9hVsAtbHHeqbvK5zqLVX1JLVf3BJPO7NMuHAuFGPvLzT4HATb6daju9olDleNtNKW5z1LchXJIJAIopjK5YlemeKK53a5KnGx4ba6vZTyFoZ8MDgqexrR/tgMoS+RWX+FgKbPpGj6u+6JUR2XnAxzWNfadrOi/IjtJED8g9K45RlT96LufYudLEaSVpFjWvC1nqrJcW6qpPPycEVnRWWsaPcKbK4MxAOIn44qU+IYbeXDiWJvfpVhtetruIoTgjo3eqUo1FYPaV6EbbxCPxnaRYg1CF4HbgNIuFz9aqX+ro6ySmRSOwBzUV9FHeW7RTJ5in15rnbvR9QSNptEl2IBkRluDTcF10HGrCotGUvEctvqM5JgDAuA2RWwdAt5NHK2yhQ8Iyp+lcymslS8eq2MkM2ctkccdxXfaA1pfaLA6ssm6MZOa5Z0pRkKUU3qfNPxT8IX3hrVGtb23xFKuEkAzmvG/FvhWRmkliyQWyCK+zfjH4GPiDw+6xRCSSOMtGQOcivnS/wDDVxeoYlspIZFGGidf1rNNxZFpJaanh95L4g09vLSDeo4BqjcNrBf7UulXCsO6jIzXqur/AA61Rid2nyk5/hXipdM8OahYbRe6PO2Oh2ZreFdxsZyimjya01bxop2poVy6A/f29K19JtNd1hv9IRY+wDNXrEGhX14nl2ukSAHruTFSw/C66uJllltmjx0KLXTGrTm7HPOLW5yWh+Bri4kQSBSM8/NXpXhvwpZR2qQNb5Zepx0pNC8Ja5pACT6W8yA/M6L8wFdbp8PlQCeysjuKFREw+Yt2zVyhpcy6WZ03wX8Jaxc66t/bpm0tDl89/pXpPjHULaO4to51x5ZJCkdiaX4QeE9S0XwpA1+m2Z13yDvk1neNrXU9V8RvbwRltibV46YqpRcVucyd5No67RdRktURo0RWZeAp/h4rtvDXi4SMlvKu0/3ieteNeHIfEOlTGS4SR0HVSeldjpetCe4SFUIY9F6URnOD95Gcpw2Z7Zp+oG5hAYqeBirUUzpIE7NwK840/wAS3+kskk8LFDgAE12Fj4hi1CKOaIlX6lfStYyd7ozk9DehB84w4GSetMvJMnao6cGo4rgOizK53buuaW84f5f4lyfc1um0jinLr8yHd6gflRTMP/k0VzOWpCbSPANO8Sp/qtStmtrhTg+Z39xWxBrZVgkyC6iPPBzip54NI1gMLuBQ5HOV4zWPqPgu80vFxo140O8/w8j8BWHJ1ps+09pRr+5UVmaF9oOnashmiIJ/55isq58MG0fMUjc/wY60ket3ukGJdUiVM/cmjGQ31rcsfEUGooElKPjoe4zUOMZb6Mlwr0V/MjDtVubecW95bmND91iM5rUi0fT7mIyJGob0rXbTxPCGtdrI33kI5qhLpTIwa1bY/wDCrdKvmcNJao5HCNR3g7Mz7nwha3AK3FpGwP8AfUGoI/CEdnDt0uQQEHOE6Vu2up31oDbahZxlf4XA6+tWbRbXUCTbOoPdazlyzdqb17FxrVaOk1p3ONur+6tbkx6xYHYw+V0XC/jWS/w08Pas7ataW8ZMp+ZgNwr0PUrZZx5U8ZkLjAU9Kx7jwp9iH2nS7s2km7/VxH5D7YriqygnaSszsjyVI3icfN8KtNYbVslfHdVGKjk+C2jzhZLe38pyOflrs4daWyza6habCvWXsa2rVobiFZo9hBGce1c85OC1B0XJXPMrP4Z2tj/o11pgCg/610zurTt/hfo7sGijQjGTsFd89pHcoVKYA6j1pYdHgIE+nKInHBwOtZ+25ZXRk6Mku5ylh8MdIDqv2Mcnqy1YT4JeHLq9W5m08q6HKPFwM+9dML9rUbLhMH1ArUsrxWjVoHyCOTiu6hmSjKzOWrh5OPMjn49NvtAYW93GZYG485V4jFWIvDFnqRa5tLyKQk5yq810sUiNEyyqpLeozVW98OWs7LqNjObacHBMfCt9RXr08Xhq9lex50lUgncqaf4StBILW4i5ZTyR1qxP8PtMMgeKDJz1Wi21e+0qFjqoEsY482PqvvWrpOsWt0UkinDoelXaKu+hyVJ2sUYvDE8ULQ28vmImW2yjJHsK0/DTwsTbyRhDjnIxVmW/hs5tzJgN147VJcpaTBJYkAX1HrWTcVsc0qk0zQsZIVZo0bhW4p0135jEBuhrAM1zp1z5yyeYpb7g61YbXbOfdGCUfGSCKPbxWnUwlNO7Lhe5JyAaKhjuCyBg55FFZ85PtpHjpvNRtS1vfWR+U8yLV6z8QK8YZW8xF4KtU8OpWl3h7qIglcFu1VL/AMMvcHztPmXLHJANYOMo+9TZ9w6kJrlrKzL/ANh0zU4toiUHGVjYcVjah4Wa2zcW5e3IPyupyp9jQL2+01hBdxF1XpIladn4iju4zbSkMvpnkUlUUn7+jGlWow9z3l1RRtNe1rSzGl7AAvTzEOV/H0rWt9X0rVV3nK+pDdKje3tJk32z7t2flNYt54e+yzebaTTRSHkKOV/Gr5nH4loCWHxPvRdpfcdFdwROv7kF0A4bNZ7Wbo3nWczRvn7u6obDxLJppNvqcO1mIwV5U49K04rzTtTYOk6xsBkZOAa55whNXTszNqrS0qwuu5HF4lmgkW11OwHJ4fHK1fS3guUE8BD7v4W7VWvLJWPzrkY6jms6WO7tJBLZzZwfu57Vxzq1IS5Kkbrv1FGjJrmpu3kaF/Y27gxXNshx2K1m/wBj6jaS+fpdyAP+eTtkH/Cr1t4ltrhvI1KPYw65HarkcQZN9qQ69Ris50pOPNSd12NqeNXNyT0Mu01+SK58jV4GgcDGP4T75rTtr3e+6NwR7VV1Gzhvk+zXMZ2n7wHWs6LTtV0iX/QpRLEeidxXBUj8mehNRcFy7HSSCK6XDorE9qjgtLq23NaTYUDJQ81m2HiSzcHJ8qXGCjnBrYs5w8RZmGSORmuaUpRfvGdOg5O42111zJ5VzHtI681ow3hdCEkDDOcelZc1tFeIYmbbz96o445rA/6OfMVTyAeoqo16kNUzmq4Zc7i1dG7FPbviGSNdrH5sjrWfeaKsFz9r0W6eFw2QCMofaoYdZt5fkxtbPQ1djusW+Ce+a9nDZpNNKR4mIy9qPNT6DG8TSpDnX7Uq6thWToa19O1KPULfMLgj+Eg1lxTRX2YWjDjowNUrXTtS0u6luNDnBUdYGPH4V60asKkdHY8idJqeujOliuEmJGBvRuWNQ31lbzOLlQVcjqDWRpHic3F81vqsK2rjpuOA5+taf2+ObciNkgc0pRcXqclSOjTJUGqRKEWYEAcHFFSRX6CJQfSiouzNU4dzwuK81fQnVbiczQj72W5FbWleJkuzjT5WBx8wYUUVpV095H6HFKvTtM1JNS03VJMOHWQjjArNvdPKt59vtRh91h3+tFFJpThqcUKkqOIcY7ESa3PZsRcuTgckVpWniSC4TbKC3q2OlFFctKcoysjaVGFRcz3J5be3uoy7Qh0b14rCvLCWxZ7nTZSMH7jngUUVVaKhaSNcNVm3ytk2jeNhHKI7lGBY42k5zW+ktrdx+dBkEjPI60UUm7z5HsGLpxptSjoU7ny3YiWPB9qqprl5pFw0kEhZMABaKK82rFUp+6RyxqUuaS1NnT/EFpqUO2RSsuOTikuRJAN5bIooraUY16Dc90c1KvUpVVBPRle+trPULcMbZQ3eTHzD6VUt9R1PRCYrlhLFj92QeR65/SiivLcU3Zntwm1E1rPXLa9gMtqT8o+cEYxU8F2JASpIzzmiisZ04qdiINuo2Mu3hmAXHK85HrVWTWrrTUVJ33Rlu3WiihRSOSqkoXRr6RfwXY325I75xU9tfFLpjt4FFFddCclK6OLE0adSLuht5BFfThLiNHDtyGXoPb3qjd22qeHL4PZ3BltD96ORskCiivocLUlKKufNVoRjNxNS38S6XLCr+YwyOmw0UUVs4q5hyxXQ/9k=", "position": {"bottom": 408, "left": 521, "right": 716, "top": 161}, "key": "head_portrait"}, {"value": "11-06-1965", "position": {"bottom": 288, "left": 222, "right": 409, "top": 261}, "key": "birth"}, {"value": "\u62db\u8c50\u78a9", "position": {"bottom": 119, "left": 25, "right": 166, "top": 81}, "key": "name"}, {"value": "2156 6265 4311", "position": {"bottom": 191, "left": 217, "right": 477, "top": 164}, "key": "name_code"}, {"value": "\u7537", "position": {"bottom": 291, "left": 458, "right": 526, "top": 255}, "key": "sex"}, {"value": "09-08-03", "position": {"bottom": 442, "left": 218, "right": 411, "top": 408}, "key": "issue_date"}, {"value": "AZ", "position": {"bottom": 325, "left": 225, "right": 268, "top": 296}, "key": "symbols"}, {"value": "CHIU,Fung Shek", "position": {"bottom": 153, "left": 26, "right": 302, "top": 120}, "key": "english_name"}, {"value": "yes", "key": "is_permanent"}, {"value": "D788888(5)", "position": {"bottom": 442, "left": 482, "right": 710, "top": 407}, "key": "id_number"}, {"value": "(07-76)", "position": {"bottom": 390, "left": 222, "right": 353, "top": 359}, "key": "first_issue_date"}], "type": "hongkong_idcard"}}
{"$schema": "http://json-schema.org/schema#", "type": "object", "properties": {"code": {"type": "string"}, "status": {"type": "string"}, "date": {"type": "string"}, "result": {"type": "object", "properties": {"rotated_image_height": {"type": "integer"}, "image_angle": {"type": "integer"}, "rotated_image_width": {"type": "integer"}, "item_list": {"type": "array", "items": {"type": "object", "properties": {"value": {"type": "string"}, "position": {"type": "object", "properties": {"bottom": {"type": "integer"}, "left": {"type": "integer"}, "right": {"type": "integer"}, "top": {"type": "integer"}}, "required": ["bottom", "left", "right", "top"]}, "key": {"type": "string"}}, "required": ["key", "value"]}}, "type": {"type": "string"}}, "required": ["image_angle", "item_list", "rotated_image_height", "rotated_image_width", "type"]}}, "required": ["code", "date", "result", "status"]}
e3c4b6b4-8516-4595-8c86-f9b5b0050e1f/27f05bbb-4e87-4597-bcf5-b61c5262bacb/0/0
VIN Recognition
Quickly extract VINs from images, barcodes, and QR codes while returning vehicle make, model, and year. View documents
9.5
Vin Recognition
Support JPEG,PNG8,PNG24,GIF,BMP,WEBP,RAW,ICO. The larger the image file, the higher the recognition accuracy but slower the speed, the smaller the file, the faster the speed but the lower the recognition accuracy. Therefore, we recommend that the maximum image file size should not exceed 4MB, and the optimal size is 1024*768.
200
New Example
{"service": "vinocr", "version": "3.0", "date": "06/13/2023 10:42:34 PM", "status": "SUCCESS", "vin_captured": "JH2PC35051M200020", "vindecode": {"status": "SUCCESS", "make": "HONDA", "model": "CBR600", "year": 2001}, "left": 235, "top": 136, "width": 359, "height": 181}
{"type": "object", "properties": {"service": {"type": "string"}, "version": {"type": "string"}, "date": {"type": "string"}, "status": {"type": "string"}, "vin_captured": {"type": "string"}, "vindecode": {"type": "object", "properties": {"status": {"type": "string"}, "make": {"type": "string"}, "model": {"type": "string"}, "year": {"type": "integer"}}}, "left": {"type": "integer"}, "top": {"type": "integer"}, "width": {"type": "integer"}, "height": {"type": "integer"}}}
31944dac-5835-421b-86a3-700b7f9c340b/b266a3c0-ca1e-4fdf-9e7c-5e5edccb3fba/0/0
Wine Recognition
This ready-to-use API provides recognition of labels on wine bottles covering more than 400 000 different labels. The results contain information about the brand of wine and its type. [](https://api4.ai/apis/wine-rec?utm_source=wine_rec_rapidapi&utm_medium=endpoints...
9.4
Analyse image and return results
Performs actual image analysis and responds with results. Image must be a regular JPEG or PNG image (with or without transparency) or PDF file. Usually such images have extensions: .jpg, .jpeg, .png, .pdf. In case of PDF each page will be converted to PNG image and processed separately. The service checks input file by MIME type and accepts the following types: image/jpeg image/png application/pdf The size of image file must be less than 16Mb.
200
Successful detection
{"results": [{"status": {"code": "ok", "message": "Success"}, "name": "image.jpg", "md5": "6ea449c4645b8811eef1342040725687", "width": 1024, "height": 768, "entities": [{"kind": "classes", "name": "wine-image-classes", "classes": {"buitenverwachting 1769 vintage 2000": 0.6465678215026855, "buitenverwachting 1769 vintage 1999": 0.6465678215026855, "raventos i blanc cava reserva brut l&#39;hereu (blanc de blancs) 2012": 0.621323823928833}}]}]}
{"type": "object", "properties": {"results": {"type": "array", "items": {"type": "object", "properties": {"status": {"type": "object", "properties": {"code": {"type": "string"}, "message": {"type": "string"}}}, "name": {"type": "string"}, "md5": {"type": "string"}, "entities": {"type": "array", "items": {"type": "object", "properties": {"kind": {"type": "string"}, "name": {"type": "string"}, "classes": {"type": "object"}}}}}}}}}
31944dac-5835-421b-86a3-700b7f9c340b/b266a3c0-ca1e-4fdf-9e7c-5e5edccb3fba/0/1
Wine Recognition
This ready-to-use API provides recognition of labels on wine bottles covering more than 400 000 different labels. The results contain information about the brand of wine and its type. [](https://api4.ai/apis/wine-rec?utm_source=wine_rec_rapidapi&utm_medium=endpoints...
9.4
Analyse image and return results
Performs actual image analysis and responds with results. Image must be a regular JPEG or PNG image (with or without transparency) or PDF file. Usually such images have extensions: .jpg, .jpeg, .png, .pdf. In case of PDF each page will be converted to PNG image and processed separately. The service checks input file by MIME type and accepts the following types: image/jpeg image/png application/pdf The size of image file must be less than 16Mb.
200
Unsupported media type
{"results": [{"status": {"code": "failure", "message": "Unsupported media type. Expected one of ['image/jpeg', 'image/png']. Got 'text/plain'."}, "name": "file.txt", "md5": "d41d8cd98f00b204e9800998ecf8427e", "entities": []}]}
{"type": "object", "properties": {"results": {"type": "array", "items": {"type": "object", "properties": {"status": {"type": "object", "properties": {"code": {"type": "string"}, "message": {"type": "string"}}}, "name": {"type": "string"}, "md5": {"type": "string"}, "entities": {"type": "array", "items": {"type": "object", "properties": {"kind": {"type": "string"}, "name": {"type": "string"}, "classes": {"type": "object"}}}}}}}}}
31944dac-5835-421b-86a3-700b7f9c340b/b266a3c0-ca1e-4fdf-9e7c-5e5edccb3fba/1/0
Wine Recognition
This ready-to-use API provides recognition of labels on wine bottles covering more than 400 000 different labels. The results contain information about the brand of wine and its type. [](https://api4.ai/apis/wine-rec?utm_source=wine_rec_rapidapi&utm_medium=endpoints...
9.4
Analyse image and return results
Performs actual image analysis and responds with results. Image must be a regular JPEG or PNG image (with or without transparency) or PDF file. Usually such images have extensions: .jpg, .jpeg, .png, .pdf. In case of PDF each page will be converted to PNG image and processed separately. The service checks input file by MIME type and accepts the following types: image/jpeg image/png application/pdf The size of image file must be less than 16Mb.
422
Missing image/url
{"detail": "Missing image or url field."}
{"type": "object", "properties": {"detail": {"type": "string"}}}
7ae93f98-0a38-4c69-baa9-6cc9ecc0211b/064fa25f-dffc-49aa-b82e-a9665da175a5/0/0
Promity Face Detection
API for face detection in images in real time
6.9
Face Detection by file
Endpoint for face detection. Send us image, we return position of detected faces. Check out our tutorials for example of usage in Python.
200
New Example
{"detections": [{"crop": {"x1": 0.49029475450515747, "y1": 0.5199255347251892, "x2": 0.5589765906333923, "y2": 0.38276559114456177, "score": 0.9992923736572266}}, {"crop": {"x1": 0.11643223464488983, "y1": 0.5169875025749207, "x2": 0.18099753558635712, "y2": 0.39529597759246826, "score": 0.998594343662262}}, {"crop": {"x1": 0.8563294410705566, "y1": 0.24784332513809204, "x2": 0.917901873588562, "y2": 0.12237813323736191, "score": 0.9980091452598572}}, {"crop": {"x1": 0.1482899785041809, "y1": 0.3003842234611511, "x2": 0.20176897943019867, "y2": 0.20043990015983582, "score": 0.9973342418670654}}, {"crop": {"x1": 0.598613440990448, "y1": 0.3124071955680847, "x2": 0.6528789401054382, "y2": 0.20392271876335144, "score": 0.9954931735992432}}, {"crop": {"x1": 0.7280519604682922, "y1": 0.5563205480575562, "x2": 0.7874197959899902, "y2": 0.4102036952972412, "score": 0.7963487505912781}}]}
{"type": "object", "properties": {"detections": {"type": "array", "items": {"type": "object", "properties": {"crop": {"type": "object", "properties": {"x1": {"type": "number"}, "y1": {"type": "number"}, "x2": {"type": "number"}, "y2": {"type": "number"}, "score": {"type": "number"}}}}}}}}
7ae93f98-0a38-4c69-baa9-6cc9ecc0211b/6d3af90d-9e06-45a4-9f5d-3c292e7e8b8d/0/0
Promity Face Detection
API for face detection in images in real time
6.9
Face Detection by URL
Endpoint for face detection. Send us link to image, we return position of detected faces. Check out our tutorials for example of usage in Python.
200
New Example
{"detections": [{"crop": {"x1": 0.49029475450515747, "y1": 0.5199255347251892, "x2": 0.5589765906333923, "y2": 0.38276559114456177, "score": 0.9992923736572266}}, {"crop": {"x1": 0.11643223464488983, "y1": 0.5169875025749207, "x2": 0.18099753558635712, "y2": 0.39529597759246826, "score": 0.998594343662262}}, {"crop": {"x1": 0.8563294410705566, "y1": 0.24784332513809204, "x2": 0.917901873588562, "y2": 0.12237813323736191, "score": 0.9980091452598572}}, {"crop": {"x1": 0.1482899785041809, "y1": 0.3003842234611511, "x2": 0.20176897943019867, "y2": 0.20043990015983582, "score": 0.9973342418670654}}, {"crop": {"x1": 0.598613440990448, "y1": 0.3124071955680847, "x2": 0.6528789401054382, "y2": 0.20392271876335144, "score": 0.9954931735992432}}, {"crop": {"x1": 0.7280519604682922, "y1": 0.5563205480575562, "x2": 0.7874197959899902, "y2": 0.4102036952972412, "score": 0.7963487505912781}}]}
{"type": "object", "properties": {"detections": {"type": "array", "items": {"type": "object", "properties": {"crop": {"type": "object", "properties": {"x1": {"type": "number"}, "y1": {"type": "number"}, "x2": {"type": "number"}, "y2": {"type": "number"}, "score": {"type": "number"}}}}}}}}
fd62d11a-c37a-4532-b95b-d05341f7f3b1/d6f5434c-861c-4d6a-89b9-dcde37a391bc/0/0
NSFW Image Detection
First Class NSFW. Detect explicit content from a public image url. Returns adult, spoof, medical, violence scores.
null
NSFW
Detect explicit content from a public image url
200
Example_1
{"adult": "VERY_LIKELY", "spoof": "VERY_UNLIKELY", "medical": "POSSIBLE", "violence": "UNLIKELY", "racy": "VERY_LIKELY"}
{"type": "object", "properties": {"adult": {"type": "enum"}, "spoof": {"type": "enum"}, "medical": {"type": "enum"}, "violence": {"type": "enum"}, "racy": {"type": "enum"}}}
7afc6650-c85a-4a57-9c8a-112c12597150/82486d58-c75a-4adf-9540-9b7a80a8da20/0/0
Face Detection
This ready-to-use API provides a pack of options in human face detection: face and landmarks detection, face re-identification of an already detected face. [](https://api4.ai/apis/face-analysis?utm_source=face_analyzer_rapidapi&utm_medium=endpoints&utm_campaign...
9.1
Analyse image and return results
Performs actual image analysis and responds with results. Image must be a regular JPEG or PNG image (with or without transparency) or PDF file. Usually such images have extensions: .jpg, .jpeg, .png, .pdf. In case of PDF each page will be converted to PNG image and processed separately. The service checks input file by MIME type and accepts the following types: image/jpeg image/png application/pdf The size of image file must be less than 16Mb.
200
Successful detection
{"results": [{"status": {"code": "ok", "message": "Success"}, "name": "face.jpg", "md5": "39cefc732e7e0c2b1b5f6a783dc87141", "width": 1024, "height": 768, "entities": [{"kind": "objects", "name": "face-detector", "objects": [{"box": [0.5379649347853466, 0.2885976606043589, 0.19544756039146483, 0.2706363619501567], "entities": [{"kind": "classes", "name": "face", "classes": {"face": 0.9990811347961426}}, {"kind": "namedpoints", "name": "face-landmarks", "namedpoints": {"left-eye": [0.5917292404174804, 0.37885522842407227], "right-eye": [0.6897146463394165, 0.39089276552200314], "nose-tip": [0.6375282120704651, 0.45772279739379884], "mouth-left-corner": [0.5896168756484985, 0.4839122676849365], "mouth-right-corner": [0.6723905473947525, 0.49339886665344235]}}]}]}]}]}
{"type": "object", "properties": {"results": {"type": "array", "items": {"type": "object", "properties": {"status": {"type": "object", "properties": {"code": {"type": "string"}, "message": {"type": "string"}}}, "name": {"type": "string"}, "md5": {"type": "string"}, "entities": {"type": "array", "items": {"type": "object", "properties": {"kind": {"type": "string"}, "name": {"type": "string"}, "objects": {"type": "array", "items": {"type": "object", "properties": {"box": {"type": "array", "items": {"type": "number"}}, "entities": {"type": "array", "items": {"type": "object"}}}}}}}}}}}}}
7afc6650-c85a-4a57-9c8a-112c12597150/82486d58-c75a-4adf-9540-9b7a80a8da20/0/1
Face Detection
This ready-to-use API provides a pack of options in human face detection: face and landmarks detection, face re-identification of an already detected face. [](https://api4.ai/apis/face-analysis?utm_source=face_analyzer_rapidapi&utm_medium=endpoints&utm_campaign...
9.1
Analyse image and return results
Performs actual image analysis and responds with results. Image must be a regular JPEG or PNG image (with or without transparency) or PDF file. Usually such images have extensions: .jpg, .jpeg, .png, .pdf. In case of PDF each page will be converted to PNG image and processed separately. The service checks input file by MIME type and accepts the following types: image/jpeg image/png application/pdf The size of image file must be less than 16Mb.
200
Unsupported media type
{"results": [{"status": {"code": "failure", "message": "Unsupported media type. Expected one of ['image/jpeg', 'image/png']. Got 'text/plain'."}, "name": "file.txt", "md5": "d41d8cd98f00b204e9800998ecf8427e", "entities": []}]}
{"type": "object", "properties": {"results": {"type": "array", "items": {"type": "object", "properties": {"status": {"type": "object", "properties": {"code": {"type": "string"}, "message": {"type": "string"}}}, "name": {"type": "string"}, "md5": {"type": "string"}, "entities": {"type": "array", "items": {"type": "object", "properties": {"kind": {"type": "string"}, "name": {"type": "string"}, "objects": {"type": "array", "items": {"type": "object", "properties": {"box": {"type": "array", "items": {"type": "number"}}, "entities": {"type": "array", "items": {"type": "object"}}}}}}}}}}}}}
7afc6650-c85a-4a57-9c8a-112c12597150/82486d58-c75a-4adf-9540-9b7a80a8da20/2/0
Face Detection
This ready-to-use API provides a pack of options in human face detection: face and landmarks detection, face re-identification of an already detected face. [](https://api4.ai/apis/face-analysis?utm_source=face_analyzer_rapidapi&utm_medium=endpoints&utm_campaign...
9.1
Analyse image and return results
Performs actual image analysis and responds with results. Image must be a regular JPEG or PNG image (with or without transparency) or PDF file. Usually such images have extensions: .jpg, .jpeg, .png, .pdf. In case of PDF each page will be converted to PNG image and processed separately. The service checks input file by MIME type and accepts the following types: image/jpeg image/png application/pdf The size of image file must be less than 16Mb.
422
Missing image/url
{"detail": "Missing image or url field."}
{"type": "object", "properties": {"detail": {"type": "string"}}}
c3ed5d1d-7b60-4186-bb8f-306de255a74d/f5dc2b1a-a34f-49f0-8e52-c005f5045556/0/0
Cloudlabs Face Detection
An API used to quickly detect faces from an image file. Can detect up to 20 faces at a time.
6.2
faceDetection (by Image Url)
This endpoint is used to detect faces via image URL
200
Response
{"status": "success", "count": 3, "faces": [{"bounding": {"startX": 48, "startY": 34, "endX": 145, "endY": 148}, "confidence": 0.63460493}, {"bounding": {"startX": 293, "startY": 2, "endX": 380, "endY": 104}, "confidence": 0.70063585}, {"bounding": {"startX": 540, "startY": 42, "endX": 613, "endY": 126}, "confidence": 0.9601388}]}
{"type": "object", "properties": {"status": {"type": "string"}, "count": {"type": "integer"}, "faces": {"type": "array", "items": {"type": "object", "properties": {"bounding": {"type": "object", "properties": {"startX": {"type": "integer"}, "startY": {"type": "integer"}, "endX": {"type": "integer"}, "endY": {"type": "integer"}}}, "confidence": {"type": "number"}}}}}}
c3ed5d1d-7b60-4186-bb8f-306de255a74d/df32a508-257c-406a-8c67-6895a7352da9/0/0
Cloudlabs Face Detection
An API used to quickly detect faces from an image file. Can detect up to 20 faces at a time.
6.2
faceDetection (by Image Upload)
This endpoint is used to detect faces via image upload
200
Response
{"status": "success", "count": 3, "faces": [{"bounding": {"startX": 48, "startY": 34, "endX": 145, "endY": 148}, "confidence": 0.63460493}, {"bounding": {"startX": 293, "startY": 2, "endX": 380, "endY": 104}, "confidence": 0.70063585}, {"bounding": {"startX": 540, "startY": 42, "endX": 613, "endY": 126}, "confidence": 0.9601388}]}
{"type": "object", "properties": {"status": {"type": "string"}, "count": {"type": "integer"}, "faces": {"type": "array", "items": {"type": "object", "properties": {"bounding": {"type": "object", "properties": {"startX": {"type": "integer"}, "startY": {"type": "integer"}, "endX": {"type": "integer"}, "endY": {"type": "integer"}}}, "confidence": {"type": "number"}}}}}}
b47643a4-9808-4ae9-97fb-8cdc25e03370/dc1ab12b-a01e-46c4-91f9-8f78410bb893/0/0
Face Recognition
A comprehensive solution for face recognition and analysis, integrated with a dedicated database. It accurately identifies the location of human faces, provides recognized unique identifiers (UIDs), incorporates liveness detection, determines age and gender, analyzes facial expressions (emotions), and includes facemask detection functionality.
9.4
Update Face 2
Update a Face to database enter the face id as x-face-uid in the header (case sensitive) same as "regular" Register Face endpoint above but using JSON body of image urls as input
200
Success Example
{"status": "success", "message": "john_doe face_uid updated successfully", "time_ms": 211.28, "image_file_names": ["WhatsApp Image 2022-08-12 at 14.11.10 (1).jpeg", "IMG_2911.JPG"]}
{"type": "object", "properties": {"status": {"type": "string"}, "message": {"type": "string"}, "time_ms": {"type": "number"}, "image_file_names": {"type": "array", "items": {"type": "string"}}}}
b47643a4-9808-4ae9-97fb-8cdc25e03370/022798d4-b5af-4dca-a2d4-1f4ede925475/0/0
Face Recognition
A comprehensive solution for face recognition and analysis, integrated with a dedicated database. It accurately identifies the location of human faces, provides recognized unique identifiers (UIDs), incorporates liveness detection, determines age and gender, analyzes facial expressions (emotions), and includes facemask detection functionality.
9.4
Recognize 2
Recognize & analyze one or multiple faces inside one image min face dimension is 200x200px, use Super-resolution option to up-size the image input same as "regular" Recognize endpoint above but using JSON body of image urls as input
200
Success Example
{"status": "success", "image_file_name": "testing_image.jpeg", "recognition_result": [{"recognition_uidresult": "john_doe", "recognition_confidence": 0.8358, "recognition_otheruids": [], "bbox": {"x1": 0.60241, "y1": 0.02606, "x2": 0.9006, "y2": 0.39088}, "liveness": {"is_real_face": true, "liveness_probability": 0.91826}, "age": 20.81, "gender": "male", "gender_probability": 0.77253, "emotion": "happy", "emotion_probability": 0.5889, "wear_facemask": false}, {"recognition_uidresult": "jane_doe", "recognition_confidence": 0.8371, "recognition_otheruids": [], "bbox": {"x1": 0.23795, "y1": 0.18893, "x2": 0.49398, "y2": 0.4886}, "liveness": {"is_real_face": true, "liveness_probability": 0.9145}, "age": 20.37, "gender": "female", "gender_probability": 0.89797, "emotion": "neutral", "emotion_probability": 0.67729, "wear_facemask": false}], "latency_ms": 490.98}
{"type": "object", "properties": {"status": {"type": "string"}, "image_file_name": {"type": "string"}, "recognition_result": {"type": "array", "items": {"type": "object", "properties": {"recognition_uidresult": {"type": "string"}, "recognition_confidence": {"type": "number"}, "recognition_otheruids": {"type": "array"}, "bbox": {"type": "object", "properties": {"x1": {"type": "number"}, "y1": {"type": "number"}, "x2": {"type": "number"}, "y2": {"type": "number"}}}, "is_real_face": {"type": "boolean"}, "is_real_face_probability": {"type": "number"}, "age": {"type": "number"}, "gender": {"type": "string"}, "gender_probability": {"type": "number"}, "emotion": {"type": "string"}, "emotion_probability": {"type": "number"}, "wear_facemask": {"type": "boolean"}}}}, "latency_ms": {"type": "number"}}}
b47643a4-9808-4ae9-97fb-8cdc25e03370/6363f182-4502-4339-a508-6f4abe829af5/0/0
Face Recognition
A comprehensive solution for face recognition and analysis, integrated with a dedicated database. It accurately identifies the location of human faces, provides recognized unique identifiers (UIDs), incorporates liveness detection, determines age and gender, analyzes facial expressions (emotions), and includes facemask detection functionality.
9.4
Recognize
Recognize & analyze one or multiple faces inside one image min face dimension is 200x200px, use Super-resolution option to up-size the image input Recognition Result : recognition_uidresult = closest possible uid recognition_confidence = confidence level of the recognition recognition_otheruids = other closest possible uids face attributes detection : Face Liveness (is_real_face) "age" "gender" "emotion" : ["neutral", "happy", "sad", "surprise", "anger"] "wear_facemask"
200
Success Example
{"status": "success", "image_file_name": "testing_image.jpeg", "recognition_result": [{"recognition_uidresult": "john_doe", "recognition_confidence": 0.8358, "recognition_otheruids": [], "bbox": {"x1": 0.60241, "y1": 0.02606, "x2": 0.9006, "y2": 0.39088}, "liveness": {"is_real_face": true, "liveness_probability": 0.91826}, "age": 20.81, "gender": "male", "gender_probability": 0.77253, "emotion": "happy", "emotion_probability": 0.5889, "wear_facemask": false}, {"recognition_uidresult": "jane_doe", "recognition_confidence": 0.8371, "recognition_otheruids": [], "bbox": {"x1": 0.23795, "y1": 0.18893, "x2": 0.49398, "y2": 0.4886}, "liveness": {"is_real_face": true, "liveness_probability": 0.9145}, "age": 20.37, "gender": "female", "gender_probability": 0.89797, "emotion": "neutral", "emotion_probability": 0.67729, "wear_facemask": false}], "latency_ms": 490.98}
{"type": "object", "properties": {"status": {"type": "string"}, "image_file_name": {"type": "string"}, "recognition_result": {"type": "array", "items": {"type": "object", "properties": {"recognition_uidresult": {"type": "string"}, "recognition_confidence": {"type": "number"}, "recognition_otheruids": {"type": "array"}, "bbox": {"type": "object", "properties": {"x1": {"type": "number"}, "y1": {"type": "number"}, "x2": {"type": "number"}, "y2": {"type": "number"}}}, "is_real_face": {"type": "boolean"}, "is_real_face_probability": {"type": "number"}, "age": {"type": "number"}, "gender": {"type": "string"}, "gender_probability": {"type": "number"}, "emotion": {"type": "string"}, "emotion_probability": {"type": "number"}, "wear_facemask": {"type": "boolean"}}}}, "latency_ms": {"type": "number"}}}
b47643a4-9808-4ae9-97fb-8cdc25e03370/0c1d0262-c447-4b73-8eed-cd18b87adc1d/0/0
Face Recognition
A comprehensive solution for face recognition and analysis, integrated with a dedicated database. It accurately identifies the location of human faces, provides recognized unique identifiers (UIDs), incorporates liveness detection, determines age and gender, analyzes facial expressions (emotions), and includes facemask detection functionality.
9.4
Update Face
Update a Face to database enter the face id as x-face-uid in the header
200
Success Example
{"status": "success", "message": "john_doe face_uid updated successfully", "time_ms": 211.28, "image_file_names": ["WhatsApp Image 2022-08-12 at 14.11.10 (1).jpeg", "IMG_2911.JPG"]}
{"$schema": "http://json-schema.org/schema#", "type": "object", "properties": {"status": {"type": "string"}, "message": {"type": "string"}, "time_ms": {"type": "number"}, "image_file_names": {"type": "array", "items": {"type": "string"}}}, "required": ["image_file_names", "message", "status", "time_ms"]}
b47643a4-9808-4ae9-97fb-8cdc25e03370/ea2af151-5937-461c-8e78-53edc3094854/0/0
Face Recognition
A comprehensive solution for face recognition and analysis, integrated with a dedicated database. It accurately identifies the location of human faces, provides recognized unique identifiers (UIDs), incorporates liveness detection, determines age and gender, analyzes facial expressions (emotions), and includes facemask detection functionality.
9.4
Register Face
Register a Face to database enter the face id as x-face-uid in the header (case sensitive) input the face image in "face_image" form, if you have more than one image for one UID, upload the additional image as additional_face_image_0, additional_face_image_1, additional_face_image_2. You have maximum 3 additional images, So in total you can have 4 face images in one UID Having more face images will result in higher recognition accuracy & robustness
200
Success Example
{"status": "success", "message": "john_doe registered successfully", "time_ms": 583.42, "image_file_names": ["WhatsApp Image 2022-08-12 at 14.11.10 (1).jpeg"]}
{"$schema": "http://json-schema.org/schema#", "type": "object", "properties": {"status": {"type": "string"}, "message": {"type": "string"}, "time_ms": {"type": "number"}, "image_file_names": {"type": "array", "items": {"type": "string"}}}, "required": ["image_file_names", "message", "status", "time_ms"]}
b47643a4-9808-4ae9-97fb-8cdc25e03370/b6fa1c58-746f-426a-b9e3-6dbd222e09e0/0/0
Face Recognition
A comprehensive solution for face recognition and analysis, integrated with a dedicated database. It accurately identifies the location of human faces, provides recognized unique identifiers (UIDs), incorporates liveness detection, determines age and gender, analyzes facial expressions (emotions), and includes facemask detection functionality.
9.4
Reset DB
Clear & Delete all face uid in your DB WARNING : all uids will not be backed up
200
Success Example
{"status": "success", "message": true}
{"type": "object", "properties": {"status": {"type": "string"}, "message": {"type": "boolean"}}}
b47643a4-9808-4ae9-97fb-8cdc25e03370/d69eedeb-fd4b-437f-a890-90cfde389d4b/0/0
Face Recognition
A comprehensive solution for face recognition and analysis, integrated with a dedicated database. It accurately identifies the location of human faces, provides recognized unique identifiers (UIDs), incorporates liveness detection, determines age and gender, analyzes facial expressions (emotions), and includes facemask detection functionality.
9.4
Register Face 2
Register a Face to database enter the face id as x-face-uid in the header (case sensitive) same as "regular" Register Face endpoint above but using JSON body of image urls as input
200
Success Example
{"status": "success", "message": "john_doe registered successfully", "time_ms": 583.42, "image_file_names": ["WhatsApp Image 2022-08-12 at 14.11.10 (1).jpeg"]}
{"type": "object", "properties": {"status": {"type": "string"}, "message": {"type": "string"}, "time_ms": {"type": "number"}, "image_file_names": {"type": "array", "items": {"type": "string"}}}}
b47643a4-9808-4ae9-97fb-8cdc25e03370/8a4472ea-283b-4a6c-af3e-35608efe3130/0/0
Face Recognition
A comprehensive solution for face recognition and analysis, integrated with a dedicated database. It accurately identifies the location of human faces, provides recognized unique identifiers (UIDs), incorporates liveness detection, determines age and gender, analyzes facial expressions (emotions), and includes facemask detection functionality.
9.4
View DB
Read / view all face uids in your DB as "faces_list"
200
Success Example
{"status": "success", "message": "faces list retrieved successfully", "faces_list": ["bagus_pamungkas", "hilmy_izzulhaq", "john_doe"], "time_ms": 20.08}
{"type": "object", "properties": {"status": {"type": "string"}, "message": {"type": "string"}, "faces_list": {"type": "array", "items": {"type": "string"}}, "time_ms": {"type": "number"}}}
b47643a4-9808-4ae9-97fb-8cdc25e03370/6a72f992-517f-4992-851c-f7786549fa55/0/0
Face Recognition
A comprehensive solution for face recognition and analysis, integrated with a dedicated database. It accurately identifies the location of human faces, provides recognized unique identifiers (UIDs), incorporates liveness detection, determines age and gender, analyzes facial expressions (emotions), and includes facemask detection functionality.
9.4
Delete Face
Delete a face uid from your DB
200
Success Example
{"status": "success", "message": "john_doe deleted successfully", "time_ms": 3.15}
{"$schema": "http://json-schema.org/schema#", "type": "object", "properties": {"status": {"type": "string"}, "message": {"type": "string"}, "time_ms": {"type": "number"}}, "required": ["message", "status", "time_ms"]}
db6d226c-e99a-42d8-a0b6-8e4c1eb891f3/4ebe066c-eff6-4111-b451-9f70e57e032c/0/0
HyperVerge Face Recognition
Offers highly accurate Deep Learning models for Face Liveness Verification, Face Match and Face Search (1:N). HyperVerge Face APIs have been used to process over 400 Million KYC checks across some of the largest banks, telcos, lenders and brokerages in the world. A NIST FRVT Top-100 solution
null
Selfie to Selfie Match
API to do a 1:1 match between 2 selfie face images
200
Example_1
{"requestId": "1622452110145-8614dc14-320d-4d8f-960b-fce214eb6d03", "result": {"match": "yes", "match-score": 86, "to-be-reviewed": "no"}, "status": "success", "statusCode": "200"}
{"$schema": "http://json-schema.org/schema#", "type": "object", "properties": {"requestId": {"type": "string"}, "result": {"type": "object", "properties": {"match": {"type": "string"}, "match-score": {"type": "integer"}, "to-be-reviewed": {"type": "string"}}, "required": ["match", "match-score", "to-be-reviewed"]}, "status": {"type": "string"}, "statusCode": {"type": "string"}}, "required": ["requestId", "result", "status", "statusCode"]}
db6d226c-e99a-42d8-a0b6-8e4c1eb891f3/e783a18c-a5ff-40af-8793-740a508aabe0/0/0
HyperVerge Face Recognition
Offers highly accurate Deep Learning models for Face Liveness Verification, Face Match and Face Search (1:N). HyperVerge Face APIs have been used to process over 400 Million KYC checks across some of the largest banks, telcos, lenders and brokerages in the world. A NIST FRVT Top-100 solution
null
Selfie to ID Card Match
API to do a 1:1 match between a selfie and an ID card
200
Example_1
{"requestId": "1622452110145-8614dc14-320d-4d8f-960b-fce214eb6d03", "result": {"match": "yes", "match-score": 86, "to-be-reviewed": "no"}, "status": "success", "statusCode": "200"}
{"$schema": "http://json-schema.org/schema#", "type": "object", "properties": {"requestId": {"type": "string"}, "result": {"type": "object", "properties": {"match": {"type": "string"}, "match-score": {"type": "integer"}, "to-be-reviewed": {"type": "string"}}, "required": ["match", "match-score", "to-be-reviewed"]}, "status": {"type": "string"}, "statusCode": {"type": "string"}}, "required": ["requestId", "result", "status", "statusCode"]}
6080d821-d82e-46f0-9d0c-940ed50131b6/fbdbca00-bbe9-4971-bfe2-9dd37ad66c88/0/0
Recaptcha V2 Solver
0.80$/1000 Only default recaptcha is officially supported, enterprise may or may not work. Solves Recaptcha V2 automatically and returns a token. Latency displays average solve time.
2.4
Request Recaptcha V2 Token
Creates a request to solve Recaptcha V2 and returns a token.
200
New Example
{"token": "example"}
{"$schema": "http://json-schema.org/schema#", "type": "object", "properties": {"token": {"type": "string"}}, "required": ["token"]}
2170ba45-17a5-42dd-a8ea-7d0dd2587761/d2ddd18e-560c-4e44-baaa-8084dcd07bce/0/0
Label Detection
Extract labels from image using (google vision label detection)
7.5
POST Label Detection
the important thing is that you should use image as a form_data key Example const data = new FormData(); data.append(‘image’, ‘image_path’);
200
New Example
{"labels": [{"text": "Wheel", "score": 0.972192645072937, "locale": ""}, {"text": "Tire", "score": 0.9719410538673401, "locale": ""}, {"text": "Car", "score": 0.9633665084838867, "locale": ""}, {"text": "Land vehicle", "score": 0.9593533277511597, "locale": ""}, {"text": "Vehicle", "score": 0.9581815004348755, "locale": ""}, {"text": "Automotive lighting", "score": 0.9251698851585388, "locale": ""}, {"text": "Hood", "score": 0.9182775616645813, "locale": ""}, {"text": "Motor vehicle", "score": 0.9135331511497498, "locale": ""}, {"text": "Automotive tire", "score": 0.9109680652618408, "locale": ""}, {"text": "Automotive design", "score": 0.9046841859817505, "locale": ""}], "success": true, "dimensions": {"height": 800, "width": 800, "type": "jpg"}}
{"type": "object", "properties": {"labels": {"type": "array", "items": {"type": "object", "properties": {"text": {"type": "string"}, "score": {"type": "number"}, "locale": {"type": "string"}}}}, "success": {"type": "boolean"}, "dimensions": {"type": "object", "properties": {"height": {"type": "integer"}, "width": {"type": "integer"}, "type": {"type": "string"}}}}}
2170ba45-17a5-42dd-a8ea-7d0dd2587761/5d6ce645-e302-47dc-a973-d278181c76d8/0/0
Label Detection
Extract labels from image using (google vision label detection)
7.5
GET Label Detection
the important thing is that you should use image as a query name Example (url?image=“image_url”)
200
New Example
{"labels": [{"text": "Wheel", "score": 0.972192645072937, "locale": ""}, {"text": "Tire", "score": 0.9719410538673401, "locale": ""}, {"text": "Car", "score": 0.9633665084838867, "locale": ""}, {"text": "Land vehicle", "score": 0.9593533277511597, "locale": ""}, {"text": "Vehicle", "score": 0.9581815004348755, "locale": ""}, {"text": "Automotive lighting", "score": 0.9251698851585388, "locale": ""}, {"text": "Hood", "score": 0.9182775616645813, "locale": ""}, {"text": "Motor vehicle", "score": 0.9135331511497498, "locale": ""}, {"text": "Automotive tire", "score": 0.9109680652618408, "locale": ""}, {"text": "Automotive design", "score": 0.9046841859817505, "locale": ""}], "success": true, "dimensions": {"height": 800, "width": 800, "type": "jpg"}}
{"type": "object", "properties": {"labels": {"type": "array", "items": {"type": "object", "properties": {"text": {"type": "string"}, "score": {"type": "number"}, "locale": {"type": "string"}}}}, "success": {"type": "boolean"}, "dimensions": {"type": "object", "properties": {"height": {"type": "integer"}, "width": {"type": "integer"}, "type": {"type": "string"}}}}}
cbf1cc0c-5bd6-4532-95f8-12fabd688444/07e1dca3-78d2-4738-a89f-6047bc602786/0/0
Hand Recognition
An input image (decodable normally and with appropriate aspect ratio) detects the hands in the image and outputs the coordinate frame, 21 bone node coordinate information of each hand.
8.3
Hand Recognition
Hand Recognition
200
Response
{"code": 0, "data": {"hand_info": [{"hand_parts": {"0": {"score": 0.816012442111969, "x": 829, "y": 707}, "1": {"score": 0.6850220561027527, "x": 873, "y": 620}, "2": {"score": 0.7553223967552185, "x": 916, "y": 533}, "3": {"score": 0.7928290963172913, "x": 938, "y": 467}, "4": {"score": 0.8811469674110413, "x": 993, "y": 380}, "5": {"score": 0.907237708568573, "x": 829, "y": 424}, "6": {"score": 0.6283305883407593, "x": 862, "y": 358}, "7": {"score": 0.7752542495727539, "x": 916, "y": 391}, "8": {"score": 0.8796406984329224, "x": 927, "y": 456}, "9": {"score": 0.9138934016227722, "x": 775, "y": 402}, "10": {"score": 0.8594757318496704, "x": 786, "y": 325}, "11": {"score": 0.8891844153404236, "x": 818, "y": 249}, "12": {"score": 0.8527721166610718, "x": 840, "y": 151}, "13": {"score": 0.8194193243980408, "x": 720, "y": 424}, "14": {"score": 0.8391802310943604, "x": 720, "y": 347}, "15": {"score": 0.8413540720939636, "x": 720, "y": 282}, "16": {"score": 0.8511560559272766, "x": 731, "y": 194}, "17": {"score": 0.8470436334609985, "x": 687, "y": 489}, "18": {"score": 0.8878283500671387, "x": 644, "y": 434}, "19": {"score": 0.8626729846000671, "x": 622, "y": 391}, "20": {"score": 0.9111039638519287, "x": 567, "y": 325}}, "location": {"height": 556, "left": 567, "score": 17.49588012695312, "top": 151, "width": 426}}], "hand_num": 1, "log_id": 1616415307480450800}, "message": "success"}
{"$schema": "http://json-schema.org/schema#", "type": "object", "properties": {"code": {"type": "integer"}, "data": {"type": "object", "properties": {"hand_info": {"type": "array", "items": {"type": "object", "properties": {"hand_parts": {"type": "object", "properties": {"0": {"type": "object", "properties": {"score": {"type": "number"}, "x": {"type": "integer"}, "y": {"type": "integer"}}, "required": ["score", "x", "y"]}, "1": {"type": "object", "properties": {"score": {"type": "number"}, "x": {"type": "integer"}, "y": {"type": "integer"}}, "required": ["score", "x", "y"]}, "2": {"type": "object", "properties": {"score": {"type": "number"}, "x": {"type": "integer"}, "y": {"type": "integer"}}, "required": ["score", "x", "y"]}, "3": {"type": "object", "properties": {"score": {"type": "number"}, "x": {"type": "integer"}, "y": {"type": "integer"}}, "required": ["score", "x", "y"]}, "4": {"type": "object", "properties": {"score": {"type": "number"}, "x": {"type": "integer"}, "y": {"type": "integer"}}, "required": ["score", "x", "y"]}, "5": {"type": "object", "properties": {"score": {"type": "number"}, "x": {"type": "integer"}, "y": {"type": "integer"}}, "required": ["score", "x", "y"]}, "6": {"type": "object", "properties": {"score": {"type": "number"}, "x": {"type": "integer"}, "y": {"type": "integer"}}, "required": ["score", "x", "y"]}, "7": {"type": "object", "properties": {"score": {"type": "number"}, "x": {"type": "integer"}, "y": {"type": "integer"}}, "required": ["score", "x", "y"]}, "8": {"type": "object", "properties": {"score": {"type": "number"}, "x": {"type": "integer"}, "y": {"type": "integer"}}, "required": ["score", "x", "y"]}, "9": {"type": "object", "properties": {"score": {"type": "number"}, "x": {"type": "integer"}, "y": {"type": "integer"}}, "required": ["score", "x", "y"]}, "10": {"type": "object", "properties": {"score": {"type": "number"}, "x": {"type": "integer"}, "y": {"type": "integer"}}, "required": ["score", "x", "y"]}, "11": {"type": "object", "properties": {"score": {"type": "number"}, "x": {"type": "integer"}, "y": {"type": "integer"}}, "required": ["score", "x", "y"]}, "12": {"type": "object", "properties": {"score": {"type": "number"}, "x": {"type": "integer"}, "y": {"type": "integer"}}, "required": ["score", "x", "y"]}, "13": {"type": "object", "properties": {"score": {"type": "number"}, "x": {"type": "integer"}, "y": {"type": "integer"}}, "required": ["score", "x", "y"]}, "14": {"type": "object", "properties": {"score": {"type": "number"}, "x": {"type": "integer"}, "y": {"type": "integer"}}, "required": ["score", "x", "y"]}, "15": {"type": "object", "properties": {"score": {"type": "number"}, "x": {"type": "integer"}, "y": {"type": "integer"}}, "required": ["score", "x", "y"]}, "16": {"type": "object", "properties": {"score": {"type": "number"}, "x": {"type": "integer"}, "y": {"type": "integer"}}, "required": ["score", "x", "y"]}, "17": {"type": "object", "properties": {"score": {"type": "number"}, "x": {"type": "integer"}, "y": {"type": "integer"}}, "required": ["score", "x", "y"]}, "18": {"type": "object", "properties": {"score": {"type": "number"}, "x": {"type": "integer"}, "y": {"type": "integer"}}, "required": ["score", "x", "y"]}, "19": {"type": "object", "properties": {"score": {"type": "number"}, "x": {"type": "integer"}, "y": {"type": "integer"}}, "required": ["score", "x", "y"]}, "20": {"type": "object", "properties": {"score": {"type": "number"}, "x": {"type": "integer"}, "y": {"type": "integer"}}, "required": ["score", "x", "y"]}}, "required": ["0", "1", "10", "11", "12", "13", "14", "15", "16", "17", "18", "19", "2", "20", "3", "4", "5", "6", "7", "8", "9"]}, "location": {"type": "object", "properties": {"height": {"type": "integer"}, "left": {"type": "integer"}, "score": {"type": "number"}, "top": {"type": "integer"}, "width": {"type": "integer"}}, "required": ["height", "left", "score", "top", "width"]}}, "required": ["hand_parts", "location"]}}, "hand_num": {"type": "integer"}, "log_id": {"type": "integer"}}, "required": ["hand_info", "hand_num", "log_id"]}, "message": {"type": "string"}}, "required": ["code", "data", "message"]}
f65d466d-9d6b-4b5d-914f-7fac819a8018/159c528f-bce0-470d-9ad3-a343beb00d37/0/0
Landmark Detection
Extract list of locations, name, boundingBox, score, locale and dimensions from image using (google vision landmark detection)
5.3
GET Landmark Detection
the important thing is that you should use image as a query name Example (url?image=“image_url”)
200
New Example
{"landmarks": [{"locations": [{"latitude": 55.75393029999999, "longitude": 37.620794999999994}], "text": "Red Square", "score": 0.9382750988006592, "locale": "", "boundingBox": {"tl": {"x": 0, "y": 0}, "tr": {"x": 640, "y": 0}, "br": {"x": 640, "y": 408}, "bl": {"x": 0, "y": 408}}}, {"locations": [{"latitude": 55.7520233, "longitude": 37.6174994}], "text": "The Moscow Kremlin", "score": 0.8010982871055603, "locale": "", "boundingBox": {"tl": {"x": 0, "y": 0}, "tr": {"x": 640, "y": 0}, "br": {"x": 640, "y": 408}, "bl": {"x": 0, "y": 408}}}], "success": true, "dimensions": {"height": 408, "width": 640, "type": "webp"}}
{"type": "object", "properties": {"landmarks": {"type": "array", "items": {"type": "object", "properties": {"locations": {"type": "array", "items": {"type": "object", "properties": {"latitude": {"type": "number"}, "longitude": {"type": "number"}}}}, "text": {"type": "string"}, "score": {"type": "number"}, "locale": {"type": "string"}, "boundingBox": {"type": "object", "properties": {"tl": {"type": "object", "properties": {"x": {"type": "integer"}, "y": {"type": "integer"}}}, "tr": {"type": "object", "properties": {"x": {"type": "integer"}, "y": {"type": "integer"}}}, "br": {"type": "object", "properties": {"x": {"type": "integer"}, "y": {"type": "integer"}}}, "bl": {"type": "object", "properties": {"x": {"type": "integer"}, "y": {"type": "integer"}}}}}}}}, "success": {"type": "boolean"}, "dimensions": {"type": "object", "properties": {"height": {"type": "integer"}, "width": {"type": "integer"}, "type": {"type": "string"}}}}}
f65d466d-9d6b-4b5d-914f-7fac819a8018/634f36bf-2e52-4f5f-9345-9992cae926e2/0/0
Landmark Detection
Extract list of locations, name, boundingBox, score, locale and dimensions from image using (google vision landmark detection)
5.3
POST Landmark Detection
the important thing is that you should use image as a form_data key Example const data = new FormData(); data.append(‘image’, ‘image_path’);
200
New Example
{"landmarks": [{"locations": [{"latitude": 55.75393029999999, "longitude": 37.620794999999994}], "text": "Red Square", "score": 0.9382750988006592, "locale": "", "boundingBox": {"tl": {"x": 0, "y": 0}, "tr": {"x": 640, "y": 0}, "br": {"x": 640, "y": 408}, "bl": {"x": 0, "y": 408}}}, {"locations": [{"latitude": 55.7520233, "longitude": 37.6174994}], "text": "The Moscow Kremlin", "score": 0.8010982871055603, "locale": "", "boundingBox": {"tl": {"x": 0, "y": 0}, "tr": {"x": 640, "y": 0}, "br": {"x": 640, "y": 408}, "bl": {"x": 0, "y": 408}}}], "success": true, "dimensions": {"height": 408, "width": 640, "type": "webp"}}
{"type": "object", "properties": {"landmarks": {"type": "array", "items": {"type": "object", "properties": {"locations": {"type": "array", "items": {"type": "object", "properties": {"latitude": {"type": "number"}, "longitude": {"type": "number"}}}}, "text": {"type": "string"}, "score": {"type": "number"}, "locale": {"type": "string"}, "boundingBox": {"type": "object", "properties": {"tl": {"type": "object", "properties": {"x": {"type": "integer"}, "y": {"type": "integer"}}}, "tr": {"type": "object", "properties": {"x": {"type": "integer"}, "y": {"type": "integer"}}}, "br": {"type": "object", "properties": {"x": {"type": "integer"}, "y": {"type": "integer"}}}, "bl": {"type": "object", "properties": {"x": {"type": "integer"}, "y": {"type": "integer"}}}}}}}}, "success": {"type": "boolean"}, "dimensions": {"type": "object", "properties": {"height": {"type": "integer"}, "width": {"type": "integer"}, "type": {"type": "string"}}}}}
07e09992-014e-4d81-bf69-10c0aac32582/affa777c-7836-4fe4-ba99-b7f823f967b1/0/0
OCR Text Extractor
Powerful image optical character recognition (OCR) for over 20 languages and with machine-readable-zone support. Perfect for a wide range of use-cases, including but not limited to receipt and invoice scanning as well as general image-based text extraction, the default service currently allows you to POST an image of up to 1MB for analysis. If you require larger images, or PDF scans, please contact us for invitation to a custom plan.
8.2
Extract Text From Image URI
Perform OCR on an image located at designated URI and return the text detected
200
Example_1
{"parsedResults": [{"textOverlay": {"lines": [], "hasOverlay": true, "message": "Total lines: 0"}, "fileParseExitCode": "Success", "parsedText": "Google", "errorMessage": "", "errorDetails": ""}], "ocrExitCode": "ParseSuccess", "isErroredOnProcessing": false, "errorMessage": null, "errorDetails": null, "processingTimeInMilliseconds": "1445"}
{"type": "object", "properties": {"parsedResults": {"type": "array", "items": {"type": "object", "properties": {"textOverlay": {"type": "object", "properties": {"lines": {"type": "array"}, "hasOverlay": {"type": "boolean"}, "message": {"type": "string"}}}, "fileParseExitCode": {"type": "string"}, "parsedText": {"type": "string"}, "errorMessage": {"type": "string"}, "errorDetails": {"type": "string"}}}}, "ocrExitCode": {"type": "string"}, "isErroredOnProcessing": {"type": "boolean"}, "errorMessage": {"type": "null"}, "errorDetails": {"type": "null"}, "processingTimeInMilliseconds": {"type": "string"}}}
095a9bc9-d816-4efd-82c1-81ca0d3a21b0/997cbd88-67df-4208-920a-e6660279430e/0/0
Face Compare
face verification
null
Face Compare
Face match
200
New Example
{"matchedFaces": [{"matchResult": 1, "confidence": 100, "image1_face": {"faceRectangle": {"x": 12, "y": 11, "height": 249, "width": 203}, "points": [{"x": 12.7949295, "y": 18.13095}, {"x": 206.91957, "y": 11.364868}, {"x": 21.252525, "y": 260.78677}, {"x": 215.37718, "y": 254.02069}], "quality": 46.583878}, "image2_face": {"faceRectangle": {"x": 12, "y": 11, "height": 249, "width": 203}, "points": [{"x": 12.7949295, "y": 18.13095}, {"x": 206.91957, "y": 11.364868}, {"x": 21.252525, "y": 260.78677}, {"x": 215.37718, "y": 254.02069}], "quality": 46.583878}}]}
{"$schema": "http://json-schema.org/schema#", "type": "object", "properties": {"matchedFaces": {"type": "array", "items": {"type": "object", "properties": {"matchResult": {"type": "integer"}, "confidence": {"type": "integer"}, "image1_face": {"type": "object", "properties": {"faceRectangle": {"type": "object", "properties": {"x": {"type": "integer"}, "y": {"type": "integer"}, "height": {"type": "integer"}, "width": {"type": "integer"}}, "required": ["height", "width", "x", "y"]}, "points": {"type": "array", "items": {"type": "object", "properties": {"x": {"type": "number"}, "y": {"type": "number"}}, "required": ["x", "y"]}}, "quality": {"type": "number"}}, "required": ["faceRectangle", "points", "quality"]}, "image2_face": {"type": "object", "properties": {"faceRectangle": {"type": "object", "properties": {"x": {"type": "integer"}, "y": {"type": "integer"}, "height": {"type": "integer"}, "width": {"type": "integer"}}, "required": ["height", "width", "x", "y"]}, "points": {"type": "array", "items": {"type": "object", "properties": {"x": {"type": "number"}, "y": {"type": "number"}}, "required": ["x", "y"]}}, "quality": {"type": "number"}}, "required": ["faceRectangle", "points", "quality"]}}, "required": ["confidence", "image1_face", "image2_face", "matchResult"]}}}, "required": ["matchedFaces"]}
755be0b6-2462-4e2c-8641-c12c848a4cd8/951cc5ed-6df1-4f3c-b267-a55113ff2ba7/0/0
FaceAnalysis
Use our API for face detection, facial emotions, age and gender.
8.3
Age and gender by URL
Endpoint for age and gender prediction. Send us link to image, we return position of detected faces and predicted age and gender. Check out our tutorials for example of usage in Python.
200
New Example
{"detections": [{"crop": {"x1": 0.49029475450515747, "y1": 0.5199255347251892, "x2": 0.5589765906333923, "y2": 0.38276559114456177, "score": 0.9992923736572266}, "age": 23, "gender": {"F": 0.999700665473938, "M": 0.0002993345260620117}}, {"crop": {"x1": 0.11643223464488983, "y1": 0.5169875025749207, "x2": 0.1809975504875183, "y2": 0.39529597759246826, "score": 0.998594343662262}, "age": 22, "gender": {"F": 0.002291440963745117, "M": 0.9977085590362549}}, {"crop": {"x1": 0.8563294410705566, "y1": 0.24784332513809204, "x2": 0.917901873588562, "y2": 0.12237813323736191, "score": 0.9980091452598572}, "age": 33, "gender": {"F": 0.9146032929420471, "M": 0.08539670705795288}}, {"crop": {"x1": 0.1482899785041809, "y1": 0.3003842234611511, "x2": 0.20176897943019867, "y2": 0.20043990015983582, "score": 0.9973342418670654}, "age": 19, "gender": {"F": 0.9946532249450684, "M": 0.005346775054931641}}, {"crop": {"x1": 0.598613440990448, "y1": 0.3124071955680847, "x2": 0.6528789401054382, "y2": 0.20392273366451263, "score": 0.9954931735992432}, "age": 24, "gender": {"F": 0.005447328090667725, "M": 0.9945526719093323}}, {"crop": {"x1": 0.7280519008636475, "y1": 0.5563205480575562, "x2": 0.7874197363853455, "y2": 0.4102036952972412, "score": 0.7963488101959229}, "age": 39, "gender": {"F": 0.8345146179199219, "M": 0.16548538208007812}}]}
{"type": "object", "properties": {"detections": {"type": "array", "items": {"type": "object", "properties": {"crop": {"type": "object", "properties": {"x1": {"type": "number"}, "y1": {"type": "number"}, "x2": {"type": "number"}, "y2": {"type": "number"}, "score": {"type": "number"}}}, "age": {"type": "integer"}, "gender": {"type": "object", "properties": {"F": {"type": "number"}, "M": {"type": "number"}}}}}}}}
755be0b6-2462-4e2c-8641-c12c848a4cd8/61531577-d6aa-4f83-af74-910b898b988d/0/0
FaceAnalysis
Use our API for face detection, facial emotions, age and gender.
8.3
BMI by URL
Endpoint for BMI estimation based on photo of face. Check out our tutorials for example of usage in Python.
200
New Example
{"detections": [{"crop": {"x1": 0.49029475450515747, "y1": 0.5199255347251892, "x2": 0.5589765906333923, "y2": 0.38276559114456177, "score": 0.9992923736572266}, "bmi": 22.93121337890625}, {"crop": {"x1": 0.11643223464488983, "y1": 0.5169875025749207, "x2": 0.18099753558635712, "y2": 0.39529597759246826, "score": 0.998594343662262}, "bmi": 26.735450744628906}, {"crop": {"x1": 0.8563294410705566, "y1": 0.24784332513809204, "x2": 0.917901873588562, "y2": 0.12237813323736191, "score": 0.9980091452598572}, "bmi": 26.188823699951172}, {"crop": {"x1": 0.1482899785041809, "y1": 0.3003842234611511, "x2": 0.20176897943019867, "y2": 0.20043990015983582, "score": 0.9973342418670654}, "bmi": 29.62228775024414}, {"crop": {"x1": 0.598613440990448, "y1": 0.3124071955680847, "x2": 0.6528789401054382, "y2": 0.20392273366451263, "score": 0.9954931735992432}, "bmi": 25.00752830505371}, {"crop": {"x1": 0.7280519008636475, "y1": 0.5563205480575562, "x2": 0.7874197363853455, "y2": 0.4102036952972412, "score": 0.7963487505912781}, "bmi": 23.535701751708984}]}
{"type": "object", "properties": {"detections": {"type": "array", "items": {"type": "object", "properties": {"crop": {"type": "object", "properties": {"x1": {"type": "number"}, "y1": {"type": "number"}, "x2": {"type": "number"}, "y2": {"type": "number"}, "score": {"type": "number"}}}, "bmi": {"type": "number"}}}}}}
755be0b6-2462-4e2c-8641-c12c848a4cd8/096dcc7e-1cef-4912-816e-aa8db14fd414/0/0
FaceAnalysis
Use our API for face detection, facial emotions, age and gender.
8.3
Face Detection
Endpoint for face detection. Send us image, we return position of detected faces. Check out our tutorials for example of usage in Python.
200
New Example
{"detections": [{"crop": {"x1": 0.49029475450515747, "y1": 0.5199255347251892, "x2": 0.5589765906333923, "y2": 0.38276559114456177, "score": 0.9992923736572266}}, {"crop": {"x1": 0.11643223464488983, "y1": 0.5169875025749207, "x2": 0.18099753558635712, "y2": 0.39529597759246826, "score": 0.998594343662262}}, {"crop": {"x1": 0.8563294410705566, "y1": 0.24784332513809204, "x2": 0.917901873588562, "y2": 0.12237813323736191, "score": 0.9980091452598572}}, {"crop": {"x1": 0.1482899785041809, "y1": 0.3003842234611511, "x2": 0.20176897943019867, "y2": 0.20043990015983582, "score": 0.9973342418670654}}, {"crop": {"x1": 0.598613440990448, "y1": 0.3124071955680847, "x2": 0.6528789401054382, "y2": 0.20392271876335144, "score": 0.9954931735992432}}, {"crop": {"x1": 0.7280519604682922, "y1": 0.5563205480575562, "x2": 0.7874197959899902, "y2": 0.4102036952972412, "score": 0.7963487505912781}}]}
{"type": "object", "properties": {"detections": {"type": "array", "items": {"type": "object", "properties": {"crop": {"type": "object", "properties": {"x1": {"type": "number"}, "y1": {"type": "number"}, "x2": {"type": "number"}, "y2": {"type": "number"}, "score": {"type": "number"}}}}}}}}
755be0b6-2462-4e2c-8641-c12c848a4cd8/24eacd7d-ee3b-44f1-84c4-19bbb4a84941/0/0
FaceAnalysis
Use our API for face detection, facial emotions, age and gender.
8.3
Age and gender
Endpoint for age and gender prediction. Send us image, we return position of detected faces and predicted age and gender. Check out our tutorials for example of usage in Python.
200
New Example
{"detections": [{"crop": {"x1": 0.49029475450515747, "y1": 0.5199255347251892, "x2": 0.5589765906333923, "y2": 0.38276559114456177, "score": 0.9992923736572266}, "age": 23, "gender": {"F": 0.999700665473938, "M": 0.0002993345260620117}}, {"crop": {"x1": 0.11643223464488983, "y1": 0.5169875025749207, "x2": 0.1809975504875183, "y2": 0.39529597759246826, "score": 0.998594343662262}, "age": 22, "gender": {"F": 0.002291440963745117, "M": 0.9977085590362549}}, {"crop": {"x1": 0.8563294410705566, "y1": 0.24784332513809204, "x2": 0.917901873588562, "y2": 0.12237813323736191, "score": 0.9980091452598572}, "age": 33, "gender": {"F": 0.9146032929420471, "M": 0.08539670705795288}}, {"crop": {"x1": 0.1482899785041809, "y1": 0.3003842234611511, "x2": 0.20176897943019867, "y2": 0.20043990015983582, "score": 0.9973342418670654}, "age": 19, "gender": {"F": 0.9946532249450684, "M": 0.005346775054931641}}, {"crop": {"x1": 0.598613440990448, "y1": 0.3124071955680847, "x2": 0.6528789401054382, "y2": 0.20392273366451263, "score": 0.9954931735992432}, "age": 24, "gender": {"F": 0.005447328090667725, "M": 0.9945526719093323}}, {"crop": {"x1": 0.7280519008636475, "y1": 0.5563205480575562, "x2": 0.7874197363853455, "y2": 0.4102036952972412, "score": 0.7963488101959229}, "age": 39, "gender": {"F": 0.8345146179199219, "M": 0.16548538208007812}}]}
{"type": "object", "properties": {"detections": {"type": "array", "items": {"type": "object", "properties": {"crop": {"type": "object", "properties": {"x1": {"type": "number"}, "y1": {"type": "number"}, "x2": {"type": "number"}, "y2": {"type": "number"}, "score": {"type": "number"}}}, "age": {"type": "integer"}, "gender": {"type": "object", "properties": {"F": {"type": "number"}, "M": {"type": "number"}}}}}}}}