Skip to content

Addresses API

Address book endpoints manage reusable workspace/account addresses.

GET /api/v1/addressbook

Returns the address book.

Arguments: none.

Payload: none.

Response: AddressEntry[].

POST /api/v1/addressbook

Creates an address book entry.

Arguments: none.

Payload:

FieldRequiredDescription
typeYesplain, ss58, evm, bitcoin, or cosmos.
addressYesAddress value.
aliasYesHuman-readable alias.

Response: AddressEntry.

POST /api/v1/addressbook/:id

Updates an address book entry.

Arguments:

ArgumentLocationDescription
idPathAddress entry id.

Payload:

FieldRequiredDescription
typeYesAddress type.
addressYesAddress value.
aliasYesHuman-readable alias.

Response: AddressEntry.

DELETE /api/v1/addressbook/:id

Deletes an address book entry.

Arguments:

ArgumentLocationDescription
idPathAddress entry id.

Payload: none.

Response: OperationResult.