geocode.address

Forward geocoding — free-text address or place name → latitude/longitude plus structured address components (houseNumber, road, suburb, city, county, state, postcode, country, countryCode). Query: q (2-500 chars), limit (1-10, default 5), country (optional 2-letter ISO 3166-1 bias). Underlying data is OpenStreetMap (ODbL). Sister: /api/geocode/reverse.

price
$0.0010 USDC per call
method
GET/api/geocode/address
payment
x402 v2 · USDC on Base (EIP-3009) or Solana (SPL transfer)
auth
None. Sign the payment, retry with PAYMENT-SIGNATURE.

Overview

The geocoding API converts a free-text address or place name into latitude/longitude plus structured address components, backed by OpenStreetMap data.

Pass q (the address or place), an optional result limit, and an optional 2-letter country bias. Each match returns coordinates and a parsed address (house number, road, suburb, city, county, state, postcode, country, country code). It pairs with the reverse geocoding endpoint for coordinate → address. No API key — pay per call with x402.

Use cases

Parameters

NameTypeDescription
qrequiredstring
min 2 chars · max 500 chars
limitinteger
min 1 · max 10
countrystring
match ^[a-z]{2}$

Code samples

cURLbash
# 1. Probe with no auth → 402 envelope with PaymentRequirements
curl -sS 'https://2s.io/api/geocode/address?q=xx&limit=5&country=example'

# 2. Sign + retry with PAYMENT-SIGNATURE:
curl -sS 'https://2s.io/api/geocode/address?q=xx&limit=5&country=example' \
  -H 'PAYMENT-SIGNATURE: <base64-json-payload>'

# Or use the canonical runner (handles probe → sign → retry):
#   EVM_PRIVATE_KEY=0x... node --env-file=.env.local \
#     --experimental-strip-types scripts/x402-pay.ts \
#     'https://2s.io/api/geocode/address?q=xx&limit=5&country=example'
TypeScript / Node — @2sio/sdktypescript
import { TwoS } from '@2sio/sdk'

const client = new TwoS({
  privateKey: process.env.EVM_PRIVATE_KEY as `0x${string}`,
})

const result = await client.geocode.address({
  "q": "xx",
  "limit": 5,
  "country": "example"
})

console.log('endpoint:', result.endpoint)
console.log('cost:', result.costUsd, 'USDC')
console.log('tx:', result.settlement?.txHash)
console.log('data:', result.data)
Python — 2siopython
import os
from twosio import TwoS

client = TwoS(private_key=os.environ["EVM_PRIVATE_KEY"])

result = client.geocode.address(q="xx", limit=5, country="example")

print("endpoint:", result.endpoint)
print("cost:", result.cost_usd, "USDC")
print("tx:", (result.settlement or {}).get("tx_hash"))
print("data:", result.data)
MCP — Claude Desktop / AgentKit / any MCP hostjson
// 1. Add @2sio/mcp to your MCP host config (Claude Desktop example below).
//    EVM_PRIVATE_KEY funds x402 payments per call.

// claude_desktop_config.json
{
  "mcpServers": {
    "2sio": {
      "command": "npx",
      "args": ["-y", "@2sio/mcp"],
      "env": { "EVM_PRIVATE_KEY": "0x..." }
    }
  }
}

// 2. Once the server is running, agents call this tool via standard MCP:

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "geocode.address",
    "arguments": {
      "q": "xx",
      "limit": 5,
      "country": "example"
    }
  }
}
LangChain agent — langchain-twosiopython
# pip install langchain-twosio langchain-anthropic
import os
from langchain_twosio import get_twosio_tools
from langchain_anthropic import ChatAnthropic
from langgraph.prebuilt import create_react_agent

tools = get_twosio_tools(private_key=os.environ["EVM_PRIVATE_KEY"])
llm = ChatAnthropic(model="claude-haiku-4-5", temperature=0)
agent = create_react_agent(llm, tools)

# The agent will pick "twosio_geocode_address" when the prompt matches.
result = agent.invoke({
    "messages": [("user", "...prompt that requires geocode.address...")]
})
print(result["messages"][-1].content)
LlamaIndex agent — llama-index-tools-twosiopython
# pip install llama-index-tools-twosio llama-index-llms-anthropic
import asyncio, os
from llama_index_tools_twosio import get_twosio_tools
from llama_index.llms.anthropic import Anthropic
from llama_index.core.agent.workflow import FunctionAgent

tools = get_twosio_tools(private_key=os.environ["EVM_PRIVATE_KEY"])
llm = Anthropic(model="claude-haiku-4-5")
agent = FunctionAgent(tools=tools, llm=llm)

# The agent will pick "twosio_geocode_address" when the prompt matches.
response = asyncio.run(agent.run("...prompt that requires geocode.address..."))
print(response)

Response

FieldTypeDescription
okboolean
one of: true
itemsarray
totalintegerTotal matching rows upstream; null when unknown.
sourceobject
metaobject
Example response datajson
{
  "ok": true,
  "items": [
    {}
  ],
  "total": 1,
  "source": {
    "provider": "example",
    "url": "example",
    "license": "example"
  },
  "meta": {
    "query": {
      "kind": "example",
      "input": "example"
    },
    "cacheHit": false
  }
}

FAQ

What data backs the geocoding API?
OpenStreetMap (licensed ODbL). The endpoint returns OSM matches with structured address components.
Is there a reverse geocoding endpoint?
Yes — use geocode.reverse to turn a latitude/longitude back into an address.
Do I need an API key to use the address API?
No. geocode.address is x402-native — there is no signup and no API key. Your client makes the call, receives a 402 with payment requirements, signs a USDC payment, and retries. Funds come from a wallet you control.
How much does the address API cost?
$0.0010 USDC per call, charged per request. There are no monthly fees, seats, or minimums — you pay only for the calls you make.
Can I try the address API for free first?
Yes. Add ?trial=1 (or the header X-2s-Trial: 1) to get a free real call per endpoint per hour, so you can verify the response shape before wiring payment.
Which networks and tokens are supported?
USDC on Base (via EIP-3009 transferWithAuthorization) or Solana (SPL transfer), using the open x402 payment protocol.
How do I call geocode.address from an AI agent or MCP host?
Use @2sio/sdk (TypeScript), 2sio (Python), or the @2sio/mcp server for any MCP host — each handles the probe → sign → retry loop for you. See the code samples on this page.

Discovery

Related: geocoding api · forward geocoding api · address to lat long api · geocode api · address api · geocoding api for ai agents · x402 geocoding api · geocode address api · address api for ai agents · x402 geocode api · address api no api key · pay per call address api