country.lookup

Look up country metadata via REST Countries. Pass alpha2 (2-letter ISO 3166-1), alpha3 (3-letter), or name (with optional fullText=true for exact match). Returns common + official name, ISO codes, region + subregion, independence + UN-member flags, capital(s), population, area km², landlocked flag, neighboring borders (alpha-3), timezones, currencies (code → name + symbol), languages, calling code, flag emoji + SVG/PNG URLs, lat/lng coordinates, Google Maps + OSM URLs, driving side, top-level domains.

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

Overview

The lookup API is a pay-per-call country endpoint built for AI agents and autonomous software. Look up country metadata via REST Countries.

There is no signup and no API key. An agent (or any HTTP client) hits the endpoint, receives an x402 "402 Payment Required" challenge, signs a sub-cent USDC payment on Base or Solana, and retries — the data comes back on the paid request. That makes it a drop-in lookup data source for an agent tool-use loop, an MCP host, or a backend that needs country data on demand without onboarding to yet another vendor portal.

Use cases

Parameters

NameTypeDescription
alpha2string
min 2 chars · max 2 chars · match ^[A-Za-z]{2}$
alpha3string
min 3 chars · max 3 chars · match ^[A-Za-z]{3}$
namestring
min 2 chars · max 80 chars
fullTextboolean

Code samples

cURLbash
# 1. Probe with no auth → 402 envelope with PaymentRequirements
curl -sS 'https://2s.io/api/country/lookup?alpha2=xx&alpha3=xxx&name=xx&fullText=false'

# 2. Sign + retry with PAYMENT-SIGNATURE:
curl -sS 'https://2s.io/api/country/lookup?alpha2=xx&alpha3=xxx&name=xx&fullText=false' \
  -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/country/lookup?alpha2=xx&alpha3=xxx&name=xx&fullText=false'
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.country.lookup({
  "alpha2": "xx",
  "alpha3": "xxx",
  "name": "xx",
  "fullText": false
})

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.country.lookup(alpha2="xx", alpha3="xxx", name="xx", fullText=False)

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": "country.lookup",
    "arguments": {
      "alpha2": "xx",
      "alpha3": "xxx",
      "name": "xx",
      "fullText": false
    }
  }
}

Response

FieldTypeDescription
okboolean
one of: true
itemsarray
totalintegerTotal matching rows upstream; null when unknown.
sourceobject
metaobject
Example response datajson
{
  "ok": true,
  "items": [
    {
      "name": {
        "common": "example",
        "official": "example"
      },
      "alpha2": "example",
      "alpha3": "example",
      "numericCode": "example",
      "cioc": "example",
      "region": "example",
      "subregion": "example",
      "independent": false,
      "unMember": false,
      "capital": [
        "example"
      ],
      "population": 1,
      "areaKm2": 1,
      "landlocked": false,
      "borders": [
        "example"
      ],
      "timezones": [
        "example"
      ],
      "currencies": {},
      "languages": {},
      "callingCode": "example",
      "flag": "example",
      "flagSvg": "example",
      "flagPng": "example",
      "coordinates": {
        "lat": 1,
        "lng": 1
      },
      "googleMapsUrl": "example",
      "openStreetMapsUrl": "example",
      "drivingSide": "example",
      "tld": [
        "example"
      ]
    }
  ],
  "total": 1,
  "source": {
    "provider": "example",
    "url": "example",
    "license": "example"
  },
  "meta": {
    "query": {
      "alpha2": "example",
      "alpha3": "example",
      "name": "example",
      "fullText": false
    }
  }
}

FAQ

Do I need an API key to use the lookup API?
No. country.lookup 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 lookup API cost?
$0.0012 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 lookup 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 country.lookup 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: lookup api · country lookup api · lookup api for ai agents · x402 country api · lookup api no api key · pay per call lookup api · country api