OpsionDocs
ConsoleWebsiteSign in

API Reference — Overview

The Opsion REST API gives you programmatic access to your wallets, transactions, and alert rules. API access is available on the Enterprise and Custom plans.

Base URL

text
https://api.opsion.xyz/api

All endpoints are relative to this base URL.

Authentication

Pass your API key as a Bearer token in every request. Keys start with opsk_ and are generated from Settings → API Keys in the console.

bash
curl https://api.opsion.xyz/api/wallets \
  -H "Authorization: Bearer opsk_your_key_here"

See the Authentication page for full details on key generation and rotation.

Response format

All responses are JSON. Single-resource responses nest the resource under data:

json
{
  "data": {
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "address": "0xd8dA6BF26964aF9D7eEd9e03E53415D37aA96045",
    "label": "Vitalik",
    "chain": "ethereum"
  }
}

List endpoints return a data array with a meta block:

json
{
  "data": [ /* ... */ ],
  "meta": {
    "total": 42,
    "page": 1,
    "pageSize": 25
  }
}

Errors

StatusMeaning
400Bad Request — invalid or missing parameters
401Unauthorized — missing or invalid API key
403Forbidden — feature not available on your plan
404Not Found
409Conflict — resource already exists
429Too Many Requests — you have been rate limited
500Internal Server Error

Endpoints

ResourceBase path
Wallets/api/wallets
Transactions/api/transactions
Alert Rules/api/alerts/rules
Alert Events/api/alerts/events
Screening/api/screening/wallets
API Keys/api/api-keys
EmailAuthentication