Skip to main content
The ArcPass REST API is a public HTTP API that exposes gas sponsorship infrastructure for Arc Network. All endpoints accept and return JSON. No API key or authentication token is required — ArcPass is open infrastructure designed for ecosystem-wide use.

​
Base URL

https://api.arcpass.io
All paths below are relative to this base URL. The exact hostname depends on your deployment environment; the value above is the canonical production address.

​
Request format

Every request that includes a body must set the Content-Type header: 
Content-Type: application/json
Path and query parameters are URL-encoded as usual. There is no envelope or wrapper — send the payload fields directly at the top level of the JSON body.

​
Response format

Successful responses return JSON with HTTP status codes in the 2xx range. The response body contains the resource directly at the top level — there is no data wrapper. 
{
  "id": "3f2a1c8e-9b4d-4e7f-a1d2-0c6f8e3b5a9d",
  "walletAddress": "0xAbC1234567890dEF1234567890aBcDeF12345678",
  "sponsorshipCount": 1,
  "isBlocked": false
}

​
Correlation IDs

Every response includes an X-Correlation-Id header. Record this value when filing bug reports or tracing issues — it identifies the exact request in server-side logs.

​
Error format

Errors return a JSON body with two fields: 
{
  "error": "Wallet not found",
  "statusCode": 404
}
Standard HTTP status codes apply:
CodeMeaning
400Bad request — malformed input or invalid field value
404Resource not found
409Conflict — duplicate or already-existing resource
422Unprocessable — wallet is blocked or ineligible
429Rate limit exceeded
500Internal server error

​
Rate limiting

ArcPass enforces rate limits per IP address and per wallet address. When a limit is exceeded, the API returns 429 Too Many Requests. See Rate Limits for configured thresholds and reset windows.

​
Available endpoints

​
Wallets

MethodPathDescription
POST/wallets/registerRegister a wallet address
GET/wallets/:addressLook up a wallet by address
GET/wallets/:address/historyPaginated sponsorship history for a wallet

​
Sponsorship

MethodPathDescription
POST/sponsorship/requestSubmit a wallet for gas sponsorship
GET/sponsorship/:idGet a sponsorship request by UUID
GET/sponsorship/tx/:hashLook up a sponsorship request by on-chain tx hash

​
Relay

MethodPathDescription
GET/relay/:idRetrieve relay transaction details by UUID

​
Health

MethodPathDescription
GET/healthAPI health check and uptime