Accounts - Coinbase Developer Documentation

Table of Endpoints

Name	Method	Endpoint	Scope
Get Current User	GET	`/v2/user`	`wallet:user:read`, `identity:user:email`
Get Personal Details	GET	`/v2/user/personal-details`	`identity:user:name:read`, `identity:user:address:read`
List Accounts	GET	`/v2/accounts`	`wallet:accounts:read`
Show Account	GET	`/v2/accounts/:account_id`	`wallet:accounts:read`

Overview

The Account resource represents all of a user’s accounts, including cryptocurrency wallets, fiat currency accounts, and vaults. This is represented in the type field. New types may be added in the future, so make sure this won’t break your implementation. User can only have one primary account and its type can only be wallet.

Parameter	Description
`id` string	Resource ID
`name` string	User or system defined name
`primary` boolean	Primary account (or not)
`type` string, enumerable	Account’s type. Valid values: `wallet`, `fiat`, `vault`
`currency` hash	Account’s currency
`balance` money hash	Crypto balance
`available_to_send` money hash	Amount the user can send from this account right now. Returned only when you set `include_available_to_send=true` and the account is eligible. Only USDC accounts are eligible for now.
`created_at` timestamp
`updated_at` timestamp
`resource` string, constant account
`resource_path` string

Account Resource

{
  "id": "2bbf394c-193b-5b2a-9155-3b4732659ede",
  "name": "My Wallet",
  "primary": true,
  "type": "wallet",
  "currency" : {
      "address_regex" : "^([13][a-km-zA-HJ-NP-Z1-9]{25,34})|^(bc1[qzry9x8gf2tvdw0s3jn54khce6mua7l]([qpzry9x8gf2tvdw0s3jn54khce6mua7l]{38}|[qpzry9x8gf2tvdw0s3jn54khce6mua7l]{58}))$",
      "asset_id" : "5b71fc48-3dd3-540c-809b-f8c94d0e68b5",
      "code" : "BTC",
      "color" : "#F7931A",
      "exponent" : 8,
      "name" : "Bitcoin",
      "slug" : "bitcoin",
      "sort_index" : 100,
      "type" : "crypto"
  }
  "balance": {
      "amount": "39.59000000",
      "currency": "BTC"
  },
  "created_at": "2024-01-31T20:49:02Z",
  "updated_at": "2024-01-31T20:49:02Z",
  "resource": "account",
  "resource_path": "/v2/accounts/2bbf394c-193b-5b2a-9155-3b4732659ede"
}

Get Current User

Returns the current user’s public profile information, including display name and email address. Use this endpoint when you need the user’s display name or email — for example, to personalize your app’s UI or pre-fill contact fields.

HTTP Request

GET https://api.coinbase.com/v2/user

Scopes

wallet:user:read — returns public profile fields (name, avatar, timezone, country, etc.)
identity:user:email — additionally returns the email field

Examples

Request

curl https://api.coinbase.com/v2/user \
  -H 'Authorization: Bearer YOUR_ACCESS_TOKEN' \
  -H 'CB-VERSION: 2019-08-15'

Response

{
  "data": {
    "id": "9bd290f2-beed-52e5-84b7-2c36d961a161",
    "name": "First Last",
    "avatar_url": "https://static-assets.coinbase.com/profile/avatar.jpg",
    "resource": "user",
    "resource_path": "/v2/user",
    "time_zone": "Pacific Time (US & Canada)",
    "native_currency": "USD",
    "bitcoin_unit": "BTC",
    "country": {
      "code": "US",
      "name": "United States of America"
    },
    "created_at": "2024-08-22T02:55:49Z",
    "email": "first.last@example.com"
  }
}

Get Personal Details

Returns the current user’s legal name (first name and last name) and KYC-verified primary address. Use this endpoint to fetch verified identity information such as the user’s legal name and registered primary address — for example, for compliance, sanctions screening, or pre-filling forms that require legal identity data.

identity:user:name:read grants access to firstName and lastName only. identity:user:address:read grants access to primaryAddress only. Request both scopes to retrieve all fields.

HTTP Request

GET https://api.coinbase.com/v2/user/personal-details

Scopes

identity:user:name:read — returns the user’s legal first and last name
identity:user:address:read — returns the user’s KYC-verified primary address

Examples

Request

curl https://api.coinbase.com/v2/user/personal-details \
  -H 'Authorization: Bearer YOUR_ACCESS_TOKEN'

Response

{
  "firstName": "First",
  "lastName": "Last",
  "primaryAddress": {
    "line1": "123 Main Street",
    "city": "San Francisco",
    "state": "CA",
    "postalCode": "94105",
    "country": {
      "code": "US",
      "name": "United States of America"
    }
  }
}

List Accounts

List a current user’s accounts to which the authentication method has access to.

HTTP Request

GET https://api.coinbase.com/v2/accounts

Scopes

wallet:accounts:read

Arguments

Parameter	Type	Required	Description
`include_available_to_send`	boolean	Optional	Include `available_to_send` on each eligible account in the page. Defaults to `false`.

available_to_send accounts for holds and the user’s send limits, so it can be lower than balance. It’s never higher than the account’s own available balance. Because send limits apply across the user, don’t add available_to_send values together across accounts.The field is omitted, not set to zero, when it isn’t available for an account. This includes accounts in currencies other than USDC. An actual zero amount is still returned.

Examples

Request

curl 'https://api.coinbase.com/v2/accounts?include_available_to_send=true' \
  -H 'Authorization: Bearer abd90df5f27a7b170cd775abf89d632b350b7c1c9d53e08b340cd9832ce52c2c'

require 'coinbase/wallet'
client = Coinbase::Wallet::Client.new(api_key: <api key>, api_secret: <api secret>)

accounts = client.accounts

import requests

# For instructions generating JWT, check the "API Key Authentication" section
JWT_TOKEN = "<your_jwt_token>"

# Coinbase API base URL
ENDPOINT_URL = "https://api.coinbase.com/v2/accounts"

def get_accounts():
    # Generate headers with JWT for authentication
    headers = {
        "Authorization": f"Bearer {JWT_TOKEN}"
    }

    # Make the API request
    response = requests.get(ENDPOINT_URL, headers=headers)

    return response.json()  # Return the JSON response

accounts = get_accounts()
print(accounts)

var Client = require('coinbase').Client;

var client = new Client({'apiKey': 'API KEY',
                         'apiSecret': 'API SECRET'});

client.getAccounts({}, function(err, accounts) {
  console.log(accounts);
});

Response

{
  "pagination": {
    "ending_before": null,
    "starting_after": null,
    "limit": 25,
    "order": "desc",
    "previous_uri": null,
    "next_uri": null
  },
  "data": [
    {
      "id": "58542935-67b5-56e1-a3f9-42686e07fa40",
      "name": "My Vault",
      "primary": false,
      "type": "vault",
      "currency" : {
         "address_regex" : "^([13][a-km-zA-HJ-NP-Z1-9]{25,34})|^(bc1[qzry9x8gf2tvdw0s3jn54khce6mua7l]([qpzry9x8gf2tvdw0s3jn54khce6mua7l]{38}|[qpzry9x8gf2tvdw0s3jn54khce6mua7l]{58}))$",
         "asset_id" : "5b71fc48-3dd3-540c-809b-f8c94d0e68b5",
         "code" : "BTC",
         "color" : "#F7931A",
         "exponent" : 8,
         "name" : "Bitcoin",
         "slug" : "bitcoin",
         "sort_index" : 100,
         "type" : "crypto"
      }
      "balance": {
        "amount": "4.00000000",
        "currency": "BTC"
      },
      "created_at": "2024-01-31T20:49:02Z",
      "updated_at": "2024-01-31T20:49:02Z",
      "resource": "account",
      "resource_path": "/v2/accounts/58542935-67b5-56e1-a3f9-42686e07fa40",
      "ready": true
    },
    {
      "id": "2bbf394c-193b-5b2a-9155-3b4732659ede",
      "name": "My Wallet",
      "primary": true,
      "type": "wallet",
      "currency" : {
         "address_regex" : "^([13][a-km-zA-HJ-NP-Z1-9]{25,34})|^(bc1[qzry9x8gf2tvdw0s3jn54khce6mua7l]([qpzry9x8gf2tvdw0s3jn54khce6mua7l]{38}|[qpzry9x8gf2tvdw0s3jn54khce6mua7l]{58}))$",
         "asset_id" : "5b71fc48-3dd3-540c-809b-f8c94d0e68b5",
         "code" : "BTC",
         "color" : "#F7931A",
         "exponent" : 8,
         "name" : "Bitcoin",
         "slug" : "bitcoin",
         "sort_index" : 100,
         "type" : "crypto"
      }
      "balance": {
        "amount": "39.59000000",
        "currency": "BTC"
      },
      "created_at": "2024-01-31T20:49:02Z",
      "updated_at": "2024-01-31T20:49:02Z",
      "resource": "account",
      "resource_path": "/v2/accounts/2bbf394c-193b-5b2a-9155-3b4732659ede"
    },
    {
      "id": "8d5f2c4e-7a1b-5c3d-9e6f-0a1b2c3d4e5f",
      "name": "USDC Wallet",
      "primary": true,
      "type": "wallet",
      "currency": {
        "asset_id": "2b92315d-eab7-5bef-84fa-089a131333f5",
        "code": "USDC",
        "exponent": 6,
        "name": "USDC",
        "type": "crypto"
      },
      "balance": {
        "amount": "250.000000",
        "currency": "USDC"
      },
      "available_to_send": {
        "amount": "200.000000",
        "currency": "USDC"
      },
      "created_at": "2024-01-31T20:49:02Z",
      "updated_at": "2024-01-31T20:49:02Z",
      "resource": "account",
      "resource_path": "/v2/accounts/8d5f2c4e-7a1b-5c3d-9e6f-0a1b2c3d4e5f"
    }
  ]
}

Show Account

Show (or get) a current user’s account. To access the primary account for a given currency, a currency string (e.g., BTC or ETH) can be used instead of the account ID in the URL.

HTTP Request

GET https://api.coinbase.com/v2/accounts/:account_id

Scopes

wallet:accounts:read

Arguments

Parameter	Type	Required	Description
`include_available_to_send`	boolean	Optional	Include `available_to_send` on the account if it’s eligible. Defaults to `false`.

See List Accounts for details on available_to_send and an example response that includes it.

Examples

Request

curl https://api.coinbase.com/v2/accounts/2bbf394c-193b-5b2a-9155-3b4732659ede \
    -H 'Authorization: Bearer abd90df5f27a7b170cd775abf89d632b350b7c1c9d53e08b340cd9832ce52c2c'

require 'coinbase/wallet'
client = Coinbase::Wallet::Client.new(api_key: <api key>, api_secret: <api secret>)

account = client.account("2bbf394c-193b-5b2a-9155-3b4732659ede")

import requests

# For instructions generating JWT, check the "API Key Authentication" section
JWT_TOKEN = "<your_jwt_token>"

# Coinbase API base URL
ENDPOINT_URL = "https://api.coinbase.com/v2/accounts/:account_id"

def get_account():
    # Generate headers with JWT for authentication
    headers = {
        "Authorization": f"Bearer {JWT_TOKEN}"
    }

    # Make the API request
    response = requests.get(ENDPOINT_URL, headers=headers)

    return response.json()  # Return the JSON response

account = get_account()
print(account)

var Client = require('coinbase').Client;

var client = new Client({'apiKey': 'API KEY',
                         'apiSecret': 'API SECRET'});

client.getAccount("2bbf394c-193b-5b2a-9155-3b4732659ede", function(err, account) {
  console.log(account);
});

Response

{
  "data": {
    "id": "2bbf394c-193b-5b2a-9155-3b4732659ede",
    "name": "My Wallet",
    "primary": true,
    "type": "wallet",
      "currency" : {
         "address_regex" : "^([13][a-km-zA-HJ-NP-Z1-9]{25,34})|^(bc1[qzry9x8gf2tvdw0s3jn54khce6mua7l]([qpzry9x8gf2tvdw0s3jn54khce6mua7l]{38}|[qpzry9x8gf2tvdw0s3jn54khce6mua7l]{58}))$",
         "asset_id" : "5b71fc48-3dd3-540c-809b-f8c94d0e68b5",
         "code" : "BTC",
         "color" : "#F7931A",
         "exponent" : 8,
         "name" : "Bitcoin",
         "slug" : "bitcoin",
         "sort_index" : 100,
         "type" : "crypto"
      }
    "balance": {
      "amount": "39.59000000",
      "currency": "BTC"
    },
    "created_at": "2024-01-31T20:49:02Z",
    "updated_at": "2024-01-31T20:49:02Z",
    "resource": "account",
    "resource_path": "/v2/accounts/2bbf394c-193b-5b2a-9155-3b4732659ede"
  }
}

​Table of Endpoints

​Overview

​Account Resource

​Get Current User

​HTTP Request

​Scopes

​Examples

​Request

​Response

​Get Personal Details

​HTTP Request

​Scopes

​Examples

​Request

​Response

​List Accounts

​HTTP Request

​Scopes

​Arguments

​Examples

​Request

​Response

​Show Account

​HTTP Request

​Scopes

​Arguments

​Examples

​Request

​Response

Table of Endpoints

Overview

Account Resource

Get Current User

HTTP Request

Scopes

Examples

Request

Response

Get Personal Details

HTTP Request

Scopes

Examples

Request

Response

List Accounts

HTTP Request

Scopes

Arguments

Examples

Request

Response

Show Account

HTTP Request

Scopes

Arguments

Examples

Request

Response