List Address Suggestions

Beta

GET/v1/core/addresses/suggestions

This endpoint is idempotent. Learn more

Returns address suggestions for partial address text, for use in type-ahead address entry.

Only street addresses are suggested; cities, regions, and business listings are not returned. Suggestions are lookup results, not saved addresses in your account. Pass a suggestion's id to the address details endpoint to get the full parsed address.

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, and again when you retrieve the details of the suggestion the user picks, so the whole entry is treated as one lookup.

objectstringenumValues:list

Resource type identifier.

page_infoobject

Pagination metadata.

next_page_urlstringnullable

Relative URL that fetches the next page of results.

previous_page_urlstringnullable

Relative URL that fetches the previous page of results.

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

Identifier of the suggested place.

Pass this value as the id path parameter of the address details endpoint to retrieve the full parsed address. It is issued by the underlying address provider rather than by OpenMRP, so it is not a durable OpenMRP resource 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 OpenMRP from '@openmrp/sdk';

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

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

console.log(listAddressSuggestion.data);

import OpenMRP from '@openmrp/sdk';

const client = new OpenMRP({
  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.3eH_kVsFpUL8_Ftjl4AMlKInm4JGqDBZ5zVuFpC4R2s",
    "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.3eH_kVsFpUL8_Ftjl4AMlKInm4JGqDBZ5zVuFpC4R2s",
    "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