Figment

https://docs.figment.io/
Admin
Figment provides developers with an API and UI components (Elements) to integrate staking and...
Tokens:273,730
Snippets:478
Trust Score:9.8
Update:1 year ago
Show doc for...
Tokens:
Raw
### Install Figment's dYdX NPM Package

Source: https://docs.figment.io/docs/dydx

This snippet shows how to install the npm package for accessing the dYdX testnet faucet. It's a common way to get test tokens for development and testing purposes.

```bash
npm install @figment-networks/dydx-cli-api
```

--------------------------------

### Get Ethereum Validators Summary (Python)

Source: https://docs.figment.io/reference/ethereum-validators-summary

This Python example shows how to retrieve a summary of Ethereum validators via the Figment API. It uses the 'requests' library to make a GET request with network and operator parameters, and includes the API key.

```python
import requests

url = "https://api.figment.io/ethereum/validators_summary"

params = {
    "network": "mainnet",
    "operated_by": "null"
}

headers = {
    "accept": "application/json",
    "x-api-key": "your-api-key-here"
}

response = requests.get(url, params=params, headers=headers)

print(response.json())
```

--------------------------------

### Fireblocks API Response Example (Cardano)

Source: https://docs.figment.io/docs/signing-transactions-1

An example of the response structure from the Fireblocks API containing `publicKey` and `fullSig` for Cardano transactions.

```JavaScript
'signedMessages': [
  {
    'publicKey': '9c9f6d340fab44895406405d5c50fa480b59dafda5f38649f7a2d53ebbb5a7d1',
    'signature': {
      'fullSig': 'f77f92d7f137011d5f0571d48ada31be3026f6b1dd0db013987c02a89898597aa7bbed3cfe6b35f8e42c4e782a51f1602a7fb75c78c4c30a76811f4da2cd590b'
    }
  }
]
```

--------------------------------

### Get Ethereum Validators Summary (Node.js)

Source: https://docs.figment.io/reference/ethereum-validators-summary

This Node.js example demonstrates how to fetch a summary of Ethereum validators from the Figment API. It makes a GET request with specified network and operator filters, and includes the necessary API key.

```javascript
const axios = require('axios');

const options = {
  method: 'GET',
  url: 'https://api.figment.io/ethereum/validators_summary',
  params: {
    network: 'mainnet',
    operated_by: 'null'
  },
  headers: {
    'accept': 'application/json',
    'x-api-key': 'your-api-key-here'
  }
};

axios.request(options).then(function (response) {
  console.log(response.data);
}).catch(function (error) {
  console.error(error);
});
```

--------------------------------

### Example Ethereum Activity Response

Source: https://docs.figment.io/reference/ethereum-activity

This is an example JSON response from the Figment API for the Ethereum activity endpoint. It lists staking and unstaking actions with details such as timestamp, network, currency, amount, and status.

```JSON
{
  "data": [
    {
      "action": "unstake",
      "timestamp": "2024-03-15T14:49:01Z",
      "network": "mainnet",
      "currency": "ETH",
      "amount": 32,
      "status": "exiting"
    },
    {
      "action": "stake",
      "timestamp": "2024-03-13T08:02:17Z",
      "network": "mainnet",
      "currency": "ETH",
      "amount": 96,
      "tx_hash": "0xef7310cc8324ce15a483d9578a5a732d203ec8f99f5b84ad8139140ea317a3fb",
      "status": "activating"
    }
  ],
  "meta": {
    "pagination": {
      "current_page": 1,
      "total_pages": 1,
      "total_item_count": 2
    }
  }
}
```

--------------------------------

### Solana Tx Status Response Example

Source: https://docs.figment.io/reference/solana-tx-status

Provides an example of the JSON response when querying transaction status. Includes data such as transaction status, network, and transaction hash.

```JSON
{
  "data": {
    "status": "confirmed",
    "network": "devnet",
    "tx_hash": "21Tkwaxmjfi8RTsUcrri2asfe59MWKSCxyBXJsvqLD8N7wbUy3xBriVLxqxJ9QqggHaD9Lrk5jGeMdhko2Ff6tpM"
  }
}
```

--------------------------------

### ADA Rewards Response Example (JSON)

Source: https://docs.figment.io/reference/cardano-2

Example JSON response from the Figment API for ADA rewards. It includes delegator details, epoch information, reward amounts, balances, and metadata.

```JSON
{
  "data": [
    {
      "delegator_addresses": "stake1uxcmc9r2t7cxs0zw8qm8ztg3twvxryzghsc8eszek6kuwms23gya4",
      "validator": "pool1fqwnqk3phwa2s5thgym8dw34pv0z67m526uqprnjh93cvzxymef",
      "epoch": "417",
      "timestamp": "2023-07-21T00:00:00Z",
      "rewards": [
        {
          "text": "823.370257 ADA",
          "currency": "ADA",
          "numeric": 823370257,
          "exp": 6,
          "type": "member"
        }
      ],
      "balances": [
        {
          "text": "0",
          "currency": "ADA",
          "numeric": 0,
          "exp": 6
        }
      ],
      "stake_key_hash": "b1bc146a5fb0683c4e3836712d115b98619048bc307cc059b6adc76e"
    }
  ],
  "meta": {
    "protocol": "cardano",
    "network": "mainnet",
    "time_rollup": "epoch"
  }
}
```

--------------------------------

### Get Blockfrost Projects Response (JSON)

Source: https://docs.figment.io/reference/cardano-1

This is an example of a successful JSON response (200 OK) when retrieving Blockfrost projects. It includes metadata with pagination information and a data array containing details for each project.

```JSON
{
  "meta": {
    "pagination": {
      "current_page": 1,
      "total_pages": 10,
      "total_item_count": 100
    }
  },
  "data": [
    {
      "id": "string",
      "network": "string",
      "project_id": "string",
      "created": "string"
    }
  ]
}
```

--------------------------------

### Stake SOL from a Hot Wallet (Solana)

Source: https://docs.figment.io/docs/sol-staking-101

This recipe provides instructions and code examples for staking SOL tokens from a hot wallet on the Solana network. It covers the necessary steps to create, sign, and broadcast staking transactions.

```bash
Stake SOL from a hot wallet
```

--------------------------------

### Stake SOL from Fireblocks (Solana)

Source: https://docs.figment.io/docs/sol-staking-101

This recipe outlines the process for staking SOL tokens using Fireblocks on the Solana network. It includes guidance on creating, signing, and broadcasting the required staking transactions.

```bash
Stake SOL from Fireblocks
```

--------------------------------

### Example API Response for Validators

Source: https://docs.figment.io/reference/get-validators

This snippet shows an example of a successful JSON response when querying the Figment API for validator data. It includes details like validator ID, network, public key, status, and staking request information.

```JSON
{
  "data": [
    {
      "id": "29d3a221-8de7-4874-9973-35ac1e70b87b",
      "network": "hoodi",
      "pubkey": "0xb121633094a5e75b886eeba797d43e80e4a6003462921f175aed2f112a460d09447f3c484f067c13b100b763070857b3",
      "withdrawal_address": "0xE40F80618324C814cD444434670a44ba4583aE38",
      "withdrawal_credentials": "0x010000000000000000000000e40f80618324c814cd444434670a44ba4583aE38",
      "net_fee_payout_address": "0xE40F80618324C814cD444434670a44ba4583aE38",
      "fee_recipient_address": "0xE40F80618324C814cD444434670a44ba4583aE38",
      "status": "deposited",
      "region": "ca-central-1",
      "index": null,
      "staking_request": {
        "id": "817c04a2-3d5b-4222-81c8-2de77f0be7db",
        "created_at": "2023-10-17T18:35:30Z"
      },
      "status_history": {
        "events": [
          {
            "status": "provisioned",
            "changed_at": "2023-10-17T18:35:31Z"
          },
          {
            "status": "deposited_not_finalized",
            "changed_at": "2023-10-17T20:38:36Z"
          },
          {
            "status": "deposited",
            "changed_at": "2023-10-17T20:51:36Z"
          }
        ]
      },
      "deposit_data": {
        "signature": "0xb7a8703d0ff4865174525c760509a18c5cdc4a321612d865b995d9ba60a9519703d3f7be1527e89041dbea886cb3b26a0d1a13976405b93301cdb16a54258ec3ac891e738ad73e68c6a6a09b286f8c8c71005eb8e55d144ee59fa7c311ac3dea",
        "figment_signature": "0x308187024201cc42b16a0264b3853e123034f21ef7fc1d75b96bc8ae13427836475838c447f90e19a8e3926fe3d20bc91da4d720f886ef3eb3f35ed164674bb6cab2c216329c2002411392c3c6a70bf5f3df0ed3d092d28dbed24933d4ab150ec1ee60cba79d72d374572a04161d5f47be6485353fd78a4c04cc4f3a7bdcc9e3ae749419cc35bc3f6a13",
        "deposit_data_root": "0x8d0b864a077b06044d2336264aaf8efbd03dd61ab0a8074bfb811b7f5c10146e"
      }
    }
  ]
}
```

--------------------------------

### Portfolio Response Example (JSON)

Source: https://docs.figment.io/reference/portfolio-1

An example JSON response for the portfolio endpoint, showing data for Ethereum and Solana. It includes details like protocol name, update timestamps, total rewards received, and current balance for each protocol.

```JSON
{
  "data": [
    {
      "protocol": "ethereum",
      "updated_at": "2023-12-22T23:56:36Z",
      "started_at": "2023-12-21T23:56:48Z",
      "total_rewards_received": "30.298559165000000000",
      "balance": "1120.000000000000000000"
    },
    {
      "protocol": "solana",
      "updated_at": "2024-05-29T00:00:00Z",
      "started_at": "2021-02-13T15:46:44Z",
      "total_rewards_received": "4442.628005617",
      "balance": "0.000000000"
    }
  ]
}
```

--------------------------------

### Get Single Ethereum Validator Response (JSON)

Source: https://docs.figment.io/reference/get-validator

This is an example JSON response for retrieving a single Ethereum validator's details. It includes information such as the validator's ID, network, public key, withdrawal address, status, and more.

```JSON
{
  "data": {
    "id": "8a075b89-c1f7-4381-a158-8ee866bf68bc",
    "network": "hoodi",
    "pubkey": "0xd1ef8d468ef53d82368d2026e321ab2c6d44f44c33b7b9f22369bf6dcf37fb0208f82dd6b485325ce1bbf5aec7ad45bb",
    "withdrawal_address": "0xE40F80618324C814cD444434670a44ba4583aE38",
    "withdrawal_credentials": "0x010000000000000000000000e40f80618324c814cd444434670a44ba4583aE38",
    "net_fee_payout_address": "0xE40F80618324C814cD444434670a44ba4583aE38",
    "fee_recipient_address": "0xE40F80618324C814cD444434670a44ba4583aE38",
    "status": "withdrawal_done",
    "region": "ca-central-1",
    "staking_request": {
      "id": "a428d279-27b3-482b-82f4-510e7b52adb5",
      "created_at": "2023-10-17T18:17:11Z"
    },
    "status_history": {
      "events": [
        {
          "status": "provisioned",
          "changed_at": "2023-10-17T18:17:11Z"
        },
        {
          "status": "deposited_not_finalized",
          "changed_at": "2023-10-17T20:39:36Z"
        },
        {
          "status": "deposited",
          "changed_at": "2023-10-17T20:51:36Z"
        },
        {
          "status": "pending_queued",
          "changed_at": "2023-10-18T13:29:36Z"
        },
        {
          "status": "active_ongoing",
          "changed_at": "2023-10-19T06:27:12Z"
        }
      ]
    }
  }
}
```

--------------------------------

### SUI API Endpoints Reference

Source: https://docs.figment.io/reference/sui-api-overview

This snippet outlines the available endpoints for the SUI API, including their functionality and parameters. It covers staking, transaction broadcasting, and stake retrieval.

```text
/stake: generates the staking transaction in hex.
/broadcast: broadcasts a signed transaction
/stakes: returns the list of SUI stake objects (with their `staked_sui_id`).
/withdraw: returns the withdraw transaction (using the `staked_sui_id` as one of the inputs), in hex
```

--------------------------------

### Fireblocks API Response Example

Source: https://docs.figment.io/docs/signing-transactions-with-the-fireblocks-api

This JavaScript object shows the structure of a typical response from the Fireblocks API, containing `publicKey` and `signature.fullSig` needed for transaction signing.

```JavaScript
'signedMessages': [
  {
    'publicKey': '9c9f6d340fab44895406405d5c50fa480b59dafda5f38649f7a2d53ebbb5a7d1',
    'signature': {
      'fullSig': 'f77f92d7f137011d5f0571d48ada31be3026f6b1dd0db013987c02a89898597aa7bbed3cfe6b35f8e42c4e782a51f1602a7fb75c78c4c30a76811f4da2cd590b'
    }
  }
]
```

--------------------------------

### Get Sui Stakes Response (JSON)

Source: https://docs.figment.io/reference/sui-get-stakes

This is an example of a successful response (200) from the Figment API when retrieving Sui stakes. It returns an object containing pagination information and an array of stake data, with each stake object detailing its ID, addresses, network, status, transaction hash, and amount.

```JSON
{
  "data": [
    {
      "stake_id": "0xabc8822e0aadb358697f049f51c734bf02e992fa8864e13eded521d0f58b0123",
      "delegator_address": "0xabcfae57b89d93ddaa8f39b52ea2ea7b2b93d967e3eb6f4d3c194f3b67756123",
      "validator_address": "0xabc1b319e23495995fc837dafd28fc6af8b645edddff0fc1467f1ad631362123",
      "network": "mainnet",
      "status": "active",
      "tx_hash": "4Se1rgNoA5GXDY5A5dqPqyGnKuizMju3dp6jvJmPaabc",
      "amount": 3.5
    }
  ]
}
```

--------------------------------

### API Pagination Request Example (JSON)

Source: https://docs.figment.io/reference/pagination

Demonstrates the JSON structure for making paginated requests to the API, specifying the desired page number and the number of items per page.

```json
{
  "page": {
    "number": 2,
    "size": 10
  }
}
```

--------------------------------

### Get Stakes Response (JSON)

Source: https://docs.figment.io/reference/solana-stakes

Example JSON response for a successful request to the Figment API's stakes endpoint, detailing stake account information.

```JSON
{
  "data": [
    {
      "id": "031af36c-508a-4f3d-84dd-f46d9e59428f",
      "network": "devnet",
      "stake_account": "string",
      "status": "string",
      "vote_account": "string",
      "stake_authority": "string",
      "withdraw_authority": "string",
      "balance": "string",
      "active_balance": "string",
      "inactive_balance": "string",
      "balance_usd": "string",
      "active_balance_usd": "string",
      "inactive_balance_usd": "string"
    }
  ]
}
```

--------------------------------

### Authenticate Figment API Request with cURL

Source: https://docs.figment.io/reference/authentication

This snippet demonstrates how to make a GET request to the Figment API using cURL. It shows the required base URL and how to include the API key in the 'x-api-key' header for authentication.

```bash
curl --request GET \
     --url 'https://api.figment.io/' \
     --header 'x-api-key: your-api-key-here'
```

--------------------------------

### Aptos CLI Faucet Usage

Source: https://docs.figment.io/docs/aptos

This snippet demonstrates how to use the Aptos CLI to request tokens from the testnet faucet. It's a common method for obtaining test APT tokens for development and testing purposes.

```bash
aptos faucet transfer --account <YOUR_ACCOUNT_ADDRESS> --amount <AMOUNT_IN_OCTAS>
```

--------------------------------

### GET Validator Status Response

Source: https://docs.figment.io/reference/exit-validators

This snippet shows an example of a successful (200 OK) response from the Figment API when querying validator status. The response contains detailed information about a validator, including its ID, network, public key, status, and deposit data.

```JSON
{
  "data": [
    {
      "id": "031af36c-508a-4f3d-84dd-f46d9e59428f",
      "index": "123456",
      "network": "hoodi",
      "pubkey": "0xd1ef8d468ef53d82368d2026e321ab2c6d44f44c33b7b9f22369bf6dcf37fb0208f82dd6b485325ce1bbf5aec7ad45bb",
      "withdrawal_address": "0xE40F80618324C814cD444434670a44ba4583aE38",
      "status": "active_ongoing",
      "withdrawal_credentials": "0x010000000000000000000000fc438e6cc4b230eb5bfaae1337c3f5da2b9140f1",
      "fee_recipient_address": "0x781462762B706AA7c1DA71FBA1a545724928b81f",
      "net_fee_payout_address": "0x781462762B706AA7c1DA71FBA1a545724928b81f",
      "region": "ca-central-1",
      "deposit_data": {
        "amount": 32000000000,
        "signature": "0xaab7e3b41689fced6c3437a6bc5caf471ed319b94ad2642c47c5f641d5e3a046432171d47d48cd7a3e8a323939d4976c1315ad4dae134c421214673ddff9105ef1bb7f79c1babc6cd9c31428d5e44472164e9c9fccfd10fb9768c0855b194f49",
        "figment_signature": "0xZDFlZjhkNDY4ZWY1M2Q4MjM2OGQyMDI2ZTMyMWFiMmM2ZDQ0ZjQ0YzMzYjdiOWYyMjM2OWJmNmRjZjM3ZmIwMjA4ZjgyZGQ2YjQ4NTMyNWNlMWJiZjVhZWM3YWQ0NWJi",
        "deposit_data_root": "b2f5083221d6b61f2237af155c07c746f6a75c7d24dfe418106efdf87e9b9422",
        "deposit_message_root": "026cbefa013e03a3d81592b7a5f6205773c12a6f7674529e497e9a4eb2df2d44",
        "fork_version": "0x00000000",
        "deposit_cli_version": "1.2.0"
      },
      "status_history": {
        "events": [
          [
            {
              "status": "provisioned",
              "changed_at": "2023-07-01T00:00:00.000Z"
            },
            {
              "status": "funding_requested",
              "changed_at": "2023-07-01T00:00:00.000Z"
            }
          ]
        ]
      }
    }
  ]
}
```

--------------------------------

### Generate Cardano VkeyWitness with Slate

Source: https://docs.figment.io/docs/signing-transactions-with-the-fireblocks-api

This JavaScript snippet demonstrates how to use the `@figmentio/slate` package to create a Cardano VkeyWitness from a `fullSig` and `publicKey` obtained from Fireblocks.

```JavaScript
const slate = require("@figmentio/slate");

const witness = await slate.cardanoWitness("<fullSig>", "<publicKey>");
```

--------------------------------

### Get DOT Reward Rates (JSON Response)

Source: https://docs.figment.io/reference/polkadot-rewards-rates

This is an example JSON response from the Figment API for the DOT reward rates endpoint. It contains an array of objects, where each object includes the date and the corresponding staking reward rate value in percentage.

```JSON
{
  "data": [
    {
      "date": "2023-08-29",
      "value": "10.26"
    },
    {
      "date": "2023-08-28",
      "value": "10.37"
    },
    {
      "date": "2023-08-27",
      "value": "10.37"
    },
    {
      "date": "2023-08-26",
      "value": "10.37"
    },
    {
      "date": "2023-08-25",
      "value": "10.26"
    },
    {
      "date": "2023-08-24",
      "value": "10.26"
    }
  ]
}
```

--------------------------------

### Stake SOL From Hot Wallet - JavaScript

Source: https://docs.figment.io/recipes/stake-eth-from-hot-wallet-1

This snippet demonstrates how to stake SOL from a hot wallet using JavaScript. It utilizes the Figment API to create an unsigned transaction, which is then signed and broadcast. Dependencies include 'dotenv', 'bs58', 'axios', and '@solana/web3.js'.

```javascript
require('dotenv').config();
const bs58 = require('bs58');
const axios = require('axios');
const { 
  Keypair, 
  PublicKey,
  Transaction
} = require('@solana/web3.js');

const API_HEADERS = {
  'x-api-key': process.env.API_KEY
};
const NETWORK = 'devnet';
const EXPLORER_BASE_URL = 'https://explorer.solana.com/tx/';
const FIGMENT_API_URL = 'https://api.figment.io/solana';
const STAKE_AMOUNT = 0.01;
const VALIDATOR_VOTE_ACCOUNT = '21Jxcw74j5SvajRKE3PvNifu26CVorF7DF8HyanKNzZ3';

async function createStakeTransaction(wallet, validatorVoteAccount) {
  const response = await axios.post(`${FIGMENT_API_URL}/stake`, {
    funding_account: wallet.publicKey.toString(),
    vote_account: validatorVoteAccount.toString(),
    amount_sol: STAKE_AMOUNT,
    network: NETWORK
  }, { headers: API_HEADERS });
  return response.data;
}
```

--------------------------------

### Staking Flow Response Example (JSON)

Source: https://docs.figment.io/reference/undelegate-atom

This JSON object represents a completed staking flow, detailing the flow's ID, operation type (staking), current state (completed), and associated transaction data. It includes information about the delegator, validator, amount, and transaction details like raw data, signatures, and block time.

```JSON
{
  "id": "1d823c7f-be8a-430e-85cf-7269206cd867",
  "operation": "staking",
  "state": "completed",
  "actions": [],
  "data": {
    "delegator_address": "cosmos1u85upk2v7pr65g0wv2976zleu6v8qjl9qprvzl",
    "validator_address": "cosmosvaloper1tflk30mq5vgqjdly92kkhhq3raev2hnz6eete3",
    "amount": "2.0",
    "memo": "",
    "gas_price": null,
    "gas_limit": null,
    "delegate_transaction": {
      "raw": "7b226d65737361676573223a5b7b227479706555726c223a222f636f736d6f732e7374616b696e672e763162657461312e4d736744656c6567617465222c2276616c7565223a7b2264656c656761746f7241646472657373223a22636f736d6f733175383575706b3276377072363567307776323937367a6c6575367638716a6c39717072767a6c222c2276616c696461746f7241646472657373223a22636f736d6f7376616c6f7065723174666c6b33306d71357667716a646c7939326b6b686871337261657632686e7a366565746533222c22616d6f756e74223a7b2264656e6f6d223a227561746f6d222c22616d6f756e74223a2232303030303030227d7d7d5d2c22666565223a7b22616d6f756e74223a5b7b22616d6f756e74223a2235313037222c2264656e6f6d223a227561746f6d227d5d2c22676173223a22323034323434227d2c226d656d6f223a22227d",
      "signing_payload": "31a9a1e09389b219435eaf2b0dcbab6a1d6950d95545564be627f86c7dfed956",
      "signed": "0aa1010a9e010a232f636f736d6f732e7374616b696e672e763162657461312e4d736744656c656761746512770a2d636f736d6f733175383575706b3276377072363567307776323937367a6c6575367638716a6c39717072767a6c1234636f736d6f7376616c6f7065723174666c6b33306d71357667716a646c7939326b6b686871337261657632686e7a3665657465331a100a057561746f6d12073230303030303012670a500a460a1f2f636f736d6f732e63727970746f2e736563703235366b312e5075624b657912230a2102db33d72ee215f1a61e5f4ffa098b9325cc1da6f5c3557974ad0f21a5ec9fe23512040a020801180612130a0d0a057561746f6d12043531303710d4bb0c1a4024d0155b8cf9f5fcacb15859b51fc1d895979fce08043362edacd7763e9b85a84c7e98b7390d3279e6b8d6629f60d67a1e6ae751a3ab9158a5350188aafd1166",
      "hash": "09F1F2740CA9265E066299DBCB46DB6AF1A1DAB9CF0764499CFD5D421BB045BA",
      "status": "confirmed",
      "error": null,
      "signatures": [
        {
          "account_address": "cosmos1u85upk2v7pr65g0wv2976zleu6v8qjl9qprvzl",
          "signature": ""
        }
      ],
      "block_time": "2023-02-28T10:51:19.797Z"
    },
    "pubkey": "02db33d72ee215f1a61e5f4ffa098b9325cc1da6f5c3557974ad0f21a5ec9fe235"
  },
  "protocol": "cosmos",
  "network": "testnet",
  "created_at": "2023-02-28T10:45:13.156Z",
  "updated_at": "2023-02-28T10:51:34.001Z"
}
```

--------------------------------

### Get Sui Stakes (cURL)

Source: https://docs.figment.io/reference/sui-get-stakes

This snippet demonstrates how to make a GET request to the Figment API to retrieve Sui stakes. It includes essential headers like 'accept' and 'x-api-key', and specifies the network and delegator address as query parameters.

```Shell
curl --request GET \
     --url 'https://api.figment.io/sui/stakes?network=testnet' \
     --header 'accept: application/json' \
     --header 'x-api-key: your-api-key-here'
```

--------------------------------

### Fetch Rewards Data (Onchain Billing)

Source: https://docs.figment.io/docs/eth-omnibus-staking

Fetches net Execution Layer (EL) and Consensus Layer (CL) rewards for the omnibus wallet when using the Figment Onchain Billing product. Requires specifying start and end dates.

```HTTP
POST /ethereum/rewards_net
```
Tokens:
Raw