{ "opencollection": "1.0.0", "info": { "name": "International Address Autocomplete Lookup API", "version": "0.9" }, "items": [ { "info": { "name": "Lookup", "type": "folder" }, "items": [ { "info": { "name": "Get Autocomplete Suggestions", "type": "http" }, "http": { "method": "GET", "url": "https://international-autocomplete.api.smarty.com/v2/lookup", "headers": [ { "name": "Host", "value": "" }, { "name": "Referer", "value": "" } ], "params": [ { "name": "country", "value": "", "type": "query", "description": "The ISO3 Alpha-3 country code where the desired address is located. Only uppercase values are allowed. See supported country codes (https://www.smarty.com/docs/cloud/international-address-autocomplete-api#supported-country-codes). Maximum length is 3 bytes." }, { "name": "search", "value": "", "type": "query", "description": "The part of the address that has already been typed. Maximum character count is 32 characters. Required when address ID is not specified in the URL." }, { "name": "max_results", "value": "", "type": "query", "description": "Maximum number of address suggestions to return; range [1, 10]. Default: 5" }, { "name": "max_group_results", "value": "", "type": "query", "description": "Maximum number of address suggestions to return when expanding address groups with an Address ID; range [1, 100]." }, { "name": "geolocation", "value": "", "type": "query", "description": "Bias (prefer) results based on the location of the sender's IP address (IPv4 only). Valid value: on \n Supported countries: CAN, AUS, DEU. If the request to the API goes through a proxy, you will need to set an X-Forwarded-For header specifying the desired IP address for the request." }, { "name": "include_only_locality", "value": "", "type": "query", "description": "Limit the results to only the locality provided. A locality is a significant population center (i.e. city, town, or village). When this parameter is used, include_only_postal_code cannot be used. Separate multiple values with a comma. Example: Paris,Versailles" }, { "name": "include_only_postal_code", "value": "", "type": "query", "description": "Limit the results to only the postal codes provided. When this parameter is used, include_only_locality cannot be used. Separate multiple values with a comma. Example: 29200,29201" } ], "auth": { "type": "apikey", "key": "auth-id", "value": "{{auth-id}}", "placement": "query" } }, "docs": "Get Autocomplete Suggestions" }, { "info": { "name": "Get Autocomplete Suggestions", "type": "http" }, "http": { "method": "GET", "url": "https://international-autocomplete.api.smarty.com/v2/lookup/:addressId", "headers": [ { "name": "Host", "value": "" }, { "name": "Referer", "value": "" } ], "params": [ { "name": "country", "value": "", "type": "query", "description": "The ISO3 Alpha-3 country code where the desired address is located. Only uppercase values are allowed. See supported country codes (https://www.smarty.com/docs/cloud/international-address-autocomplete-api#supported-country-codes). Maximum length is 3 bytes." }, { "name": "addressId", "value": "", "type": "path", "description": "The Address ID is used to get further information about a particular result. This value will be supplied by a previous call to the API. This parameter should not be supplied when the search query parameter is used." }, { "name": "max_results", "value": "", "type": "query", "description": "Maximum number of address suggestions to return; range [1, 10]. Default: 5" }, { "name": "max_group_results", "value": "", "type": "query", "description": "Maximum number of address suggestions to return when expanding address groups with an Address ID; range [1, 100]." }, { "name": "geolocation", "value": "", "type": "query", "description": "Bias (prefer) results based on the location of the sender's IP address (IPv4 only). Valid value: on \n Supported countries: CAN, AUS, DEU. If the request to the API goes through a proxy, you will need to set an X-Forwarded-For header specifying the desired IP address for the request." }, { "name": "include_only_locality", "value": "", "type": "query", "description": "Limit the results to only the locality provided. A locality is a significant population center (i.e. city, town, or village). When this parameter is used, include_only_postal_code cannot be used. Separate multiple values with a comma. Example: Paris,Versailles" }, { "name": "include_only_postal_code", "value": "", "type": "query", "description": "Limit the results to only the postal codes provided. When this parameter is used, include_only_locality cannot be used. Separate multiple values with a comma. Example: 29200,29201" } ], "auth": { "type": "apikey", "key": "auth-id", "value": "{{auth-id}}", "placement": "query" } }, "docs": "Get Autocomplete Suggestions" }, { "info": { "name": "Search country and locality/administrative area/postal code", "type": "http" }, "http": { "method": "GET", "url": "https://international-autocomplete.api.smarty.com/lookup", "headers": [ { "name": "Host", "value": "" } ], "params": [ { "name": "input_id", "value": "8675309", "type": "query", "description": "A unique identifier for this address used in your application; this field will be copied to the output" }, { "name": "country", "value": "", "type": "query", "description": "This must be entered with every address. Country Name or ISO classification (ISO-3, ISO-2, ISO-N). Address validation will fail if this is missing. (e.g. Brazil, BRA, BR, or 076)" }, { "name": "locality", "value": "Paris", "type": "query", "description": "The city name" }, { "name": "administrative_area", "value": "", "type": "query", "description": "The state or province name or abbreviation. (e.g. Alberta or AB)" }, { "name": "postal_code", "value": "", "type": "query", "description": "The postal code (e.g. T4B 5M7). You may submit a postal code preefix to widen your search. (e.g. T4B 5)" }, { "name": "license", "value": "", "type": "query", "description": "The license or licenses (comma-separated) to use for this lookup. Valid values can be found in the account dashboard under the appropriate subscription. If multiple licenses are specified, they are considered in left-to-right order." } ] }, "docs": "To send one (and only one) input to the API, simply encode the field names from the table below along with their corresponding values as query string parameters in the URL of your request. Here's an example that uses locality, administrative_area, postal_code, and country fields:\n```bash\n curl -v 'https://international-postal-code.api.smarty.com/lookup?\n \tauth-id=YOUR+AUTH-ID+HERE&\n \tauth-token=YOUR+AUTH-TOKEN+HERE&\n\n \tlocality=Sao+Paulo&\n \tadministrative_area=SP&\n \tpostal_code=0" }, { "info": { "name": "Search for a batch of ZIPCodes", "type": "http" }, "http": { "method": "POST", "url": "https://international-autocomplete.api.smarty.com/lookup", "headers": [ { "name": "Content-Type", "value": "" }, { "name": "Host", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "HTTP POST: Multiple Inputs\\n\\nA POST request allows a larger volume of data (MAX: 100 inputs or 16K per request) to be sent in the HTTP request body. In this case, the data should be encoded as a JSON array where each element in the array is a JSON object with field names identical to those in the field listing below. Here's a sample request with three inputs being sent:\n```\ncurl -v 'https://us-zipcode.api.smarty.com/lookup?\n auth-id=YOUR+AUTH-ID+HERE&\n auth-token=YOUR+AUTH-TOKEN+H" } ] } ], "bundled": true }