SolanaFM API

https://docs.solana.fm/reference/solanafm-api-overview
Admin
The SolanaFM API provides a suite of RESTful endpoints and Websockets for developers to conveniently...
Tokens:15,803
Snippets:73
Trust Score:9.6
Update:1 year ago
Show doc for...
Tokens:
Raw
### Example Valid Response for Multiple Tokens API

Source: https://docs.solana.fm/reference/solanafm-api-overview/reference/get_tokens_by_account_hashes

An example JSON response demonstrating the successful retrieval of multiple token details, including token hash, name, symbol, decimals, and other metadata.

```JSON
{
  "status": "Success",
  "message": "Retrieved tokens' info",
  "result": [
    {
      "tokenHash": "EPjFWdd5AufqSSqeM2qN1xzybapC8G4wEGGkZwyTDt1v",
      "data": {
        "mint": "EPjFWdd5AufqSSqeM2qN1xzybapC8G4wEGGkZwyTDt1v",
        "tokenName": "USD Coin",
        "symbol": "USDC",
        "decimals": 6,
        "description": "",
        "logo": "https://s3.coinmarketcap.com/static-gravity/image/5a8229787b5e4c809b5914eef709b59a.png",
        "tags": [
          "stablecoin",
          "saber-mkt-usd"
        ],
        "verified": "true",
        "network": [
          "mainnet"
        ],
        "metadataToken": ""
      }
    }
  ]
}
```

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

### Example Valid Token Info API Response

Source: https://docs.solana.fm/reference/solanafm-api-overview/reference/get_token_by_account_hash

An example JSON object demonstrating a successful response from the Token Info endpoint, showing detailed information for the USDC token.

```JSON
{
  "status": "Success",
  "message": "Retrieved Token Info from Token Hash",
  "result": {
    "tokenHash": "EPjFWdd5AufqSSqeM2qN1xzybapC8G4wEGGkZwyTDt1v",
    "data": {
      "mint": "EPjFWdd5AufqSSqeM2qN1xzybapC8G4wEGGkZwyTDt1v",
      "tokenName": "USD Coin",
      "symbol": "USDC",
      "decimals": 6,
      "description": "",
      "logo": "https://s3.coinmarketcap.com/static-gravity/image/5a8229787b5e4c809b5914eef709b59a.png",
      "tags": [
        "stablecoin",
        "saber-mkt-usd"
      ],
      "verified": "true",
      "network": [
        "mainnet"
      ],
      "metadataToken": ""
    }
  }
}
```

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

### Example JSON for Valid SolanaFM API Response

Source: https://docs.solana.fm/reference/solanafm-api-overview/reference/post_transfers

Provides a concrete JSON example demonstrating the structure and typical data returned for a successful SolanaFM API transaction query.

```json
{
  "status": "success",
  "message": "Retrieved Transactions Info",
  "result": [
    {
      "transactionHash": "4wGMriaRA55F1opEhJW2is34aDQdJHE13vJCbqP6WzrnzFwThnvZYvRZ2AKc2Meh5JToETz3eCCeuavepz6iTPZx",
      "data": [
        {
          "instructionIndex": -1,
          "innerInstructionIndex": -1,
          "action": "pay_tx_fees",
          "status": "Successful",
          "source": "4cKNZSta5KhUGwVVWgyr1uhnzioNDdV1bNkhmfDbtVPJ",
          "sourceAssociation": null,
          "destination": null,
          "destinationAssociation": null,
          "token": "",
          "amount": 6600,
          "timestamp": 1685094373
        }
      ]
    },
    {
      "transactionHash": "FUCoNwzCfPugjBwR4Q2uzDMZJdA3E5GAqDB1HGgfi3cTPyqBk11HniqQCGSCin3oBGQLFwcQ3fEHdsEJbgaZZ5p",
      "data": [
        {
          "instructionIndex": -1,
          "innerInstructionIndex": -1,
          "action": "pay_tx_fees",
          "status": "Successful",
          "source": "4cKNZSta5KhUGwVVWgyr1uhnzioNDdV1bNkhmfDbtVPJ",
          "sourceAssociation": null,
          "destination": null,
          "destinationAssociation": null,
          "token": "",
          "amount": 6600,
          "timestamp": 1685094468
        }
      ]
    }
  ]
}
```

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

### Example Valid Response for Account Favourite Domain

Source: https://docs.solana.fm/reference/solanafm-api-overview/reference/get_favourite_domains_by_multiple_accounts

An example JSON object demonstrating a successful response from the Account Favourite Domain API endpoint, showing the structure of returned favourite domain information for multiple accounts.

```JSON
{
  "status": "Success",
  "message": "Retrived favourite domains of multiple accounts!",
  "result": [
    {
      "owner": "6PzyBQbt3F8aRRAEohn3usYtdTx6nQAVwiFUHVtC7giW",
      "name": "impuesto",
      "nameServiceAccount": "6PzyBQbt3F8aRRAEohn3usYtdTx6nQAVwiFUHVtC7giW"
    }
  ]
}
```

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

### Example of SolanaFM API Valid Response

Source: https://docs.solana.fm/reference/solanafm-api-overview/reference/get_multiple_domains_and_subdomains_by_hash

An example JSON payload representing a successful response from the SolanaFM API, showing multiple account hashes, their owners, and associated domains with subdomains.

```JSON
{
    "status": "Success",
    "message": "Retrieved domains of multiple accounts!",
    "result": {
        "FqpGhutsofxy18h6p9Kgcb83teJRqQ8dm3NksTRaCTaE": {
            "owner": "FqpGhutsofxy18h6p9Kgcb83teJRqQ8dm3NksTRaCTaE",
            "domains": [
                {
                    "name": "pantat",
                    "nameServiceAccount": "2NnYUke3LypC4pxPWabGevfqks9pmuoNJUd7qAM8o2zE",
                    "subdomains": [
                        {
                            "name": "luwan",
                            "subdomainHash": "DBaTD8519HCYhMfj7f6T8NmGYssTdrNAVyN79qYvnJB6"
                        }
                    ]
                }
            ]
        },
        "AK2VbkdYLHSiJKS6AGUfNZYNaejABkV6VYDX1Vrgxfo": {
            "owner": "AK2VbkdYLHSiJKS6AGUfNZYNaejABkV6VYDX1Vrgxfo",
            "domains": [
                {
                    "name": "ki-v3",
                    "nameServiceAccount": "27iFoLqcBUjKSMtydrQESqY2HNaVW2xqMsb95KwkUsUm",
                    "subdomains": []
                },
                {
                    "name": "ki-v2",
                    "nameServiceAccount": "BjYUGWR9dS9hWkC3T341LpkiFy9pUJu31asWiT3JeeQ8",
                    "subdomains": [
                        {
                            "name": "test",
                            "subdomainHash": "48BgCnYTRcN5aQoEz2Khte7FjDGyYutYF1yThbE9WBei"
                        }
                    ]
                }
            ]
        },
        "nix9RErnQYXpuf329ntPgSzThogtfeyUempD7zDrnSH": {
            "owner": "nix9RErnQYXpuf329ntPgSzThogtfeyUempD7zDrnSH",
            "domains": [
                {
                    "name": "nixholas",
                    "nameServiceAccount": "3krJN4n3cWZktUBbpm5KjdhHSEMfgvzSPLsKeeC9o2Xh",
                    "subdomains": []
                }
            ]
        }
    }
}
```

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

### Account Subdomains API Response Structure and Example

Source: https://docs.solana.fm/reference/solanafm-api-overview/reference/get_subdomains_by_account

Illustrates the expected JSON response structure for the 'Get An Account's Subdomains' API endpoint, including the 'owner' and 'subdomains' fields, and provides a concrete example of a successful response payload.

```APIDOC
Valid Response:
<object> - a JSON object containing the following fields:
- `owner`: <String>
  Description: The subdomain owner's account hash.
- `subdomains`: [<object>]
  Description: A list of subdomains owned by an account, each containing:
    - `name`: <String>
      Description: The name of the subdomain.
    - `subdomainHash`: <String>
      Description: The account hash for the subdomain.
```

```JSON
{
  "status": "Success",
  "message": "Retrieved Account's Sub Domains",
  "result": {
    "owner": "AWtw4WVrDpyQEf1e8upxh47Aot5pECtAppeAWiajK6nW",
    "subdomains": [
      {
        "name": "scams",
        "subdomainHash": "2Tkx4fck2MqRWiWmdZdnP97iTHcByU4934hQbkNhKUkd"
      },
      {
        "name": "tokens",
        "subdomainHash": "4fsGxgYqboEppzz2gPPvDSJKwzy8w7kz7Gdfqpumd6Zf"
      },
      {
        "name": "rugs",
        "subdomainHash": "B3LgYWC8VcnAdCEy86owzoS5LLahVR9ffKBXEXe2sPFU"
      },
      {
        "name": "earners",
        "subdomainHash": "TMn55Tvssy5U2poEkSAthfhJaBSqwqcS5eg1B6G3oYT"
      },
      {
        "name": "bank",
        "subdomainHash": "2TprTY5h6j3bPyN4TuMnNBMAveufGBPFBvZY2dCCwuJ4"
      },
      {
        "name": "nfts",
        "subdomainHash": "FaAJVhs1tCYNWZUVMSi72ps6Wpy8YqpnQwWz9xwVXuiK"
      },
      {
        "name": "nft",
        "subdomainHash": "4YKiL2rXiDFp4cwcKAp19uTvtsmLSbBYGrJ8Fu2KfCqv"
      },
      {
        "name": "forty",
        "subdomainHash": "5UF5R5J2gMEYXdG5cgP1ZGowM2EUgY5nCv8JAd8ftrT2"
      }
    ]
  }
}
```

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

### Example Valid Response for Account Domains API

Source: https://docs.solana.fm/reference/solanafm-api-overview/reference/get_domains_and_subdomains_by_hash

Provides a concrete example of a successful JSON response from the 'Specific Account's Domains' API endpoint, illustrating the data structure for an account's owner, domains, and associated subdomains.

```JSON
{
  "status": "Success",
  "message": "Retrieved Account's Domains",
  "result": [
    {
      "owner": "nix9RErnQYXpuf329ntPgSzThogtfeyUempD7zDrnSH",
      "domains": [
        {
          "name": "nixholas",
          "nameServiceAccount": "3krJN4n3cWZktUBbpm5KjdhHSEMfgvzSPLsKeeC9o2Xh",
          "subdomains": []
        }
      ]
    }
  ]
}
```

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

### Example JSON Response for SolanaFM Token Info V1 API

Source: https://docs.solana.fm/reference/solanafm-api-overview/reference/get_one_token

Illustrates a typical successful JSON response from the SolanaFM Token Info V1 API. This example shows the structure and data types for a token's mint, decimals, authorities, type, and associated token list information, providing a concrete representation of the API's output.

```JSON
{
  "mint": "BaconSBRjNckjeQCi6E2Ndg8wSmAwPgmfmZnF6ZmyFhz",
  "decimals": 6,
  "freezeAuthority": "7vxDmRAWmK16x8szwtkQQXSV7hvvwm6jVsuHqceFv4JE",
  "mintAuthority": "7vxDmRAWmK16x8szwtkQQXSV7hvvwm6jVsuHqceFv4JE",
  "tokenType": "Legacy",
  "tokenList": {
    "name": "Bacon SBR (sunSBR Token of Appreciation)",
    "symbol": "baconSBR",
    "image": "https://raw.githubusercontent.com/solana-labs/token-list/main/assets/mainnet/BaconSBRjNckjeQCi6E2Ndg8wSmAwPgmfmZnF6ZmyFhz/logo.svg",
    "extensions": null,
    "chainId": 101
  }
}
```

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

### Example of a Valid Solana FM API Response

Source: https://docs.solana.fm/reference/solanafm-api-overview/reference/retrieve_multiple_tokens

Illustrates the structure of a successful response from the Solana FM API, showing details for multiple token mints including their properties and associated token list/metadata.

```JSON
{
  "BaconSBRjNckjeQCi6E2Ndg8wSmAwPgmfmZnF6ZmyFhz": {
    "mint": "BaconSBRjNckjeQCi6E2Ndg8wSmAwPgmfmZnF6ZmyFhz",
    "decimals": 6,
    "freezeAuthority": "7vxDmRAWmK16x8szwtkQQXSV7hvvwm6jVsuHqceFv4JE",
    "mintAuthority": "7vxDmRAWmK16x8szwtkQQXSV7hvvwm6jVsuHqceFv4JE",
    "tokenType": "Legacy",
    "tokenList": {
      "name": "Bacon SBR (sunSBR Token of Appreciation)",
      "symbol": "baconSBR",
      "image": "https://raw.githubusercontent.com/solana-labs/token-list/main/assets/mainnet/BaconSBRjNckjeQCi6E2Ndg8wSmAwPgmfmZnF6ZmyFhz/logo.svg",
      "extensions": null,
      "chainId": 101
    }
  },
  "EPjFWdd5AufqSSqeM2qN1xzybapC8G4wEGGkZwyTDt1v": {
    "mint": "EPjFWdd5AufqSSqeM2qN1xzybapC8G4wEGGkZwyTDt1v",
    "decimals": 6,
    "freezeAuthority": "3sNBr7kMccME5D55xNgsmYpZnzPgP2g12CixAajXypn6",
    "mintAuthority": "2wmVCSfPxGPjrnMMn7rchp4uaeoTqN39mXFC2zhPdri9",
    "tokenType": "Legacy",
    "tokenList": {
      "name": "USD Coin",
      "symbol": "USDC",
      "image": "https://raw.githubusercontent.com/solana-labs/token-list/main/assets/mainnet/EPjFWdd5AufqSSqeM2qN1xzybapC8G4wEGGkZwyTDt1v/logo.png",
      "extensions": {
        "coingeckoId": "usd-coin"
      },
      "chainId": 101
    },
    "tokenMetadata": {
      "onChainInfo": {
        "name": "USD Coin",
        "symbol": "USDC",
        "metadata": "5x38Kp4hvdomTCnCrAny4UtMUt5rQBdB6px2K1Ui45Wq",
        "updateAuthority": "2wmVCSfPxGPjrnMMn7rchp4uaeoTqN39mXFC2zhPdri9",
        "isMasterEdition": null,
        "edition": null,
        "uri": "",
        "sellerFeeBasisPoints": 0,
        "primarySaleHappened": false,
        "isMutable": true,
        "creators": [],
        "ruleSet": null,
        "collection": null,
        "collectionDetails": null,
        "uses": null
      },
      "offChainInfo": null
    }
  }
}
```

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

### Example of Valid Response for All Transfer Actions

Source: https://docs.solana.fm/reference/solanafm-api-overview/reference/get_actions

This code snippet provides an example of a successful response from the 'All Transfer Actions' endpoint. It shows a JSON array containing strings, where each string identifies a possible transfer action recognized by the SolanaFM API.

```JSON
[
  "createAccount",
  "assign",
  "transfer",
  "createAccountWithSeed",
  "advanceNonceAccount",
  "withdrawNonceAccount",
  "initializeNonceAccount",
  "authorizeNonceAccount",
  "allocate",
  "allocateWithSeed",
  "assignWithSeed",
  "transferWithSeed",
  "upgradedNonceAccount",
  "purgeAccount",
  "unknownTransfer",
  "initializeMint",
  "initializeAccount",
  "initializeMultisig",
  "transfer",
  "approve",
  "revoke",
  "setAuthority",
  "mintTo",
  "burn",
  "closeAccount",
  "freezeAccount",
  "thawAccount",
  "transferChecked",
  "approveChecked",
  "mintToChecked",
  "burnChecked",
  "initializeAccount2",
  "syncNative",
  "initializeAccount3",
  "initializeMultisig2",
  "initializeMint2",
  "getAccountDataSize",
  "initializeImmutableOwner",
  "amountToUiAmount",
  "uiAmountToAmount",
  "payTxFees",
  "transferCheckedWithFee",
  "withdrawWithheldTokensFromMint",
  "withdrawWithheldTokensFromAccounts",
  "harvestWithheldTokensToMint"
]
```

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

### SolanaFM API: Get Blocks Endpoint Documentation

Source: https://docs.solana.fm/reference/solanafm-api-overview/reference/get_blocks_by_pagination

Documentation for the SolanaFM 'Get Blocks' API endpoint, which retrieves a paginated list of blocks. It details the HTTP method, URL, query parameters, and the structure of the successful response, including nested data fields.

```APIDOC
Endpoint: GET https://api.solana.fm/v0/blocks
Description: This endpoint returns you a paginated list of blocks

Parameters:
  - from (optional): The pagination cursor for the next/previous page
  - pageSize (optional): Defines the number of results to be returned in a single page. Default is set to 50
  - paginationType (optional): Set the field to paginate by. Accepts either 'blockNumber' or 'blockTime'
  - reverse (optional): A boolean field to allow paginating through the results in either descending or ascending order

Results (Valid Response):
  Type: Array of JSON objects
  Each Object Fields:
    - blockNumber (integer): Block number of a given block
    - data (object): A JSON object containing the following fields:
      - epoch (integer): Epoch number that the block is produced
      - previousHash (string): The previous block hash
      - producer (string): The block producer address of this stated block
      - hash (string): The block hash of this stated block
      - parentNumber (integer): The parent block number
      - number (integer): The stated block's block number
      - dataSize (integer): The data size
      - numberOfTransactions (integer): Number of transactions within this block
      - successfulTransactions (integer): Number of successful transactions
      - voteTransactions (integer): Number of vote transactions
      - totalTxFees (number): Total transaction fees incurred within this block
      - numberOfRewards (integer): Number of rewards issued for producing this block
      - totalRewardAmount (number): The total rewarded amount
      - totalComputeUnitsConsumed (number): Compute units consumed for producing this block
      - totalComputeUnitsLimit (number): Compute units upper bound limit
      - blockTime (integer): Block time of this stated block (Unix timestamp)
```

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

### Example JSON Response for Transfer Transactions API

Source: https://docs.solana.fm/reference/solanafm-api-overview/reference/get_transfers

An example of a successful JSON response from the SolanaFM 'Transfer Transactions' API. This snippet illustrates the typical data structure and values returned for a single transfer movement, including transaction details and transfer specifics.

```JSON
{
  "status": "success",
  "message": "Retrieved Transactions Info",
  "result": {
    "transactionHash": "FUCoNwzCfPugjBwR4Q2uzDMZJdA3E5GAqDB1HGgfi3cTPyqBk11HniqQCGSCin3oBGQLFwcQ3fEHdsEJbgaZZ5p",
    "data": [
      {
        "instructionIndex": -1,
        "innerInstructionIndex": -1,
        "action": "pay_tx_fees",
        "status": "Successful",
        "source": "4cKNZSta5KhUGwVVWgyr1uhnzioNDdV1bNkhmfDbtVPJ",
        "sourceAssociation": null,
        "destination": null,
        "destinationAssociation": null,
        "token": "",
        "amount": 6600,
        "timestamp": 1685094468
      }
    ]
  }
}
```

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

### Example Valid Response for On-Chain Token Data API

Source: https://docs.solana.fm/reference/solanafm-api-overview/reference/get_tfi_token_data

Illustrates a successful JSON response from the On-Chain Token Data API, showing the structure of token information including decimals, extensions, authorities, and supply.

```JSON
{
    "id": "7atgF8KQo4wJrD5ATGX7t1V2zVvykPJbFfNeVf1icFv1",
    "info": {
        "decimals": 2,
        "extensions": [
            {
                "extension": "transferFeeConfig",
                "state": {
                    "newerTransferFee": {
                        "epoch": 551,
                        "maximumFee": 99999999999999904,
                        "transferFeeBasisPoints": 400
                    },
                    "olderTransferFee": {
                        "epoch": 551,
                        "maximumFee": 99999999999999904,
                        "transferFeeBasisPoints": 400
                    },
                    "transferFeeConfigAuthority": null,
                    "withdrawWithheldAuthority": null,
                    "withheldAmount": 46075413667825141
                }
            }
        ],
        "freezeAuthority": null,
        "isInitialized": true,
        "mintAuthority": null,
        "supply": "99995300644040582"
    },
    "slot": 261024648,
    "type": null
}
```

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

### SolanaFM Get Multiple Blocks API Definition

Source: https://docs.solana.fm/reference/solanafm-api-overview/reference/get_multiple_blocks

Defines the 'Get Multiple Blocks' API endpoint, including its HTTP method, URL, input parameters (blockNumbers and hydration options), and the detailed structure of the expected JSON response object.

```APIDOC
Endpoint: post https://api.solana.fm/v0/blocks

Description: This endpoint returns you a list of blocks based on the input block numbers with the ability to customise the query.

Parameters:
- blockNumbers (array of integers): A list of integer denoting the target block numbers.
- hydration (object): A JSON object which has a field to populate the block producer's account info inside the response.
  - accountHash (boolean): The boolean field to indicate whether hydration for block producer's account info is required.

Results:
Valid Response: [<object>] - an array of JSON objects containing the following fields:
- blockNumber (integer)
- data (object)
  - epoch (integer)
  - previousHash (string)
  - producer (object)
    - accountHash (string)
    - data (object)
      - friendlyName (string)
      - abbreviation (string)
      - category (string)
      - voteKey (string)
      - network (string)
      - tags (array)
      - logoURI (string, nullable)
      - flag (string, nullable)
  - hash (string)
  - parentNumber (integer)
  - number (integer)
  - dataSize (integer)
  - numberOfTransactions (integer)
  - successfulTransactions (integer)
  - voteTransactions (integer)
  - totalTxFees (integer)
  - numberOfRewards (integer)
  - totalRewardAmount (integer)
  - totalComputeUnitsConsumed (integer)
  - totalComputeUnitsLimit (integer)
  - blockTime (integer)
```

```JSON
{
  "status": "Success",
  "message": "Retrieved Blocks",
  "result": [
    {
      "blockNumber": 180000000,
      "data": {
        "epoch": 416,
        "previousHash": "EzGV2xgnkZkpZBDNVHMGUaKj21WnNp17gPEbGAap337N",
        "producer": {
          "accountHash": "2nDgb2py4cjHy8dxWGPUUR5641SSHCBEjnGGcuyqCKCh",
          "data": {
            "friendlyName": "5oMEJuodtg8tY7gQX3MHzGgwb242gjpxuVdnT71GD4uT",
            "abbreviation": "",
            "category": "validators",
            "voteKey": "5oMEJuodtg8tY7gQX3MHzGgwb242gjpxuVdnT71GD4uT",
            "network": "mainnet",
            "tags": [],
            "logoURI": null,
            "flag": null
          }
        },
        "hash": "64KQRzxhxuTYHXJ9dESLU178wQ9yh3co7hckYGDSEmcj",
        "parentNumber": 179999999,
        "number": 180000000,
        "dataSize": 0,
        "numberOfTransactions": 4287,
        "successfulTransactions": 3777,
        "voteTransactions": 4158,
        "totalTxFees": 21595928,
        "numberOfRewards": 1,
        "totalRewardAmount": 10797964,
        "totalComputeUnitsConsumed": 19461081,
        "totalComputeUnitsLimit": 178002687,
        "blockTime": 1677596860
      }
    }
  ]
}
```

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

### Example Valid Response for Token Supply API

Source: https://docs.solana.fm/reference/solanafm-api-overview/reference/get_token_circulating_supply

This JSON object illustrates a successful response from the Token Supply API, showing typical values for circulating supply, various withheld amounts, real circulating supply, and the token's decimal places.

```json
{
  "circulatingSupply": 99995300644040580,
  "tokenWithheldAmount": 46075414699976650,
  "userTotalWithheldAmount": 50226562768892200,
  "totalWithheldAmount": 96301977468868850,
  "realCirculatingSupply": 3693323175171728,
  "decimals": 2
}
```

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

### Retrieve Account Subdomains API Endpoint

Source: https://docs.solana.fm/reference/solanafm-api-overview/reference/get_subdomains_by_account

Documents the HTTP GET endpoint for fetching subdomains associated with a specific Solana account hash, detailing the URL path and the required 'hash' parameter.

```APIDOC
GET https://api.solana.fm/v0/domains/bonfida/subdomains/{hash}

Parameters:
- `hash`: <String> (Required)
  Description: The subdomain owner's account hash to query for.
```

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

### SolanaFM API: Get A Specific Block Endpoint Details

Source: https://docs.solana.fm/reference/solanafm-api-overview/reference/get_block

Comprehensive documentation for the SolanaFM API endpoint to retrieve detailed information for a specific Solana block. It includes the HTTP method, URL structure, required parameters, and the expected structure of both valid and invalid responses.

```APIDOC
GET https://api.solana.fm/v0/blocks/{block_number}

Parameters:
  block_number: integer (slot), The target block number.

Description:
  This endpoint returns information about a Solana block given its block number.
```

```APIDOC
Valid Response:
  <object> - a JSON object containing the following fields:
    status: "Success"
    message: "Retrieved Block"
    result: <object> - Contains block details.

Example of a valid response:
```

```JSON
{
  "status": "Success",
  "message": "Retrieved Block",
  "result": {
    "blockNumber": 200000000,
    "data": {
      "epoch": 462,
      "previousHash": "6pVPHuTPZxwFueNHyFQGtb1vzj8czCDuJPPH8VvFpyMc",
      "producer": "RBFiUqjYuy4mupzZaU96ctXJBy23sRBRsL3KivDAsFM",
      "hash": "bYJHNf3HevTfeX2EDCoHNCs3zedpdsTYAF8g3s1yuxZ",
      "parentNumber": 199999999,
      "number": 200000000,
      "dataSize": 0,
      "numberOfTransactions": 3769,
      "successfulTransactions": 3510,
      "voteTransactions": 3744,
      "totalTxFees": 18867575,
      "numberOfRewards": 473,
      "totalRewardAmount": 9437447,
      "totalComputeUnitsConsumed": 1776690,
      "totalComputeUnitsLimit": 38829586,
      "blockTime": 1686964563
    }
  }
}
```

```APIDOC
Invalid Response:
  <object> - a JSON object containing the following fields if the requested account doesn't exist
    code: <integer>, The error code
    message: <String>, An error message to indicate which part of the query went wrong
    status: <String>, The response status following the error code
      400 = Bad Request (client side)
      500 = Internal Server Error (server side)
```

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

### Example Valid JSON Response for User's Token Accounts

Source: https://docs.solana.fm/reference/solanafm-api-overview/reference/get_user_token_accounts

An illustrative JSON object demonstrating the expected data structure for a successful response from the SolanaFM API's 'User's Token Accounts' endpoint, showcasing two sample token account entries with their detailed information.

```JSON
{
    "tokenAccounts": [
        {
            "_id": "4y91Zqoqqp9vePUb1YbqFCP79SXQoBbmnUL9nmfGg1yB",
            "info": {
                "isNative": false,
                "mint": "2emYMetySwE7Xh6qrG1AwAQ3TDvrLkUSpSZ5AjcWCc7B",
                "owner": "nix9RErnQYXpuf329ntPgSzThogtfeyUempD7zDrnSH",
                "state": "initialized",
                "tokenAmount": {
                    "amount": "1000000",
                    "decimals": 6,
                    "uiAmount": 1.0,
                    "uiAmountString": "1"
                }
            },
            "slot": 259299487
        },
        {
            "_id": "5DTsxz9qdn7wLKSwmTsev2RoiNH6HUCBJ9gnNA5Dvpfn",
            "info": {
                "isNative": false,
                "mint": "H4cyrtm9ba6htpYnF33ZTjw1vn34cZTZTkHM1pTXfM4N",
                "owner": "nix9RErnQYXpuf329ntPgSzThogtfeyUempD7zDrnSH",
                "state": "initialized",
                "tokenAmount": {
                    "amount": "0",
                    "decimals": 0,
                    "uiAmount": 0.0,
                    "uiAmountString": "0"
                }
            },
            "slot": 259305680
        }
    ]
}
```

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

### Solana Daily Transaction Fees API Endpoint Details

Source: https://docs.solana.fm/reference/solanafm-api-overview/reference/get_daily_tx_fees

Details the GET endpoint for retrieving Solana daily transaction fees, including its URL, purpose, optional date parameter, and the structure of both valid and invalid responses.

```APIDOC
GET https://api.solana.fm/v0/stats/tx-fees

Description: This endpoint returns the total transaction fees in lamports for the specified date. If no date is specified, it will be defaulted to today's date.

Parameters:
  date: (optional) string, format dd-mm-yyyy
```

```APIDOC
Valid Response Structure:
  <object> - a JSON object containing the following fields:
    date: <String>, the date in string
    totalTxFees: <integer>, the amount of total transaction fees accumulated
```

```json
{
  "status": "Success",
  "message": "Retrieved Transaction Fees Analytics Data",
  "result": {
    "date": "19-07-2022",
    "totalTxFees": 1249273441325
  }
}
```

```APIDOC
Invalid Response Structure:
  <object> - a JSON object containing the following fields if the requested account doesn't exist:
    code: <integer>, The error code
    message: <String>, An error message to indicate which part of the query went wrong
    status: <String>, The response status following the error code
      400 = Bad Request (client side)
      500 = Internal Server Error (server side)
```

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

### Get All Transfer Actions API Endpoint

Source: https://docs.solana.fm/reference/solanafm-api-overview/reference/get_actions

This snippet defines the HTTP method and URL for accessing the 'All Transfer Actions' endpoint of the SolanaFM API. This endpoint allows users to retrieve a list of all possible actions identified within the transfers model.

```APIDOC
get https://api.solana.fm/v1/actions
```

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

### Retrieve On-Chain Token Data API Endpoint

Source: https://docs.solana.fm/reference/solanafm-api-overview/reference/get_tfi_token_data

Defines the HTTP GET endpoint for retrieving on-chain token data for a specific mint address. This endpoint is currently in Beta and retrieves data from both on-chain and off-chain sources.

```APIDOC
GET https://api.solana.fm/v1/tokens/{mint}/info
```

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

### Get User's Favourite Domains API Endpoint Details

Source: https://docs.solana.fm/reference/solanafm-api-overview/reference/get_favourite_domains_by_account

This snippet details the SolanaFM API endpoint for retrieving favourite domains associated with a specific wallet hash. It outlines the request method, path parameters, and the structure of both successful and error responses.

```APIDOC
Endpoint: GET https://api.solana.fm/v0/domains/bonfida/favourites/{hash}
Description: This endpoint returns you a list of domains that are set as favourite by the account hash provided.

Parameters:
  - hash: The wallet hash to query for. (Type: Path Parameter)
```

```APIDOC
Valid Response:
  Type: Array of Objects ([<object>])
  Fields:
    - name: <String> - name of the favourite domain
    - nameServiceAccount: <String> - the service account hash for the domain
    - owner: <String> - the owner of the domain
    - favourite: <boolean> - indicates if the domain is set as favourite
```

```json
{
  "status": "Success",
  "message": "Retrieved account's favourite domains",
  "result": {
    "domains": [
      {
        "name": "ki-v3",
        "nameServiceAccount": "27iFoLqcBUjKSMtydrQESqY2HNaVW2xqMsb95KwkUsUm",
        "owner": "AK2VbkdYLHSiJKS6AGUfNZYNaejABkV6VYDX1Vrgxfo",
        "favourite": true
      }
    ]
  }
}
```

```APIDOC
Invalid Response:
  Type: Object (<object>)
  Fields:
    - code: <integer> - The error code
    - message: <String> - An error message to indicate which part of the query went wrong
    - status: <String> - The response status following the error code
      - 400: Bad Request (client side)
      - 500: Internal Server Error (server side)
```

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

### SolanaFM API: Get Transfer Transactions by Hash

Source: https://docs.solana.fm/reference/solanafm-api-overview/reference/get_transfers

Documents the GET endpoint for retrieving a list of transfer movements for a given transaction hash. This includes the endpoint URL, required parameters, and the detailed structure of the expected JSON response object, outlining all fields and their types.

```APIDOC
GET https://api.solana.fm/v0/transfers/{hash}

Parameters:
  hash: string - The transaction hash to query for

Valid Response:
  <object> - A JSON object containing the following fields:
    transactionHash: <String> - The transaction hash
    data: [<object>] - An array of transfer movements
      instructionIndex: <integer> - The parent instruction index of this movement
      innerInstructionIndex: <integer> - The inner instruction index of this movement, will be -1 if this movement is recorded in the parent instruction
      action: <String> - The transfers action identified
      status: <String> - The status of the transfer
      source: <String> - The source of the movement
      sourceAssociation: <String | null> - The source association account hash
      destination: <String | null> - The destination of the movement
      destinationAssociation: <String | null> - The destination association account hash
      token: <String> - The token hash of the token being transferred
      amount: <integer> - The amount being transferred
      timestamp: <integer> - The timestamp of this movement
```

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

### API Endpoint: Get Tagged Accounts - Multiple

Source: https://docs.solana.fm/reference/solanafm-api-overview/reference/get_multiple_accounts

This endpoint allows for the batch retrieval of accounts tagged by SolanaFM. It supports customization of the query. Note that this endpoint is deprecated and only returns information for accounts that have been tagged by SolanaFM; accounts without data fields are not tagged.

```APIDOC
Method: POST
URL: https://api.solana.fm/v0/accounts
Purpose: Get tagged accounts
Details: Supports batch retrieval of accounts with customizable queries.
Status: Deprecated
Notes: Returns account information tagged by SolanaFM. If an account has no data field, it is not tagged by SolanaFM.
```

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

### SolanaFM API Error Codes

Source: https://docs.solana.fm/reference/solanafm-api-overview/reference/solanafm-api-overview

This section details the conventional HTTP response codes used by SolanaFM APIs to indicate the success or failure of a request. It explains the meaning of 2xx, 4xx, and 5xx ranges, and provides specific examples of common error codes with their corresponding statuses and responses.

```APIDOC
SolanaFM API uses conventional HTTP response codes:

2xx range: Indicates success.
4xx range: Indicates client-side errors (e.g., missing parameters, data type mismatch).
5xx range: Indicates server-side errors (e.g., server downtime).

Specific 4xx errors may include a brief error message.

Status Codes:
- 200 OK: Returns the data in the response body.
- 400 Bad Request: Request parameter(s) provided is incorrectly formatted or not provided.
- 404 Not Found: The resource(s) requested is unavailable.
- 429 Too many Requests: Rate-limit has been exceeded.
- 500 Internal Server Error: The server encountered an unexpected error that prevented it from fulfilling the request.
```

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

### SolanaFM Token Info V1 API Endpoint Definition

Source: https://docs.solana.fm/reference/solanafm-api-overview/reference/get_one_token

Defines the HTTP GET endpoint for the SolanaFM Token Info V1 API. This endpoint allows users to query detailed information about a specific token by providing its unique hash. It outlines the required parameters and the structure of the successful response, including various token properties and data from the legacy token list.

```APIDOC
get https://api.solana.fm/v1/tokens/{hash}

This endpoint returns you information of a token by the given token hash

Parameters:
* `hash`: the token hash to query for

Results:
Valid Response:
<object> - a JSON object containing the following fields:
* `mint`: <String>, the token mint address
* `decimals`: <integer>, the number of decimal places for the token
* `freezeAuthority`: <String>, the freeze authority account hash
* `mintAuthority`: <String>, the mint authority account hash
* `tokenType`: <String>, the token type (e.g. Fungible, Legacy, NonFungible)
* `tokenList`: <object>, the token data retrieved from the legacy token list
  + `name`: <String>, token name
  + `symbol`: <String>, token symbol
  + `image`: <String>, image url link to the logo of the token
  + `extensions`: <String | null>, the token extensions
  + `chainId`: <integer>, the chain id for this token
```

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

### GET Transfers CSV Export API Endpoint

Source: https://docs.solana.fm/reference/solanafm-api-overview/reference/download_csv_v1

Documents the API endpoint for retrieving account transfer data in CSV format. This endpoint allows users to download a comprehensive list of transfers associated with a specific account hash.

```APIDOC
get https://api.solana.fm/v0/accounts/{hash}/transfers/csv
```

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

### Get Token Information by Hash (SolanaFM API)

Source: https://docs.solana.fm/reference/solanafm-api-overview/reference/get_token_by_account_hash

This API endpoint retrieves detailed information about a specific token on the Solana blockchain using its unique hash. It provides details such as token name, symbol, decimals, logo, and verification status, along with expected request and response structures.

```APIDOC
get https://api.solana.fm/v0/tokens/{hash}

Parameters:
- `hash`: <String> (required) - The token hash to query for.

Results:
Valid Response:
<object> - A JSON object containing the following fields:
- `tokenHash`: <String> - The token hash.
- `data`: <object> - The token data object that contains the following fields:
  - `mint`: <String>
  - `tokenName`: <String>
  - `symbol`: <String>
  - `decimals`: <Number>
  - `description`: <String>
  - `logo`: <String>
  - `tags`: <Array<String>>
  - `verified`: <String> ("true" or "false")
  - `network`: <Array<String>>
  - `metadataToken`: <String>

Invalid Response:
<object> - A JSON object containing the following fields if the requested account doesn't exist:
- `code`: <Integer> - The error code.
- `message`: <String> - An error message to indicate which part of the query went wrong.
- `status`: <String> - The response status following the error code.
  - 400 = Bad Request (client side)
  - 500 = Internal Server Error (server side)
```

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

### Get On-Chain Token Supply Information API

Source: https://docs.solana.fm/reference/solanafm-api-overview/reference/get_token_circulating_supply

This API endpoint retrieves on-chain token supply details for a given token mint. It provides various metrics such as circulating supply, withheld amounts, and real circulating supply, along with the token's decimal places. This endpoint is currently in Beta.

```APIDOC
API Endpoint: Token Supply
Method: GET
URL: https://api.solana.fm/v1/tokens/{mint}/supply
Description: This endpoint returns on-chain token supply information.
Status: Beta

Results:
  Valid Response:
    Type: object
    Fields:
      circulatingSupply: number | null (the on-chain circulating supply for the token)
      tokenWithheldAmount: number | null (the withheld amount for tokens creation with the tokenExtension Program)
      userTotalWithheldAmount: number | null (the total amount withheld in user's token accounts)
      totalWithheldAmount: number | null (the total withheld amount calculated based on (tokenWithheldAmount + userTotalWithheldAmount))
      realCirculatingSupply: number | null (the actual supply in circulation calculated based on (circulatingSupply - totalWithheldAmount))
      decimals: number | null (the number of decimal places for this token)

  Invalid Response:
    Type: object
    Fields:
      code: integer (The error code)
      message: String (An error message to indicate which part of the query went wrong)
      status: String (The response status following the error code)
        Possible Values:
          400: Bad Request (client side)
          500: Internal Server Error (server side)
```

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

### Retrieve Specific Account's Domains API Endpoint

Source: https://docs.solana.fm/reference/solanafm-api-overview/reference/get_domains_and_subdomains_by_hash

Documents the GET endpoint for retrieving all domains and subdomains associated with a given Solana account hash. It details the endpoint URL, required parameters, the structure of a valid successful response, and the format of an invalid response with error codes.

```APIDOC
Endpoint: GET https://api.solana.fm/v0/domains/bonfida/{hash}
Description: This endpoint retrieves all domains and subdomains owned by the provided account hash

Parameters:
- hash: <String> - The account hash that owns domain(s)/subdomain(s)

Results:
Valid Response: [<object>] - A list of JSON objects, each containing:
  - owner: <String> - The owner's account hash of the domain/subdomain
  - domains: [<object>] - A list of domain objects, each containing:
    - name: <String> - The name of the domain account
    - nameServiceAccount: <String> - The account hash of the domain
    - subdomains: [<object>] - A list of subdomains owned

Invalid Response: <object> - A JSON object containing the following fields if the requested account doesn't exist:
  - code: <integer> - The error code
  - message: <String> - An error message to indicate which part of the query went wrong
  - status: <String> - The response status following the error code
    - 400: Bad Request (client side)
    - 500: Internal Server Error (server side)
```

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

### Get a Tagged Account - SolanaFM API

Source: https://docs.solana.fm/reference/solanafm-api-overview/reference/get_account

Retrieves specific account data for a given account hash. This endpoint provides details such as friendly names, categories, network, and tags. Note that this endpoint is deprecated and returns SolanaFM-tagged information; if an account has no data field, it is not tagged by SolanaFM.

```APIDOC
Endpoint: GET https://api.solana.fm/v0/accounts/{hash}

Parameters:
  hash: string - The account/wallet pubkey to query for

Results (Valid Account Hash):
  object:
    accountHash: string - The account hash that you queried for
    data: object - Data associated with this account which contains the following fields:
      friendlyName: string - A friendly readable name for the account instead of just a hash
      abbreviation: string - A short abbreviation of the account
      category: string - A category that indicates which ecosystem does this account belong to (markets, validators, accounts, tokens, programs)
      voteKey: string (optional) - This field only exist for validator accounts to indicate the vote key account hash for this validator account
      network: string - Indicates if the account lives in (mainnet/devnet/testnet)
      tags: array<string> - Could be possibly tagged as a scammer/hacker account by the SolanaFM team or in a more generic term of tagging (e.g. tagging the account as a DeFi account)
      logoURI: string | null - An image url to the logo of the account (if exists)
      flag: string | null - Flagging out an account that has been exploited or exploits others to be indicated on our Explorer
```

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

### Get Owner Token Accounts API Endpoint

Source: https://docs.solana.fm/reference/solanafm-api-overview/reference/get_tokens_owned_by_account_handler

Documents the API endpoint to retrieve all token accounts, NFTs, and cNFTs owned by a specified Solana account hash. It includes details on required and optional parameters, as well as the structure of successful and error responses.

```APIDOC
Endpoint: GET https://api.solana.fm/v1/addresses/{account-hash}/tokens
Description: This endpoint returns you all the accounts (e.g. token accounts, NFTs, cNFTs) owned by the provided account hash.
Note: CNFTs owned by an account is not fully supported yet. The endpoint is still in Beta mode. Maximum number of ATAs to be returned is capped at 100 accounts.

Parameters:
- account-hash:
  Type: String
  Description: The account/wallet hash to query for (Only supports user's wallet hash).
- tokenType:
  Type: String (optional)
  Description: To filter the results by the retrieved token account type.
  Accepts: ["CompressedNonFungible", "Fungible", "Legacy", "NonFungible"]
  - CompressedNonFungible: Filters the query result for all cNFT accounts.
  - Fungible: Filters the query results for all Fungible tokens accounts held by the wallet.
  - Legacy: Filters the query results for all the token accounts that holds legacy tokens.
  - NonFungible: Filters the query results for all the Non Fungible Token accounts held by the wallet.

Results:
- Valid Account Hash:
  Type: Object
  Fields:
  - pubkey:
    Type: String
    Description: The account pubkey that you queried for.
  - tokens:
    Type: HashMap<String, object>
    Description: A key-value mapping of the token accounts / token address to the token's account data.
- Invalid Account Hash:
  Type: Object
  Fields:
  - code:
    Type: Integer
    Description: The error code.
  - message:
    Type: String
    Description: An error message to indicate which part of the query went wrong.
  - status:
    Type: String
    Description: The response status following the error code.
    Values:
    - 400: Bad Request (client side)
    - 500: Internal Server Error (server side)
```

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

### SolanaFM API Invalid Response Structure

Source: https://docs.solana.fm/reference/solanafm-api-overview/reference/get_blocks_by_pagination

Defines the JSON object returned by the SolanaFM API when a request results in an error, such as a non-existent account or an internal server issue. It includes fields for the error code, a descriptive message, and the HTTP status.

```APIDOC
Invalid Response Object:
  code: <integer> - The error code
  message: <String> - An error message to indicate which part of the query went wrong
  status: <String> - The response status following the error code
    400: Bad Request (client side)
    500: Internal Server Error (server side)
```

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

### SolanaFM API Reference and Overview

Source: https://docs.solana.fm/reference/solanafm-api-overview/reference

Comprehensive documentation for the SolanaFM API, covering its design principles, available endpoints categorized by functionality, authentication requirements, and error handling.

```APIDOC
SolanaFM API Overview:
  Design Principles:
    - RESTful endpoints
    - Websockets (WS)
    - Object-oriented approach
    - Adheres to standard HTTP responses with appropriate status codes
    - Requires authentication
  API Versions:
    - Endpoints differ for users opted into beta versions.

Authentication:
  - Free of charge
  - Usage gated by a rate-limiting middleware
  - All API requests must be made over HTTPS; plain HTTP calls will fail.

Errors:
  - Uses conventional HTTP response codes to indicate success or failure.
  - 2xx range: Indicates success.
  - 4xx range: Indicates client-side error (e.g., required parameters not populated, datatype mismatch).
  - 5xx range: Indicates server-side error (e.g., server downtime).
  - Some 4xx errors (e.g., invalid block number) include a brief error message.
  - Status Codes:
    - 200 OK: Returns the data in the response body.
    - 400 Bad Request: Request parameter(s) provided is incorrectly formatted or not provided.
    - 404 Not Found: The resource(s) requested is unavailable.
    - 429 Too many Requests: Rate-limit has been exceeded.
    - 500 Internal Server Error: The server encountered an unexpected error that prevented it from fulfilling the request.

API Endpoints:
  Accounts:
    - Get tagged account - Multiple (POST)
    - Get a tagged account (GET)
    - Account's Transaction Fees (GET)
    - Owner Token Accounts (GET)
    - Account Transactions (GET)
    - Account Transfers (GET)
    - Transfers CSV Export (GET)
  Blocks:
    - Get Blocks (GET)
    - Get Multiple Blocks (POST)
    - Get A Specific Block (GET)
  SNS Domains:
    - Accounts' Domains (POST)
    - Account Favourite Domain (POST)
    - Get User's Favourite Domains (GET)
    - Subdomains Of Multiple Accounts (POST)
    - Get An Account's Subdomains (GET)
    - Specific Account's Domains (GET)
  Solana Daily Data:
    - Solana Daily Transaction Fees (GET)
  Tokens:
    - SolanaFM Tagged Token List (GET)
    - Tokens - Multiple (POST)
    - Token Info (GET)
    - Tokens Info V1 - Multiple (POST)
    - Token Info V1 (GET)
    - User's Token Accounts (POST)
    - Mint Token Accounts (GET)
    - On-Chain Token Data (GET)
    - Token Supply (GET)
  Transfers:
    - All Transfer Actions (GET)
    - Transaction Transfers - Multiple (POST)
    - Transfer Transactions (GET)
  Rate Limits:
    - (Details not provided in this overview, but category exists)
```

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

### SolanaFM API Rate Limits Information

Source: https://docs.solana.fm/reference/solanafm-api-overview/reference/bonfida-domains

Reference to SolanaFM API rate limits documentation.

```APIDOC
Endpoint: /reference/rate-limits-1
Description: Rate Limits Documentation
```

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

### SolanaFM API Tokens Endpoints

Source: https://docs.solana.fm/reference/solanafm-api-overview/reference/bonfida-domains

API endpoints for retrieving Solana token information, including tagged token lists, multiple tokens, token info, user token accounts, mint token accounts, on-chain data, and supply.

```APIDOC
Endpoint: /reference/get_tokens_by_pagination
Method: GET
Description: SolanaFM Tagged Token List
```

```APIDOC
Endpoint: /reference/get_tokens_by_account_hashes
Method: POST
Description: Tokens - Multiple
```

```APIDOC
Endpoint: /reference/get_token_by_account_hash
Method: GET
Description: Token Info
```

```APIDOC
Endpoint: /reference/retrieve_multiple_tokens
Method: POST
Description: Tokens Info V1 - Multiple
```

```APIDOC
Endpoint: /reference/get_one_token
Method: GET
Description: Token Info V1
```

```APIDOC
Endpoint: /reference/get_user_token_accounts
Method: POST
Description: User's Token Accounts
```

```APIDOC
Endpoint: /reference/get_token_accounts_for_token_mint
Method: GET
Description: Mint Token Accounts
```

```APIDOC
Endpoint: /reference/get_tfi_token_data
Method: GET
Description: On-Chain Token Data
```

```APIDOC
Endpoint: /reference/get_token_circulating_supply
Method: GET
Description: Token Supply
```

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

### SolanaFM API Daily Data Endpoints

Source: https://docs.solana.fm/reference/solanafm-api-overview/reference/bonfida-domains

API endpoint for retrieving daily Solana transaction fee data.

```APIDOC
Endpoint: /reference/get_daily_tx_fees
Method: GET
Description: Solana Daily Transaction Fees
```
Tokens:
Raw