Address Book

Manage the addresses saved to your API key — the same list you see in Octav Pro. Entries are keyed by address.

Cost: 1 credit per call

Interactive Playground: Test these endpoints in the API Playground. Get your API key at data.octav.fi

The entry object

string

Wallet address.

string

Your name for the address.

string

FREE, LITE, or PRO.

string | null

When the plan lapses. null on FREE.

boolean

Whether the plan is currently active.

{
  "address": "0xe760ad8df0a54aafd95e3bc271b65d224abeaa57",
  "label": "Treasury",
  "plan": "PRO",
  "expiresAt": "2026-11-01T00:00:00.000Z",
  "isPaid": true
}

List Entries

Endpoint

GET https://api.octav.fi/v1/addressbook

Example

curl "https://api.octav.fi/v1/addressbook" \
  -H "Authorization: Bearer YOUR_API_KEY"

const response = await fetch('https://api.octav.fi/v1/addressbook', {
  headers: { 'Authorization': `Bearer ${apiKey}` }
});

const { data } = await response.json();

Example Response

{
  "data": [
    {
      "address": "0xe760ad8df0a54aafd95e3bc271b65d224abeaa57",
      "label": "Treasury",
      "plan": "PRO",
      "expiresAt": "2026-11-01T00:00:00.000Z",
      "isPaid": true
    },
    {
      "address": "EPa1MBU21RjhoyZTEDcDj4yLVemtzxpVy35rVpgTcoV3",
      "label": "",
      "plan": "FREE",
      "expiresAt": null,
      "isPaid": false
    }
  ]
}

Add Entries

Endpoint

POST https://api.octav.fi/v1/addressbook

Parameters

array

required

1–100 entries per request. Up to 50 addresses without a paid plan — contact us to raise it.

string

required

Wallet address. Must be unique within the request.

string

Up to 255 characters.

Example

curl -X POST "https://api.octav.fi/v1/addressbook" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "entries": [
      { "address": "0xe760ad8df0a54aafd95e3bc271b65d224abeaa57", "label": "Treasury" }
    ]
  }'

const response = await fetch('https://api.octav.fi/v1/addressbook', {
  method: 'POST',
  headers: {
    'Authorization': `Bearer ${apiKey}`,
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    entries: [{ address: '0xe760ad8df0a54aafd95e3bc271b65d224abeaa57', label: 'Treasury' }]
  })
});

const { data } = await response.json();

Response

Returns the full address book.

Rename Entry

Endpoint

PATCH https://api.octav.fi/v1/addressbook/{address}

Parameters

string

required

Wallet address.

string

required

Up to 255 characters. "" clears it.

Example

curl -X PATCH "https://api.octav.fi/v1/addressbook/0xe760ad8df0a54aafd95e3bc271b65d224abeaa57" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{ "label": "Cold Wallet" }'

const response = await fetch(
  `https://api.octav.fi/v1/addressbook/${address}`,
  {
    method: 'PATCH',
    headers: {
      'Authorization': `Bearer ${apiKey}`,
      'Content-Type': 'application/json'
    },
    body: JSON.stringify({ label: 'Cold Wallet' })
  }
);

const { data } = await response.json();

Example Response

{
  "data": {
    "address": "0xe760ad8df0a54aafd95e3bc271b65d224abeaa57",
    "label": "Cold Wallet",
    "plan": "PRO",
    "expiresAt": "2026-11-01T00:00:00.000Z",
    "isPaid": true
  }
}

Remove Entry

Endpoint

DELETE https://api.octav.fi/v1/addressbook/{address}

Parameters

string

required

Wallet address.

Example

curl -X DELETE "https://api.octav.fi/v1/addressbook/0xe760ad8df0a54aafd95e3bc271b65d224abeaa57" \
  -H "Authorization: Bearer YOUR_API_KEY"

await fetch(`https://api.octav.fi/v1/addressbook/${address}`, {
  method: 'DELETE',
  headers: { 'Authorization': `Bearer ${apiKey}` }
});

Response

204 with no body. Entries on a paid plan, or authorized by the wallet owner, return 409 — remove those in Octav Pro.

Address Matching

EVM addresses match case-insensitively. Solana, Tron, and Starknet addresses are case-sensitive.

Error Responses

Code	Status	Meaning
`VALIDATION_ERROR`	400	Invalid or duplicate address
`ADDRESSBOOK_ENTRY_NOT_FOUND`	404	Address is not in your book
`ADDRESSBOOK_ENTRY_NOT_DELETABLE`	409	Entry is on a paid plan or authorized by the wallet owner
`ADDRESSBOOK_QUOTA_REACHED`	422	Address limit reached
`INTERNAL_ERROR`	500	Unexpected failure

{
  "error": {
    "code": "ADDRESSBOOK_QUOTA_REACHED",
    "message": "Address book quota reached",
    "quota": 50,
    "current": 50
  }
}

Rate limit: 360 requests/min.

Bundles

Group saved addresses together

Portfolio

Holdings for an address

Getting Started

Endpoints

Playground

AI Development

Migrate to Octav

Reference

The entry object

List Entries

Endpoint

Example

Example Response

Add Entries

Endpoint

Parameters

Example

Response

Rename Entry

Endpoint

Parameters

Example

Example Response

Remove Entry

Endpoint

Parameters

Example

Response

Address Matching

Error Responses

Bundles

Portfolio

​The entry object

​List Entries

​Endpoint

​Example

​Example Response

​Add Entries

​Endpoint

​Parameters

​Example

​Response

​Rename Entry

​Endpoint

​Parameters

​Example

​Example Response

​Remove Entry

​Endpoint

​Parameters

​Example

​Response

​Address Matching

​Error Responses

​Related Endpoints

Bundles

Portfolio

The entry object

List Entries

Endpoint

Example

Example Response

Add Entries

Endpoint

Parameters

Example

Response

Rename Entry

Endpoint

Parameters

Example

Example Response

Remove Entry

Endpoint

Parameters

Example

Response

Address Matching

Error Responses

Related Endpoints