Narval | Docs
GithubHome
  • Narval Connect
    • Overview
    • Getting Started
  • Security Overview
  • Providers
    • Providers
      • Anchorage
      • BitGo
      • Fireblocks
  • Guide
    • ConnectClient
    • Connect Widget
      • initiateConnect
      • completeConnect
    • Using a Connection
      • listWallets
      • getWalletById
      • listAccounts
      • getAccountById
      • listAddresses
      • getAddressById
      • listKnownDestinations
      • sendTransfer
      • getTransfer
      • EVM Transactions
        • sendTransaction
        • getTransactionById
        • signMessage
        • getSignMessageById
        • signTypedData
        • getTypedDataById
      • Staking
        • Ethereum (ETH)
        • Polygon (POL)
        • Solana (SOL)
        • Sui (SUI)
      • Raw Signing
        • signRaw
        • getRawSignRequest
    • Manage Connections
      • listConnections
      • getConnection
      • revokeConnection
  • API Reference
    • REST API
      • Authorization
      • Connect Widget
      • Networks & Assets
      • Wallets, Accounts, Addresses
      • Known Destinations
      • Transfer
      • Stake
        • Ethereum
        • Polygon
        • Solana
        • Sui
      • Transactions
        • Ethereum (EVM)
      • Raw Signing
      • Transit Encryption Key
      • Manage Connections
Powered by GitBook
On this page
  1. API Reference
  2. REST API

Wallets, Accounts, Addresses

PreviousNetworks & AssetsNextKnown Destinations

Last updated 1 month ago

List wallets

get

Returns a list of wallets for the connection.

Authorizations
Query parameters
cursorstringOptional

Cursor for pagination. Use the next cursor from previous response to get next page

limitnumberOptional

Number of records to return per page

orderBystringOptional

Field to order results by

descstringOptional

Set to "true" or "1" for descending order

Header parameters
x-client-idstringRequired
x-connection-idstringOptional

The provider connection through which the resource is accessed

AuthorizationstringOptional
Responses
200
Returns a paginated list of wallets for the client
application/json
400
Invalid request parameters
application/json
401
Authentication is required
application/json
403
Insufficient permissions
application/json
404
Resource not found
application/json
409
Resource conflict
application/json
422
Unable to process the contained instructions
application/json
500
Internal server error
application/json
502
Bad gateway
application/json
get
GET /v1/provider/wallets HTTP/1.1
Host: auth.armory.playnarval.com
detached-jws: YOUR_API_KEY
x-client-id: text
Accept: */*
{
  "data": [
    {
      "accounts": [
        {
          "accountId": "text",
          "addresses": [
            {
              "accountId": "text",
              "address": "text",
              "addressId": "text",
              "clientId": "text",
              "connectionId": "text",
              "createdAt": null,
              "externalId": "text",
              "provider": "anchorage",
              "updatedAt": null
            }
          ],
          "clientId": "text",
          "connectionId": "text",
          "createdAt": null,
          "externalId": "text",
          "label": "text",
          "networkId": "text",
          "provider": "anchorage",
          "updatedAt": null,
          "walletId": "text"
        }
      ],
      "clientId": "text",
      "connectionId": "text",
      "createdAt": null,
      "externalId": "text",
      "label": "text",
      "provider": "anchorage",
      "updatedAt": null,
      "walletId": "text"
    }
  ],
  "page": {
    "next": "text"
  }
}

Get wallet by ID

get

Returns a specific wallet by ID.

Authorizations
Path parameters
walletIdstringRequired

The ID of the wallet to retrieve

Header parameters
x-client-idstringRequired
x-connection-idstringOptional

The provider connection through which the resource is accessed

AuthorizationstringOptional
Responses
200Success
application/json
400
Invalid request parameters
application/json
401
Authentication is required
application/json
403
Insufficient permissions
application/json
404
Wallet not found
409
Resource conflict
application/json
422
Unable to process the contained instructions
application/json
500
Internal server error
application/json
502
Bad gateway
application/json
get
GET /v1/provider/wallets/{walletId} HTTP/1.1
Host: auth.armory.playnarval.com
detached-jws: YOUR_API_KEY
x-client-id: text
Accept: */*
{
  "data": {
    "accounts": [
      {
        "accountId": "text",
        "addresses": [
          {
            "accountId": "text",
            "address": "text",
            "addressId": "text",
            "clientId": "text",
            "connectionId": "text",
            "createdAt": null,
            "externalId": "text",
            "provider": "anchorage",
            "updatedAt": null
          }
        ],
        "clientId": "text",
        "connectionId": "text",
        "createdAt": null,
        "externalId": "text",
        "label": "text",
        "networkId": "text",
        "provider": "anchorage",
        "updatedAt": null,
        "walletId": "text"
      }
    ],
    "clientId": "text",
    "connectionId": "text",
    "createdAt": null,
    "externalId": "text",
    "label": "text",
    "provider": "anchorage",
    "updatedAt": null,
    "walletId": "text"
  }
}

List accounts

get

Returns a list of accounts for the connection.

Authorizations
Query parameters
cursorstringOptional

Cursor for pagination. Use the next cursor from previous response to get next page

limitnumberOptional

Number of records to return per page

orderBystringOptional

Field to order results by

descstringOptional

Set to "true" or "1" for descending order

Header parameters
x-client-idstringRequired
x-connection-idstringOptional

The provider connection through which the resource is accessed

AuthorizationstringOptional
Responses
200
Returns a paginated list of accounts of the connection.
application/json
400
Invalid request parameters
application/json
401
Authentication is required
application/json
403
Insufficient permissions
application/json
404
Resource not found
application/json
409
Resource conflict
application/json
422
Unable to process the contained instructions
application/json
500
Internal server error
application/json
502
Bad gateway
application/json
get
GET /v1/provider/accounts HTTP/1.1
Host: auth.armory.playnarval.com
detached-jws: YOUR_API_KEY
x-client-id: text
Accept: */*
{
  "data": [
    {
      "accountId": "text",
      "addresses": [
        {
          "accountId": "text",
          "address": "text",
          "addressId": "text",
          "clientId": "text",
          "connectionId": "text",
          "createdAt": null,
          "externalId": "text",
          "provider": "anchorage",
          "updatedAt": null
        }
      ],
      "clientId": "text",
      "connectionId": "text",
      "createdAt": null,
      "externalId": "text",
      "label": "text",
      "networkId": "text",
      "provider": "anchorage",
      "updatedAt": null,
      "walletId": "text"
    }
  ],
  "page": {
    "next": "text"
  }
}

Get account by ID

get

Returns a specific account by ID.

Authorizations
Path parameters
accountIdstringRequired

The ID of the account to retrieve

Header parameters
x-client-idstringRequired
x-connection-idstringOptional

The provider connection through which the resource is accessed

AuthorizationstringOptional
Responses
200Success
application/json
400
Invalid request parameters
application/json
401
Authentication is required
application/json
403
Insufficient permissions
application/json
404
Account not found
409
Resource conflict
application/json
422
Unable to process the contained instructions
application/json
500
Internal server error
application/json
502
Bad gateway
application/json
get
GET /v1/provider/accounts/{accountId} HTTP/1.1
Host: auth.armory.playnarval.com
detached-jws: YOUR_API_KEY
x-client-id: text
Accept: */*
{
  "data": {
    "accountId": "text",
    "addresses": [
      {
        "accountId": "text",
        "address": "text",
        "addressId": "text",
        "clientId": "text",
        "connectionId": "text",
        "createdAt": null,
        "externalId": "text",
        "provider": "anchorage",
        "updatedAt": null
      }
    ],
    "clientId": "text",
    "connectionId": "text",
    "createdAt": null,
    "externalId": "text",
    "label": "text",
    "networkId": "text",
    "provider": "anchorage",
    "updatedAt": null,
    "walletId": "text"
  }
}

List addresses

get

Returns a list of addresses for the connection.

Authorizations
Query parameters
cursorstringOptional

Cursor for pagination. Use the next cursor from previous response to get next page

limitnumberOptional

Number of records to return per page

orderBystringOptional

Field to order results by

descstringOptional

Set to "true" or "1" for descending order

Header parameters
x-client-idstringRequired
x-connection-idstringOptional

The provider connection through which the resource is accessed

AuthorizationstringOptional
Responses
200
Returns a paginated list of addresss for the client.
application/json
400
Invalid request parameters
application/json
401
Authentication is required
application/json
403
Insufficient permissions
application/json
404
Resource not found
application/json
409
Resource conflict
application/json
422
Unable to process the contained instructions
application/json
500
Internal server error
application/json
502
Bad gateway
application/json
get
GET /v1/provider/addresses HTTP/1.1
Host: auth.armory.playnarval.com
detached-jws: YOUR_API_KEY
x-client-id: text
Accept: */*
{
  "data": [
    {
      "accountId": "text",
      "address": "text",
      "addressId": "text",
      "clientId": "text",
      "connectionId": "text",
      "createdAt": null,
      "externalId": "text",
      "provider": "anchorage",
      "updatedAt": null
    }
  ],
  "page": {
    "next": "text"
  }
}

Get address by ID

get

Returns a specific address by ID.

Authorizations
Path parameters
addressIdstringRequired

The ID of the address to retrieve

Header parameters
x-client-idstringRequired
x-connection-idstringOptional

The provider connection through which the resource is accessed

AuthorizationstringOptional
Responses
200Success
application/json
400
Invalid request parameters
application/json
401
Authentication is required
application/json
403
Insufficient permissions
application/json
404
Address not found
409
Resource conflict
application/json
422
Unable to process the contained instructions
application/json
500
Internal server error
application/json
502
Bad gateway
application/json
get
GET /v1/provider/addresses/{addressId} HTTP/1.1
Host: auth.armory.playnarval.com
detached-jws: YOUR_API_KEY
x-client-id: text
Accept: */*
{
  "data": [
    {
      "accountId": "text",
      "address": "text",
      "addressId": "text",
      "clientId": "text",
      "connectionId": "text",
      "createdAt": null,
      "externalId": "text",
      "provider": "anchorage",
      "updatedAt": null
    }
  ],
  "page": {
    "next": "text"
  }
}
  • GETList wallets
  • GETGet wallet by ID
  • GETList accounts
  • GETGet account by ID
  • GETList addresses
  • GETGet address by ID