> ## Documentation Index > Fetch the complete documentation index at: https://docs.cdp.coinbase.com/llms.txt > Use this file to discover all available pages before exploring further. # Staking API Usage Staking API can be accessed via the CDP SDK, a simple client library for interacting with the Staking API, or through the CDP API, a restful API for direct http requests. For details on getting started with our SDK, see our [quickstart](/staking/staking-api/introduction/quickstart). ## Authentication Our REST APIs use JWT tokens for authentication. Find more information on generating a JWT token in the language of your choice [here](/get-started/authentication/jwt-authentication#code-samples). ## Making an API request 1. Click through any API in the reference [here](/api-reference/rest-api/staking/build-a-new-staking-operation) to learn more about its parameters and usage. 2. Fill in the parameters. For APIs like [BuildStakingOperation](/api-reference/rest-api/staking/build-a-new-staking-operation) and [GetStakingContext](/api-reference/rest-api/staking/get-staking-context) that require custom options, refer to the [staking options](#staking-options) section below for available options.
API Input
3. Select your preferred language on the right to generate a sample request code. Use this as a reference to make a staking API request. For example, for the `BuildStakingOperation` API, the generated code for a Partial ETH stake of `0.1 ETH` will look like this in some of the common languages: ```bash Bash theme={null} curl -s -L 'https://api.cdp.coinbase.com/platform/v1/stake/build' \ -H 'Content-Type: application/json' \ -H 'Accept: application/json' \ -d '{ "network_id": "ethereum-hoodi", "asset_id": "ETH", "address_id": "0xabcd", "action": "stake", "options": { "mode": "partial", "amount": "100000000000000000" } }' ``` ```node NodeJs [expandable] theme={null} const axios = require('axios'); let data = JSON.stringify({ "network_id": "ethereum-hoodi", "asset_id": "ETH", "address_id": "0xabcd", "action": "stake", "options": { "mode": "partial", "amount": "100000000000000000" } }); let config = { method: 'post', maxBodyLength: Infinity, url: 'https://api.cdp.coinbase.com/platform/v1/stake/build', headers: { 'Content-Type': 'application/json', 'Accept': 'application/json' }, data : data }; axios.request(config) .then((response) => { console.log(JSON.stringify(response.data)); }) .catch((error) => { console.log(error); }); ``` ```go Go [expandable] theme={null} package main import ( "fmt" "net/http" "io/ioutil" "strings" ) func main() { url := "https://api.cdp.coinbase.com/platform/v1/stake/build" method := "POST" payload := strings.NewReader(`{"network_id":"ethereum-hoodi","asset_id":"ETH","address_id":"0xabcd","action":"stake","options":{"mode":"partial","amount":"100000000000000000"}}`) client := &http.Client {} req, err := http.NewRequest(method, url, payload) if err != nil { fmt.Println(err) return } req.Header.Add("Content-Type", "application/json") req.Header.Add("Accept", "application/json") res, err := client.Do(req) if err != nil { fmt.Println(err) return } defer res.Body.Close() body, err := ioutil.ReadAll(res.Body) if err != nil { fmt.Println(err) return } fmt.Println(string(body)) } ``` 4. Finally, add the JWT token, obtained from the authentication section [above](#authentication), as a Bearer header in your request. The code will look like this: ```bash cURL theme={null} export JWT="generated-jwt-token" # Replace with your JWT token curl -s -L 'https://api.cdp.coinbase.com/platform/v1/stake/build' \ -H 'Content-Type: application/json' \ -H 'Accept: application/json' \ -H "Authorization: Bearer ${JWT}" \ -d '{ "network_id": "ethereum-hoodi", "asset_id": "ETH", "address_id": "0xabcd", "action": "stake", "options": { "mode": "partial", "amount": "100000000000000000" } }' ``` ```node NodeJs [expandable] theme={null} const axios = require('axios'); let data = JSON.stringify({ "network_id": "ethereum-hoodi", "asset_id": "ETH", "address_id": "0xabcd", "action": "stake", "options": { "mode": "partial", "amount": "100000000000000000" } }); let JWT = 'generated-jwt-token'; // Replace with your JWT token let config = { method: 'post', maxBodyLength: Infinity, url: 'https://api.cdp.coinbase.com/platform/v1/stake/build', headers: { 'Content-Type': 'application/json', 'Accept': 'application/json', 'Authorization': `Bearer ${JWT}` }, data : data }; axios.request(config) .then((response) => { console.log(JSON.stringify(response.data)); }) .catch((error) => { console.log(error); }); ``` ```go Go [expandable] theme={null} package main import ( "fmt" "net/http" "io/ioutil" "strings" ) func main() { url := "https://api.cdp.coinbase.com/platform/v1/stake/build" method := "POST" payload := strings.NewReader(`{"network_id":"ethereum-hoodi","asset_id":"ETH","address_id":"0xabcd","action":"stake","options":{"mode":"partial","amount":"100000000000000000"}}`) jwt := "generated-jwt-token" // Replace with your JWT token client := &http.Client {} req, err := http.NewRequest(method, url, payload) if err != nil { fmt.Println(err) return } req.Header.Add("Content-Type", "application/json") req.Header.Add("Accept", "application/json") req.Header.Add("Authorization", fmt.Sprintf("Bearer %s", jwt)) res, err := client.Do(req) if err != nil { fmt.Println(err) return } defer res.Body.Close() body, err := ioutil.ReadAll(res.Body) if err != nil { fmt.Println(err) return } fmt.Println(string(body)) } ``` *** ## Staking Options Some staking APIs such as [BuildStakingOperation](/api-reference/rest-api/staking/build-a-new-staking-operation) and [GetStakingContext](/api-reference/rest-api/staking/get-staking-context) require additional options to be passed in the request body specific to the staking network. See below to find the options available for each staking network. Once you have identified which options you need, you can add them to the request body under the `options` field like so: ```json lines wrap theme={null} { ... "options": { "mode": "partial", "amount": "100000000000000000", "integrator_contract_address": "custom-integrator-address" } } ``` ### Shared ETH Staking Shared ETH staking supports the following `BuildStakingOperation` actions: `stake`, `unstake` and `claim_stake`. See the tabs below for details on the options that can be used with each one. | Field Name | Description | | ---------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | mode
*required* | The mode of staking.
For Shared ETH Staking this should be `partial`. | | amount
*required* | The amount to stake in `wei`. | | integrator\_contract\_address
*optional* | The contract address for the staking operation.
Defaults to the integrator contract address associated with the CDP account or a [shared integrator contract address](/staking/staking-api/protocols/shared-eth/overview) for that network. | | Field Name | Description | | ---------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | mode
*required* | The mode of staking.
For Shared ETH Staking this should be `partial`. | | amount
*required* | The amount to unstake in `wei`. | | integrator\_contract\_address
*optional* | The contract address for the staking operation.
Defaults to the integrator contract address associated with the CDP account or a [shared integrator contract address](/staking/staking-api/protocols/shared-eth/overview) for that network. | | Field Name | Description | | ---------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | mode
*required* | The mode of staking.
For Shared ETH Staking this should be `partial`. | | integrator\_contract\_address
*optional* | The contract address for the staking operation.
Defaults to the integrator contract address associated with the CDP account or a [shared integrator contract address](/staking/staking-api/protocols/shared-eth/overview) for that network. | | Field Name | Description | | ---------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | mode
*required* | The mode of staking.
For Shared ETH Staking this should be `partial`. | | integrator\_contract\_address
*optional* | The contract address for the staking operation.
Defaults to the integrator contract address associated with the CDP account or a [shared integrator contract address](/staking/staking-api/protocols/shared-eth/overview) for that network. | ### Dedicated ETH Staking Dedicated ETH staking supports the following `BuildStakingOperation` actions: `stake` and `unstake`. See the tabs below for details on the options that can be used with each one. | Field Name | Description | | --------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | mode
*required* | The mode of staking.
For Dedicated ETH Staking this should be `native`. | | amount
*required* | The amount to stake in `wei` and in `multiples of 32 ETH`. | | funding\_address
*optional* | Funding address for the stake operation.
Defaults to the address initiating the stake operation. | | withdrawal\_address
*optional* | Rewards and withdrawal address.
Defaults to the address initiating the stake operation. | | fee\_recipient\_address
*optional* | Tx fee recipient address.
Defaults to the address initiating the stake operation. | | withdrawal\_credential\_type
*optional* | Prefix indicating the type of withdrawal credentials for the validator.
Set to `0x02` for provisioning post Pectra validators.
Possible values: `0x01`, `0x02`
Defaults to pre Pectra validator prefix of `0x01`. | | top\_up\_validator\_pubkey
*optional* | The validator public key to top up.
If provided, instead of creating a new validator, the existing validator will be topped up with the specified amount. | | Field Name | Description | | ------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------ | | mode
*required* | The mode of staking.
For Dedicated ETH Staking this should be `native`. | | amount
*required* | The amount to unstake in `wei` and in `multiples of 32 ETH`. | | unstake\_type
*optional* | The type of unstaking operation to perform.
Possible values: `consensus`, `execution`
Defaults to `consensus`. | | immediate
*optional* | Set to `true` for immediate unstake using `Coinbase managed unstake` process.
Defaults to `false` for `User managed unstake` process. | | validator\_pub\_keys
*optional* | Comma-separated list of validator public keys to unstake.
Defaults to validators selected based on the unstake amount. | | Field Name | Description | | ------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------- | | source\_validator\_pubkey
*required* | The source validator public key to consolidate. This can be either a 0x01 or 0x02 validator. | | target\_validator\_pubkey
*required* | The target validator public key to which the source validator will be consolidated into. This can be either a 0x01 or 0x02 validator. | | Field Name | Description | | --------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | mode
*required* | The mode of staking.
For Dedicated ETH Staking this should be `native`. | | validator\_pub\_keys
*optional* | List of comma separated validator public keys to retrieve unstakeable balance for.
Defaults to all validators. | | withdrawal\_credential\_type
*optional* | Prefix indicating the type of validator for which we want to get the context.
Set to `0x02` for post Pectra validators.
Possible values: `0x01`, `0x02`
Defaults to pre Pectra validator prefix of `0x01`. | ### SOL Staking SOL staking supports the following `BuildStakingOperation` actions: `stake`, `unstake` and `claim_stake`. See the tabs below for details on the options that can be used with each one. | Field Name | Description | | ----------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | amount
*required* | The amount to stake in `lamports`. | | validator\_address
*optional* | The validator address to which you want to stake.
Defaults to the Coinbase Solana validator. See [here](/staking/staking-api/protocols/sol/overview#validator-details) for validator details. | | Field Name | Description | | ----------------------- | ------------------------------------ | | amount
*required* | The amount to unstake in `lamports`. |