Autocomplete order address
Orders
Autocomplete order address
Use this endpoint to retrieve address suggestions based on a partial input string. Use this when you’re building an address input field in your platform UI - autocomplete reduces typos and helps end users land on complete, deliverable addresses before order placement.
Required parameters
addressquery parameter - partial address text from the user. 4-128 characters.countryquery parameter - country code to scope the suggestions to. 2-3 characters.
Optional parameters
companyIdquery parameter - Company identifier, when not inferable from the API key context (8+ alphanumeric characters)
Please note
- Returns an array of suggestions in the
resultsfield. Each entry follows the standard address shape (addressLine1,addressLine2,city,state,zipcode). - The
addressparameter is free text and the endpoint may be called frequently as the user types. Debounce input by 200-300ms before issuing the request to avoid excessive calls and stay within rate limits. - This endpoint is a UI helper - it suggests addresses but does not validate deliverability. Pair it with
POST /v2/orders/addresses/validatebefore placing an order if you need verified-deliverable addresses.
Permissions
- Requires:
orders:read:maskedororders:read:unmasked
GET
Autocomplete order address
Authorizations
Company Level Authentication
Company level authentication provides access to all resources under your company, including accounts, campaigns, gifts, and recipients.
Getting Your API Key
- Create an API Key: Use the
POST /v2/authentication/apiKeysendpoint to generate a new API key - Set Expiration: Choose from 30, 60, 90, or 180 days (default: 90 days)
- Optional mTLS: Enable mutual TLS for enhanced security
- Name Your Key: Provide a descriptive name for easy identification
Using Your API Key
Include your API key in the X-Api-Key header for every request:
X-Api-Key: YOUR_24_CHARACTER_API_KEYAPI Key Management
- Maximum Keys: Up to 3 active API keys per company
- Rotation: Delete old keys before creating new ones when at the limit
- Security: Keys are hashed and cannot be retrieved after creation
Enhanced Security (mTLS)
For production environments, enable mutual TLS authentication:
- Set
enforceMtls: truewhen creating the API key - Contact support to obtain your client certificates
- Use the mTLS endpoint:
https://mtls-api.snappy.com/public-api
Query Parameters
Company ID
Pattern:
^[A-Za-z0-9]{8,}$Example:
"12345678"
Address
Required string length:
4 - 128Example:
"123 Main St"
Country
Pattern:
^[A-Za-z0-9]{2,3}$Example:
"US"
Response
Ok
Autocomplete order address response.
The autocomplete address results.
Last modified on June 17, 2026