trade.locode
Look up or search UN/LOCODE — the United Nations Code for Trade and Transport Locations (~116k locations, all countries). Pass `locode` for an exact code (e.g. USNYC or 'US NYC'). Or pass `query` to search location names, optionally filtered by `country` (ISO 3166 alpha-2) and `function` (port, rail, road, airport, postal, multimodal, fixed, border). Each result: locode, name, country, subdivision, transport functions, entry status, IATA code where it differs, and coordinates. UN/LOCODE is the standard location identifier in shipping schedules, EDI messages, and customs documents.
price
$0.0010 USDC per call
method
GET
/api/trade/locodepayment
x402 v2 · USDC on Base (EIP-3009) or Solana (SPL transfer)
auth
None. Sign the payment, retry with
PAYMENT-SIGNATURE.tier
Tier 0 — no paid upstream
Parameters
| Name | Type | Description |
|---|---|---|
locode | string | Exact UN/LOCODE to look up (e.g. USNYC or 'US NYC'). Pass this OR query. match ^[A-Za-z]{2}[\s-]?[A-Za-z0-9]{3}$ |
query | string | Location name to search (e.g. Rotterdam). Pass this OR locode. min 2 chars · max 120 chars |
country | string | Restrict query-mode results to one country (ISO 3166 alpha-2, e.g. NL). match ^[A-Za-z]{2}$ |
function | string | Restrict query-mode results to locations with this transport function. one of: port | rail | road | airport | postal | multimodal | fixed | border |
limit | integer | Max query-mode results, 1–50 (default 10). min 1 · max 50 |
Code samples
cURLbash
# 1. Probe with no auth → 402 envelope with PaymentRequirements curl -sS 'https://2s.io/api/trade/locode?locode=example&query=xx&country=example&function=port&limit=1' # 2. Sign + retry with PAYMENT-SIGNATURE: curl -sS 'https://2s.io/api/trade/locode?locode=example&query=xx&country=example&function=port&limit=1' \ -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/trade/locode?locode=example&query=xx&country=example&function=port&limit=1'
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.trade.locode({
"locode": "example",
"query": "xx",
"country": "example",
"function": "port",
"limit": 1
})
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.trade.locode(locode="example", query="xx", country="example", function="port", limit=1)
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": "trade.locode",
"arguments": {
"locode": "example",
"query": "xx",
"country": "example",
"function": "port",
"limit": 1
}
}
}Response
| Field | Type | Description |
|---|---|---|
ok | boolean | one of: true |
items | array | |
total | integer | Total matching rows upstream; null when unknown. |
source | object | |
page | object |
Example response datajson
{
"ok": true,
"items": [
{
"locode": "example",
"country": "example",
"location": "example",
"name": "example",
"nameAscii": "example",
"subdivision": {
"code": "example",
"name": "example"
},
"functions": {
"raw": "example",
"list": [
"example"
]
},
"status": {
"code": "example",
"meaning": "example"
},
"iata": "example",
"coordinates": {
"lat": 1,
"lon": 1
},
"updated": "example"
}
],
"total": 1,
"source": {
"provider": "example",
"url": "example",
"license": "example"
},
"page": {
"number": 1,
"size": 1,
"pages": 1
}
}Discovery
- /api/directory — full catalog of every endpoint
- /openapi.json — OpenAPI 3.1 spec (per-op x-payment-info, x402Payment security)
- /.well-known/x402 — machine-readable service descriptor for x402-aware crawlers
- /.well-known/mcp/server-card.json — MCP SEP-1649 server card
- /llms.txt — plain-text manifest for LLM ingestion
2s.io is x402-native. Every call is paid per-request from a USDC-funded EVM wallet on Base — no signup, no API keys, no monthly fees. Source code: github.com/2s-io/sdk.