maritime.port
Look up world ports and terminals in the NGA World Port Index (Pub 150, ~2,950 ports) by port name (partial match) and/or country (full country name, e.g. "Japan"). Returns matching ports with location (lat/lon, country, region), UN/LOCODE, harbor size/type and shelter, max vessel length/draft (meters), channel/anchorage/cargo-pier depths, tidal range, and chart number. Keyless, public-domain (NGA). Physical-port reference data an LLM cannot reliably recall; complements maritime.vessel (USCG vessel registry) and maritime.cases (port-state-control inspections).
price
$0.0010 USDC per call
method
GET
/api/maritime/portpayment
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 |
|---|---|---|
portName | string | min 1 chars · max 100 chars |
country | string | min 1 chars · max 60 chars |
limit | integer | min 1 · max 50 |
Code samples
cURLbash
# 1. Probe with no auth → 402 envelope with PaymentRequirements curl -sS 'https://2s.io/api/maritime/port?portName=example&country=example&limit=1' # 2. Sign + retry with PAYMENT-SIGNATURE: curl -sS 'https://2s.io/api/maritime/port?portName=example&country=example&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/maritime/port?portName=example&country=example&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.maritime.port({
"portName": "example",
"country": "example",
"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.maritime.port(portName="example", country="example", 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": "maritime.port",
"arguments": {
"portName": "example",
"country": "example",
"limit": 1
}
}
}Response
| Field | Type | Description |
|---|---|---|
ok | boolean | one of: true |
items | array | |
total | integer | Total matching rows upstream; null when unknown. |
source | object |
Example response datajson
{
"ok": true,
"items": [
{
"portNumber": "example",
"portName": "example",
"countryCode": "example",
"countryName": "example",
"regionName": "example",
"latitude": 1,
"longitude": 1,
"harborSize": "example",
"harborType": "example",
"shelter": "example",
"maxVesselLengthM": 1,
"maxVesselDraftM": 1,
"channelDepthM": 1,
"anchorageDepthM": 1,
"cargoPierDepthM": 1,
"tidalRangeM": 1,
"unLocode": "example",
"chartNumber": "example"
}
],
"total": 1,
"source": {
"provider": "example",
"url": "example",
"license": "example"
}
}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.