List Address Suggestions

Beta

GET/v1/core/addresses/suggestions

This endpoint is idempotent. Learn more

Returns address suggestions based on input text.

inputstring

Partial address text to generate suggestions for.

session_tokenoptional string

Opaque token that groups a series of related autocomplete requests into a single session.

Reuse the same token for each keystroke of one address entry.

objectstringenumValues:list

Resource type identifier.

page_infoobject

Pagination metadata.

next_page_urlstringnullable

Relative URL that fetches the next page of results.

null when the last page has been reached.

previous_page_urlstringnullable

Relative URL that fetches the previous page of results.

null while on the first page.

has_next_pageboolean

Whether more results exist after this page.

has_prev_pageboolean

Whether results exist before this page.

dataarray of address_suggestion

Resources in this page.

idstring

Address suggestion ID.

objectstringenumValues:address_suggestion

Resource type identifier.

descriptionstring

Full description of the address.

main_textstring

Main text (typically the street address).

secondary_textstring

Secondary text (typically city, state, country).

Responses

200

Successful response for List Address Suggestions

List Address Suggestions

import Augno from '@augno/sdk';

const client = new Augno({
  bearerToken: 'YOUR_API_KEY', // Your API key goes here
});

const listAddressSuggestion = await client.core.addresses.retrieveSuggestions({ input: 'input' });

console.log(listAddressSuggestion.data);

import Augno from '@augno/sdk';

const client = new Augno({
  bearerToken: 'YOUR_API_KEY', // Your API key goes here
});

const listAddressSuggestion = await client.core.addresses.retrieveSuggestions({ input: 'input' });

console.log(listAddressSuggestion.data);

200 example

{
  "object": "list",
  "page_info": {
    "next_page_url": "/v1/core/addresses/suggestions?cursor=eyJjIjoiMjAyNi0wNS0xMFQwMDowMDowMFoiLCJzIjoiQ2hJSmQ4QmxRMkJad29rUkFGVUVjbV9xcmNBIiwiZCI6ImYifQ.kGOYdH2Tkiz4NlyqiylUQMih0elKQZUe87DfXG4Vex0",
    "previous_page_url": null,
    "has_next_page": true,
    "has_prev_page": false
  },
  "data": [
    {
      "id": "ChIJd8BlQ2BZwokRAFUEcm_qrcA",
      "object": "address_suggestion",
      "description": "123 Main St, Springfield, IL 62701, USA",
      "main_text": "123 Main St",
      "secondary_text": "Springfield, IL 62701, USA"
    }
  ]
}

{
  "object": "list",
  "page_info": {
    "next_page_url": "/v1/core/addresses/suggestions?cursor=eyJjIjoiMjAyNi0wNS0xMFQwMDowMDowMFoiLCJzIjoiQ2hJSmQ4QmxRMkJad29rUkFGVUVjbV9xcmNBIiwiZCI6ImYifQ.kGOYdH2Tkiz4NlyqiylUQMih0elKQZUe87DfXG4Vex0",
    "previous_page_url": null,
    "has_next_page": true,
    "has_prev_page": false
  },
  "data": [
    {
      "id": "ChIJd8BlQ2BZwokRAFUEcm_qrcA",
      "object": "address_suggestion",
      "description": "123 Main St, Springfield, IL 62701, USA",
      "main_text": "123 Main St",
      "secondary_text": "Springfield, IL 62701, USA"
    }
  ]
}

List Address Suggestions

Query Parameters

Returns

Responses