DocsGetting StartedQuickstart Guide

Quickstart Guide

Start validating and geocoding addresses in under 5 minutes.

Updated: July 20261 min read

Step 1: Obtain API Credentials

AddressValid supports two key types:

sk_live_...: Live production key querying real PostGIS spatial databases and OpenSearch clusters.
sk_test_...: Sandbox key targeting fast, isolated memory stubs (zero credit consumption).

Step 2: Make Your First Request

Execute a search query against the Address Autocomplete API using cURL, Node.js, or Python:

1
2
curl -X GET "https://api.addressvalid.io/v1/address/autocomplete?query=14+Admiralty&country=NG" \
  -H "Authorization: Bearer sk_live_your_api_key_here"

Step 3: Inspect the Spatial Response

All API responses return structured JSON with confidence scores, coordinate objects, and landmark references:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
{
  "status": "success",
  "data": [
    {
      "id": "addr_lekki_14",
      "formatted": "14 Admiralty Way, Lekki Phase 1, Lagos, Nigeria",
      "street": "Admiralty Way",
      "house_number": "14",
      "neighborhood": "Lekki Phase 1",
      "city": "Lagos",
      "state": "Lagos State",
      "country": "NG",
      "confidence": 0.98,
      "coordinates": {
        "lat": 6.4474,
        "lng": 3.4723
      },
      "landmark_proximity": "Opposite Domino's Pizza"
    }
  ]
}

Was this documentation page helpful?

Your feedback helps us continuously improve our developer docs.

PreviousPlatform Overview NextAuthentication & API Keys