Build a new staking operation

curl --request POST \
  --url https://api.cdp.coinbase.com/platform/v1/stake/build \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "network_id": "ethereum-mainnet",
  "asset_id": "ETH",
  "address_id": "0xfc807D1bE4997e5C7B33E4d8D57e60c5b0f02B1a",
  "action": "unstake",
  "options": {}
}
'

{
  "id": "d91d652b-d020-48d4-bf19-5c5eb5e280c7",
  "network_id": "ethereum-hoodi",
  "address_id": "0xfc807D1bE4997e5C7B33E4d8D57e60c5b0f02B1a",
  "status": "initialized",
  "transactions": [
    {
      "network_id": "base-sepolia",
      "from_address_id": "0xfc807D1bE4997e5C7B33E4d8D57e60c5b0f02B1a",
      "unsigned_payload": "<string>",
      "status": "pending",
      "signed_payload": "<string>",
      "transaction_hash": "0x53e11e94ebb2438d6ddcfa07dabc9b551d2f440f8363fea941083bc397a86a42",
      "transaction_link": "https://sepolia.basescan.org/tx/0x53e11e94ebb2438d6ddcfa07dabc9b551d2f440f8363fea941083bc397a86a42",
      "content": {
        "from": "0xfc807D1bE4997e5C7B33E4d8D57e60c5b0f02B1a",
        "to": "0xfc807D1bE4997e5C7B33E4d8D57e60c5b0f02B1a",
        "gas": 1000,
        "gas_price": 1000,
        "hash": "0x53e11e94ebb2438d6ddcfa07dabc9b551d2f440f8363fea941083bc397a86a42",
        "input": "<string>",
        "nonce": 136,
        "index": "0x53e11e94ebb2438d6ddcfa07dabc9b551d2f440f8363fea941083bc397a86a42",
        "value": 100,
        "type": 2,
        "max_fee_per_gas": 190,
        "max_priority_fee_per_gas": 100,
        "priority_fee_per_gas": 1000,
        "transaction_access_list": {
          "access_list": [
            {
              "address": "<string>",
              "storage_keys": [
                "<string>"
              ]
            }
          ]
        },
        "flattened_traces": [
          {
            "error": "<string>",
            "type": "<string>",
            "from": "<string>",
            "to": "<string>",
            "value": "<string>",
            "gas": 123,
            "gas_used": 123,
            "input": "<string>",
            "output": "<string>",
            "sub_traces": 123,
            "trace_address": [
              123
            ],
            "trace_type": "<string>",
            "call_type": "<string>",
            "trace_id": "<string>",
            "status": 123,
            "block_hash": "<string>",
            "block_number": 123,
            "transaction_hash": "<string>",
            "transaction_index": 123
          }
        ],
        "block_timestamp": "2023-04-01T12:00:00Z",
        "mint": "0",
        "rlp_encoded_tx": "0x02f582426882013d8502540be4008502540be41c830493e094a55416de5de61a0ac1aa8970a280e04388b1de4b6f843a4b66f1c0808080"
      }
    }
  ],
  "wallet_id": "d91d652b-d020-48d4-bf19-5c5eb5e280c7",
  "metadata": "<unknown>"
}

Staking

Build a new staking operation

Builds a new staking operation containing a dynamic list of staking transactions based on the specified network, asset, address, and custom options.

It returns a StakingOperation resource, a unified interface for the entire staking process. Regardless of network complexity, the API abstracts away all the underlying details through it. You can iterate through this resource to access each staking transaction and have them be signed and broadcasted to land the staking transaction onchain.

Read up more about the stake operation and how to interact with it here.

POST

stake

build

Build a new staking operation

curl --request POST \
  --url https://api.cdp.coinbase.com/platform/v1/stake/build \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "network_id": "ethereum-mainnet",
  "asset_id": "ETH",
  "address_id": "0xfc807D1bE4997e5C7B33E4d8D57e60c5b0f02B1a",
  "action": "unstake",
  "options": {}
}
'

{
  "id": "d91d652b-d020-48d4-bf19-5c5eb5e280c7",
  "network_id": "ethereum-hoodi",
  "address_id": "0xfc807D1bE4997e5C7B33E4d8D57e60c5b0f02B1a",
  "status": "initialized",
  "transactions": [
    {
      "network_id": "base-sepolia",
      "from_address_id": "0xfc807D1bE4997e5C7B33E4d8D57e60c5b0f02B1a",
      "unsigned_payload": "<string>",
      "status": "pending",
      "signed_payload": "<string>",
      "transaction_hash": "0x53e11e94ebb2438d6ddcfa07dabc9b551d2f440f8363fea941083bc397a86a42",
      "transaction_link": "https://sepolia.basescan.org/tx/0x53e11e94ebb2438d6ddcfa07dabc9b551d2f440f8363fea941083bc397a86a42",
      "content": {
        "from": "0xfc807D1bE4997e5C7B33E4d8D57e60c5b0f02B1a",
        "to": "0xfc807D1bE4997e5C7B33E4d8D57e60c5b0f02B1a",
        "gas": 1000,
        "gas_price": 1000,
        "hash": "0x53e11e94ebb2438d6ddcfa07dabc9b551d2f440f8363fea941083bc397a86a42",
        "input": "<string>",
        "nonce": 136,
        "index": "0x53e11e94ebb2438d6ddcfa07dabc9b551d2f440f8363fea941083bc397a86a42",
        "value": 100,
        "type": 2,
        "max_fee_per_gas": 190,
        "max_priority_fee_per_gas": 100,
        "priority_fee_per_gas": 1000,
        "transaction_access_list": {
          "access_list": [
            {
              "address": "<string>",
              "storage_keys": [
                "<string>"
              ]
            }
          ]
        },
        "flattened_traces": [
          {
            "error": "<string>",
            "type": "<string>",
            "from": "<string>",
            "to": "<string>",
            "value": "<string>",
            "gas": 123,
            "gas_used": 123,
            "input": "<string>",
            "output": "<string>",
            "sub_traces": 123,
            "trace_address": [
              123
            ],
            "trace_type": "<string>",
            "call_type": "<string>",
            "trace_id": "<string>",
            "status": 123,
            "block_hash": "<string>",
            "block_number": 123,
            "transaction_hash": "<string>",
            "transaction_index": 123
          }
        ],
        "block_timestamp": "2023-04-01T12:00:00Z",
        "mint": "0",
        "rlp_encoded_tx": "0x02f582426882013d8502540be4008502540be41c830493e094a55416de5de61a0ac1aa8970a280e04388b1de4b6f843a4b66f1c0808080"
      }
    }
  ],
  "wallet_id": "d91d652b-d020-48d4-bf19-5c5eb5e280c7",
  "metadata": "<unknown>"
}

Authorizations

Authorization

string

header

required

Enter your JSON Web Token (JWT) here. Refer to the Generate JWT section of our Authentication docs for information on how to generate your Bearer Token.

Body

application/json

network_id

string

required

The ID of the blockchain network.

Example:

"ethereum-mainnet"

asset_id

string

required

The symbol of the asset being staked.

Example:

"ETH"

address_id

string

required

The onchain address from which the staking transaction originates and is responsible for signing the transaction.

Example:

"0xfc807D1bE4997e5C7B33E4d8D57e60c5b0f02B1a"

action

string

required

The type of staking operation (stake, unstake, claim_stake, etc.)

Example:

"unstake"

options

object

required

Additional options for the staking operation. See here for detailed options.

Show child attributes

options.{key}

string

Response

successful staking transaction generated

A list of onchain transactions to help realize a staking action.

string

required

The unique ID of the staking operation.

Example:

"d91d652b-d020-48d4-bf19-5c5eb5e280c7"

network_id

string

required

The ID of the blockchain network.

Example:

"ethereum-hoodi"

address_id

string

required

The onchain address orchestrating the staking operation.

Example:

"0xfc807D1bE4997e5C7B33E4d8D57e60c5b0f02B1a"

status

enum<string>

required

The status of the staking operation.

Available options:

initialized,

pending,

complete,

failed,

unspecified

transactions

object[]

required

The transaction(s) that will execute the staking operation onchain.

Show child attributes

transactions.network_id

string

required

Blockchain network identifier.

Example:

"base-sepolia"

transactions.from_address_id

string

required

The onchain address of the sender

Example:

"0xfc807D1bE4997e5C7B33E4d8D57e60c5b0f02B1a"

transactions.unsigned_payload

string

required

The unsigned payload of the transaction. This is the payload that needs to be signed by the sender.

transactions.status

enum<string>

required

The status of the transaction.

Available options:

pending,

signed,

broadcast,

complete,

failed,

unspecified

transactions.signed_payload

string

The signed payload of the transaction. This is the payload that has been signed by the sender.

transactions.transaction_hash

string

The hash of the transaction

Example:

"0x53e11e94ebb2438d6ddcfa07dabc9b551d2f440f8363fea941083bc397a86a42"

transactions.transaction_link

string

The link to view the transaction on a block explorer. This is optional and may not be present for all transactions.

Example:

"https://sepolia.basescan.org/tx/0x53e11e94ebb2438d6ddcfa07dabc9b551d2f440f8363fea941083bc397a86a42"

transactions.content

object

Show child attributes

transactions.content.from

string

required

The onchain address of the sender.

Example:

"0xfc807D1bE4997e5C7B33E4d8D57e60c5b0f02B1a"

transactions.content.to

string

required

The onchain address of the receiver.

Example:

"0xfc807D1bE4997e5C7B33E4d8D57e60c5b0f02B1a"

transactions.content.gas

integer<uint64>

The amount of gas spent in the transaction.

Example:

1000

transactions.content.gas_price

integer<uint64>

The price per gas spent in the transaction in atomic units of the native asset.

Example:

1000

transactions.content.hash

string

The hash of the transaction as a hexadecimal string, prefixed with 0x.

Example:

"0x53e11e94ebb2438d6ddcfa07dabc9b551d2f440f8363fea941083bc397a86a42"

transactions.content.input

string

The input data of the transaction.

transactions.content.nonce

integer<uint64>

The nonce of the transaction in the source address.

Example:

136

transactions.content.index

integer<uint64>

The index of the transaction in the block.

Example:

"0x53e11e94ebb2438d6ddcfa07dabc9b551d2f440f8363fea941083bc397a86a42"

transactions.content.value

string

The value of the transaction in atomic units of the native asset.

Example:

100

transactions.content.type

integer<uint64>

The EIP-2718 transaction type. See https://eips.ethereum.org/EIPS/eip-2718 for more details.

Example:

2

transactions.content.max_fee_per_gas

integer<uint64>

The max fee per gas as defined in EIP-1559. https://eips.ethereum.org/EIPS/eip-1559 for more details.

Example:

190

transactions.content.max_priority_fee_per_gas

integer<uint64>

The max priority fee per gas as defined in EIP-1559. https://eips.ethereum.org/EIPS/eip-1559 for more details.

Example:

100

transactions.content.priority_fee_per_gas

integer<uint64>

The confirmed priority fee per gas as defined in EIP-1559. https://eips.ethereum.org/EIPS/eip-1559 for more details.

Example:

1000

transactions.content.transaction_access_list

object

The transaction access list as defined in EIP-2930. https://eips.ethereum.org/EIPS/eip-2930 for more details.

Show child attributes

transactions.content.transaction_access_list.access_list

object[]

Show child attributes

transactions.content.transaction_access_list.access_list.address

string

transactions.content.transaction_access_list.access_list.storage_keys

string[]

transactions.content.flattened_traces

object[]

Show child attributes

transactions.content.flattened_traces.error

string

transactions.content.flattened_traces.type

string

transactions.content.flattened_traces.from

string

transactions.content.flattened_traces.to

string

transactions.content.flattened_traces.value

string

transactions.content.flattened_traces.gas

integer<uint64>

transactions.content.flattened_traces.gas_used

integer<uint64>

transactions.content.flattened_traces.input

string

transactions.content.flattened_traces.output

string

transactions.content.flattened_traces.sub_traces

integer<uint64>

transactions.content.flattened_traces.trace_address

integer<uint64>[]

transactions.content.flattened_traces.trace_type

string

transactions.content.flattened_traces.call_type

string

transactions.content.flattened_traces.trace_id

string

transactions.content.flattened_traces.status

integer<uint64>

transactions.content.flattened_traces.block_hash

string

transactions.content.flattened_traces.block_number

integer<uint64>

transactions.content.flattened_traces.transaction_hash

string

transactions.content.flattened_traces.transaction_index

integer<uint64>

transactions.content.block_timestamp

string<date-time>

The timestamp of the block in which the event was emitted

Example:

"2023-04-01T12:00:00Z"

transactions.content.mint

string

This is for handling optimism rollup specific EIP-2718 transaction type field.

Example:

"0"

transactions.content.rlp_encoded_tx

string

RLP encoded transaction as a hex string (prefixed with 0x) for native compatibility with popular eth clients such as etherjs, viem etc.

Example:

"0x02f582426882013d8502540be4008502540be41c830493e094a55416de5de61a0ac1aa8970a280e04388b1de4b6f843a4b66f1c0808080"

wallet_id

string

The ID of the wallet that owns the address.

Example:

"d91d652b-d020-48d4-bf19-5c5eb5e280c7"

metadata

any

Broadcast a staking operation for wallet

Build a new staking operation for wallet

⌘I

CDP API V1

REST API

JSON-RPC API

Build a new staking operation

Authorizations

Body

Response