> ## Documentation Index
> Fetch the complete documentation index at: https://docs.salesive.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Autocomplete address

> Get real-time address suggestions as users type to improve address entry experience.

## Request

```http theme={null}
GET /shipping-address/autocomplete?text=No 1 Eugene&limit=5
Authorization: Bearer {{token}}
x-shop-id: {{shopId}}
```

## Headers

| Header          | Type   | Description                                   |
| --------------- | ------ | --------------------------------------------- |
| `Authorization` | string | Provide the customer token as `Bearer <jwt>`. |
| `x-shop-id`     | string | Identify the shop context.                    |

## Query parameters

| Parameter | Type    | Required | Description                                           |
| --------- | ------- | -------- | ----------------------------------------------------- |
| `text`    | string  | Yes      | Partial address text to search for.                   |
| `limit`   | integer | No       | Maximum number of suggestions to return (default: 5). |

## Successful response

```json theme={null}
{
  "status": 200,
  "success": true,
  "message": "Address suggestions retrieved",
  "data": {
    "suggestions": {
      "results": [
        {
          "formatted": "No 1 Eugene Oba Street, Enugu, Nigeria",
          "address_line1": "No 1 Eugene Oba Street",
          "address_line2": "Enugu, Enugu State",
          "city": "Enugu",
          "state": "Enugu State",
          "postcode": "400251",
          "country": "Nigeria",
          "lat": 6.4216348975198825,
          "lon": 7.483457659243914
        },
        {
          "formatted": "Eugene Street, Enugu, Nigeria",
          "address_line1": "Eugene Street",
          "address_line2": "Enugu, Enugu State",
          "city": "Enugu",
          "state": "Enugu State",
          "country": "Nigeria",
          "lat": 6.4520,
          "lon": 7.5120
        }
      ]
    }
  }
}
```

<Tip>
  Use this endpoint to provide address autocomplete as users type in address forms. It enhances user experience and reduces address entry errors.
</Tip>

## Error response

```json theme={null}
{
  "status": 400,
  "success": false,
  "message": "Search text is required",
  "data": {}
}
```


## OpenAPI

````yaml GET /shipping-address/autocomplete
openapi: 3.1.0
info:
  title: Salesive Store API
  description: >-
    REST interface for querying products, categories, and merchandising banners
    exposed by Salesive storefronts.
  version: 1.0.0
servers:
  - description: Production
    url: https://store.salesive.com/api/v1
security:
  - BearerAuth: []
    ShopIdHeader: []
paths:
  /shipping-address/autocomplete:
    get:
      summary: Autocomplete address
      description: >-
        Get real-time address suggestions as users type to improve address entry
        experience.
      parameters:
        - $ref: '#/components/parameters/XShopIdHeader'
        - name: text
          in: query
          required: true
          description: Partial address text to search for.
          schema:
            type: string
        - name: limit
          in: query
          required: false
          description: 'Maximum number of suggestions to return (default: 5).'
          schema:
            type: integer
            minimum: 1
            default: 5
      responses:
        '200':
          description: Address suggestions retrieved.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AutocompleteAddressResponse'
        '400':
          description: Search text is required.
        '401':
          description: Unauthorized.
components:
  parameters:
    XShopIdHeader:
      name: x-shop-id
      in: header
      description: >-
        Optional identifier that scopes responses to a specific storefront when
        the referer cannot be inferred.
      required: false
      schema:
        type: string
  schemas:
    AutocompleteAddressResponse:
      type: object
      required:
        - status
        - success
        - message
        - data
      properties:
        status:
          type: integer
        success:
          type: boolean
        message:
          type: string
        data:
          type: object
          properties:
            suggestions:
              type: object
              description: Geoapify autocomplete response.
              properties:
                results:
                  type: array
                  items:
                    $ref: '#/components/schemas/GeoapifyAddress'
    GeoapifyAddress:
      type: object
      properties:
        formatted:
          type: string
          description: Fully formatted address string.
        address_line1:
          type: string
          description: Primary address line (street, number).
        address_line2:
          type: string
          description: Secondary address line (city, state, postal code).
        city:
          type: string
          description: City name.
        state:
          type: string
          description: State or province name.
        postcode:
          type: string
          description: Postal or ZIP code.
        country:
          type: string
          description: Country name.
        country_code:
          type: string
          description: ISO country code.
        lat:
          type: number
          description: Latitude coordinate.
        lon:
          type: number
          description: Longitude coordinate.
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: JWT issued by the Salesive Store API for authenticated shoppers.
    ShopIdHeader:
      type: apiKey
      in: header
      name: x-shop-id
      description: >-
        Optional storefront identifier sent as a header to scope responses to a
        specific shop. Try It requests remember this value once provided.

````