├── README.md
└── solanabeach.svg


/README.md:
--------------------------------------------------------------------------------
   1 | # <img src="solanabeach.svg" height="70px"> Solana Beach API
   2 | 
   3 | Hi, thanks for your interest in the Solana Beach API.
   4 | 
   5 | ## 📋 Table of Contents
   6 | 
   7 | - [API Key Request](#api-key-request)
   8 | - [Rate Limits](#rate-limits)
   9 | - [Documentation](#documentation)
  10 |   - [Account Data](#account-data) *(v1 API)*
  11 |   - [Block Data](#block-data)
  12 |   - [Dashboard Data](#dashboard-data)
  13 |   - [Transaction Data](#transaction-data) *(partially v1 API)*
  14 |   - [Validator Data](#validator-data)
  15 |   - [Validators Data](#validators-data)
  16 | - [We Appreciate Your Delegation](#we-appreciate-your-delegation)
  17 | 
  18 | ---
  19 | 
  20 | ## 🔑 <a id="api-key-request"></a>Please request an API-Key
  21 | 
  22 | To receive a key please join our [Telegram Group](https://t.me/+UW04VHylcMdlZmUy) and send a DM to one of the team members.
  23 | 
  24 | ## ⚙️ <a id="rate-limits"></a>Rate Limits
  25 | 
  26 | The two tables below show the rate limit restrictions and how you can trace and throttle your consumption.
  27 | 
  28 | | Rate Limiter | Limit | Relevance |
  29 | | ----------- | ----- | ------- |
  30 | | **Standard**    | 100 requests / 10 seconds | This rate limiter counts every request |
  31 | | **On-Demand**   | 600 requests / 20 minutes | This rate limiter counts every request that<br> triggers a call to an external data provider |
  32 | 
  33 | 
  34 | | Response Header    | Relevance | 
  35 | | -------- | ------- |
  36 | | **Solana-Beach-Standard-Credits-Remaining**  | You can use this value to throttle your scripts |
  37 | | **Solana-Beach-Standard-Credits-Consumed**   | You can use this value to trace your consumption |
  38 | | **Solana-Beach-On-Demand-Credits-Remaining**   | You can use this value to throttle your scripts |
  39 | | **Solana-Beach-On-Demand-Credits-Consumed**   | You can use this value to trace your consumption |
  40 | 
  41 | ---
  42 | 
  43 | ## 📚 <a id="documentation"></a>Documentation
  44 | 
  45 | Our REST-API servers are available under the Base URL `https://api.solanabeach.io/v2`.
  46 | 
  47 | Your requests must use the HTTP `GET` method and must include a `Accept: application/json` and `Authorization: Bearer {YOUR-API-KEY}` header.
  48 | 
  49 | If the HTTP response status code reports an error the response schema will look like this:
  50 | 
  51 | ```json
  52 | {
  53 |   "err": "string"
  54 | }
  55 | ```
  56 | 
  57 | ---
  58 | 
  59 | ### 🪪 <a id="account-data"></a>Account Data
  60 | 
  61 | > ⚠️ **API Version Note**: All Account Data endpoints use Base URL `https://api.solanabeach.io/v1`
  62 | 
  63 | #### `GET /account/{pubkey}` 
  64 | **Fetch account fields**
  65 | 
  66 | Returns detailed information about a specific account.
  67 | 
  68 | <details>
  69 | <summary>Response Schema</summary>
  70 | <br>
  71 | 
  72 | ```json
  73 | {
  74 |   "type": "string",
  75 |   "value": {
  76 |     "base": {
  77 |       "address": {
  78 |         "address": "string",
  79 |         "name": "string",
  80 |         "logo": "string",
  81 |         "ticker": "string",
  82 |         "cmcId": "string"
  83 |       },
  84 |       "balance": 0,
  85 |       "executable": true,
  86 |       "owner": {
  87 |         "address": "string",
  88 |         "name": "string",
  89 |         "logo": "string",
  90 |         "ticker": "string",
  91 |         "cmcId": "string"
  92 |       },
  93 |       "rentEpoch": 0,
  94 |       "dataSize": 0
  95 |     },
  96 |     "extended": {}
  97 |   }
  98 | }
  99 | ```
 100 | </details>
 101 | <br>
 102 | 
 103 | #### `GET /account/{pubkey}/transactions` 
 104 | **Fetch transactions**
 105 | 
 106 | Returns transactions associated with the specified account.
 107 | 
 108 | <details>
 109 | <summary>Query Options</summary>
 110 | <br>
 111 | 
 112 | | Parameter | Description | Default |
 113 | | ----------- | ----- | ------- |
 114 | | `before` | The signature of the last transaction you want to search backwards from | - |
 115 | | `limit`  | The upper limit of transactions you want to receive | - |
 116 | 
 117 | </details>
 118 | <br>
 119 | 
 120 | <details>
 121 | <summary>Response Schema</summary>
 122 | <br>
 123 | 
 124 | ```json
 125 | [
 126 |   {
 127 |     "transactionHash": "string",
 128 |     "blockNumber": 0,
 129 |     "index": 0,
 130 |     "accounts": [
 131 |       {
 132 |         "account": {
 133 |           "address": "string",
 134 |           "name": "string",
 135 |           "logo": "string",
 136 |           "ticker": "string",
 137 |           "cmcId": "string"
 138 |         },
 139 |         "writable": true,
 140 |         "signer": true,
 141 |         "program": true
 142 |       }
 143 |     ],
 144 |     "header": {
 145 |       "numRequiredSignatures": 0,
 146 |       "numReadonlySignedAccounts": 0,
 147 |       "numReadonlyUnsignedAccounts": 0
 148 |     },
 149 |     "instructions": [
 150 |       {
 151 |         "parsed": {},
 152 |         "raw": {
 153 |           "data": "string",
 154 |           "accounts": [
 155 |             0
 156 |           ],
 157 |           "programIdIndex": 0
 158 |         }
 159 |       }
 160 |     ],
 161 |     "recentBlockhash": "string",
 162 |     "signatures": [
 163 |       "string"
 164 |     ],
 165 |     "meta": {
 166 |       "err": {},
 167 |       "fee": 0,
 168 |       "status": {},
 169 |       "logMessages": [
 170 |         "string"
 171 |       ],
 172 |       "preBalances": [
 173 |         0
 174 |       ],
 175 |       "postBalances": [
 176 |         0
 177 |       ]
 178 |     },
 179 |     "valid": true,
 180 |     "blocktime": {
 181 |       "absolute": 0,
 182 |       "relative": 0
 183 |     },
 184 |     "mostImportantInstruction": {
 185 |       "name": "string",
 186 |       "weight": 0,
 187 |       "index": 0
 188 |     },
 189 |     "smart": [
 190 |       {
 191 |         "type": "string",
 192 |         "value": "string"
 193 |       }
 194 |     ],
 195 |     "ondemand": true
 196 |   }
 197 | ]
 198 | ```
 199 | </details>
 200 | <br>
 201 | 
 202 | #### `GET /account/{pubkey}/stakes` 
 203 | **Fetch stake accounts**
 204 | 
 205 | Returns stake accounts associated with the specified account.
 206 | 
 207 | <details>
 208 | <summary>Response Schema</summary>
 209 | <br>
 210 | 
 211 | ```json
 212 | [
 213 |   {
 214 |     "pubkey": "string",
 215 |     "lamports": 0,
 216 |     "data": {
 217 |       "state": 0,
 218 |       "meta": {
 219 |         "rent_exempt_reserve": 0,
 220 |         "authorized": {
 221 |           "staker": "string",
 222 |           "withdrawer": "string"
 223 |         }
 224 |       },
 225 |       "lockup": {
 226 |         "unix_timestamp": 0,
 227 |         "epoch": 0,
 228 |         "custodian": "string"
 229 |       },
 230 |       "stake": {
 231 |         "delegation": {
 232 |           "voter_pubkey": "string",
 233 |           "stake": 0,
 234 |           "activation_epoch": 0,
 235 |           "deactivation_epoch": 0,
 236 |           "warmup_cooldown_rate": 0,
 237 |           "validatorInfo": {
 238 |             "name": "string",
 239 |             "image": "string",
 240 |             "website": "string",
 241 |             "nodePubkey": "string"
 242 |           }
 243 |         },
 244 |         "credits_observed": 0
 245 |       }
 246 |     }
 247 |   }
 248 | ]
 249 | ```
 250 | </details>
 251 | <br>
 252 | 
 253 | #### `GET /account/{stake_pubkey}/stake-rewards` 
 254 | **Fetch stake account rewards**
 255 | 
 256 | Returns rewards for the specified stake account.
 257 | 
 258 | <details>
 259 | <summary>Query Options</summary>
 260 | <br>
 261 | 
 262 | | Parameter | Description | Default |
 263 | | ----------- | ----- | ------- |
 264 | | `cursor` | The epoch of the last stake reward you want to search backwards from | - |
 265 | 
 266 | </details>
 267 | <br>
 268 | 
 269 | <details>
 270 | <summary>Response Schema</summary>
 271 | <br>
 272 | 
 273 | ```json
 274 | [
 275 |   {
 276 |     "epoch": 0,
 277 |     "effectiveSlot": 0,
 278 |     "amount": "string",
 279 |     "postBalance": "string",
 280 |     "percentChange": 0,
 281 |     "apr": 0
 282 |   }
 283 | ]
 284 | ```
 285 | </details>
 286 | <br>
 287 | 
 288 | #### `GET /account/{pubkey}/tokens` 
 289 | **Fetch token accounts**
 290 | 
 291 | Returns token accounts associated with the specified account.
 292 | 
 293 | <details>
 294 | <summary>Response Schema</summary>
 295 | <br>
 296 | 
 297 | ```json
 298 | [
 299 |   {
 300 |     "mint": {
 301 |       "address": "string",
 302 |       "name": "string",
 303 |       "logo": "string",
 304 |       "ticker": "string",
 305 |       "cmcId": "string"
 306 |     },
 307 |     "amount": 0,
 308 |     "address": {
 309 |       "address": "string",
 310 |       "name": "string",
 311 |       "logo": "string",
 312 |       "ticker": "string",
 313 |       "cmcId": "string"
 314 |     },
 315 |     "decimals": 0
 316 |   }
 317 | ]
 318 | ```
 319 | </details>
 320 | <br>
 321 | 
 322 | #### `GET /account/{pubkey}/token-transfers` 
 323 | **Fetch token account transfers**
 324 | 
 325 | Returns token transfers associated with the specified account.
 326 | 
 327 | <details>
 328 | <summary>Response Schema</summary>
 329 | <br>
 330 | 
 331 | ```json
 332 | [
 333 |   {
 334 |     "blocknumber": 0,
 335 |     "txhash": "string",
 336 |     "mint": {
 337 |       "address": "string",
 338 |       "name": "string",
 339 |       "logo": "string",
 340 |       "ticker": "string",
 341 |       "cmcId": "string"
 342 |     },
 343 |     "valid": true,
 344 |     "amount": 0,
 345 |     "source": {
 346 |       "address": "string",
 347 |       "name": "string",
 348 |       "logo": "string",
 349 |       "ticker": "string",
 350 |       "cmcId": "string"
 351 |     },
 352 |     "destination": {
 353 |       "address": "string",
 354 |       "name": "string",
 355 |       "logo": "string",
 356 |       "ticker": "string",
 357 |       "cmcId": "string"
 358 |     },
 359 |     "inner": true,
 360 |     "txindex": 0,
 361 |     "timestamp": {
 362 |       "absolute": 0,
 363 |       "relative": 0
 364 |     },
 365 |     "decimals": 0
 366 |   }
 367 | ]
 368 | ```
 369 | </details>
 370 | <br>
 371 | 
 372 | 
 373 | ---
 374 | 
 375 | ### 📦 <a id="block-data"></a>Block Data
 376 | 
 377 | #### `GET /block/:number` 
 378 | **Fetch block details**
 379 | 
 380 | Returns detailed information about a specific block, including transaction metrics, program statistics, and validator information.
 381 | 
 382 | <details>
 383 | <summary>Response Schema</summary>
 384 | <br>
 385 | 
 386 | ```json
 387 | {
 388 |   "slot": 0,
 389 |   "blockTime": 0,
 390 |   "epoch": 0,
 391 |   "nodePubkey": "string",
 392 |   "voteTransactions": 0,
 393 |   "userTransactions": 0,
 394 |   "voteInstructions": 0,
 395 |   "userInstructions": 0,
 396 |   "successTransactions": 0,
 397 |   "fees": 0,
 398 |   "programInstructions": {
 399 |     "programName": {
 400 |       "totalInstructionCount": 0,
 401 |       "instructionCount": {
 402 |         "instructionType1": 0,
 403 |         "instructionType2": 0,
 404 |         // ... other instruction types
 405 |       }
 406 |     }
 407 |   }
 408 | }
 409 | ```
 410 | </details>
 411 | <br>
 412 | 
 413 | #### `GET /recent-blocks` 
 414 | **Fetch recent blocks**
 415 | 
 416 | Returns a list of recent blocks with basic information including slot, block time, and validator details.
 417 | 
 418 | <details>
 419 | <summary>Query Options</summary>
 420 | <br>
 421 | 
 422 | | Parameter | Description | Default |
 423 | | ------ | ------------------------------------------------------------- | ------- |
 424 | | `offset` | The slot of the last block you want to search backwards from | - |
 425 | | `limit`  | The upper limit of blocks you want to receive | - |
 426 | 
 427 | </details>
 428 | <br>
 429 | 
 430 | <details>
 431 | <summary>Response Schema</summary>
 432 | <br>
 433 | 
 434 | ```json
 435 | {
 436 |   "blocks": [
 437 |     {
 438 |       "slot": "string",
 439 |       "blockTime": "string",
 440 |       "voteInstructions": 0,
 441 |       "userInstructions": 0,
 442 |       "fees": "string",
 443 |       "votePubkey": "string",
 444 |       "name": "string",
 445 |       "iconUrl": "string"
 446 |     }
 447 |   ],
 448 |   "pagination": {
 449 |     "total": 0,
 450 |     "offset": 0,
 451 |     "limit": 0
 452 |   }
 453 | }
 454 | ```
 455 | </details>
 456 | <br>
 457 | 
 458 | #### `GET /top-programs` 
 459 | **Fetch statistics about most active programs**
 460 | 
 461 | Returns statistics about the most active programs on the network, including total instruction counts and breakdowns of specific instruction types.
 462 | 
 463 | <details>
 464 | <summary>Response Schema</summary>
 465 | <br>
 466 | 
 467 | ```json
 468 | [
 469 |   {
 470 |     "programName": "string",
 471 |     "totalInstructionCount": 0,
 472 |     "instructionCount": {
 473 |       "instructionType1": 0,
 474 |       "instructionType2": 0,
 475 |       // ... other instruction types
 476 |     }
 477 |   }
 478 | ]
 479 | ```
 480 | </details>
 481 | <br>
 482 | 
 483 | ---
 484 | 
 485 | ### 📊 <a id="dashboard-data"></a>Dashboard Data
 486 | 
 487 | #### `GET /transactions-per-second` 
 488 | **Fetch transactions per second**
 489 | 
 490 | Returns vote and user transactions per second. Data is cached for 60 seconds.
 491 | 
 492 | <details>
 493 | <summary>Response Schema</summary>
 494 | <br>
 495 | 
 496 | ```json
 497 | {
 498 |   "voteTransactionsPerSecond": 0,
 499 |   "userTransactionsPerSecond": 0
 500 | }
 501 | ```
 502 | </details>
 503 | <br>
 504 | 
 505 | #### `GET /epoch-info` 
 506 | **Fetch current epoch information**
 507 | 
 508 | Returns current epoch information. Data is cached for 10 seconds.
 509 | 
 510 | <details>
 511 | <summary>Response Schema</summary>
 512 | <br>
 513 | 
 514 | ```json
 515 | {
 516 |   "absoluteSlot": 0,
 517 |   "blockHeight": 0,
 518 |   "epoch": 0,
 519 |   "slotIndex": 0,
 520 |   "slotsInEpoch": 0,
 521 |   "transactionCount": 0,
 522 |   "epochStartTime": 0,
 523 |   "slotTime": 0
 524 | }
 525 | ```
 526 | </details>
 527 | <br>
 528 | 
 529 | #### `GET /supply-breakdown` 
 530 | **Fetch current supply and stake breakdown**
 531 | 
 532 | Returns current supply and stake breakdown. Data is cached for 60 seconds.
 533 | 
 534 | <details>
 535 | <summary>Response Schema</summary>
 536 | <br>
 537 | 
 538 | ```json
 539 | {
 540 |   "supply": {
 541 |     "circulating": 0,
 542 |     "nonCirculating": 0,
 543 |     "total": 0
 544 |   },
 545 |   "stake": {
 546 |     "effective": 0,
 547 |     "activating": 0,
 548 |     "deactivating": 0
 549 |   }
 550 | }
 551 | ```
 552 | </details>
 553 | <br>
 554 | 
 555 | #### `GET /instruction-chart` 
 556 | **Fetch information about user and vote instructions**
 557 | 
 558 | Returns information about user and vote instructions. Data is cached for 60 seconds.
 559 | 
 560 | <details>
 561 | <summary>Response Schema</summary>
 562 | <br>
 563 | 
 564 | ```json
 565 | [
 566 |   {
 567 |     "time": "string",
 568 |     "userInstructions": "string",
 569 |     "voteInstructions": "string"
 570 |   }
 571 | ]
 572 | ```
 573 | </details>
 574 | <br>
 575 | 
 576 | ---
 577 | 
 578 | ### 💳 <a id="transaction-data"></a>Transaction Data
 579 | 
 580 | > ⚠️ **API Version Note**: The `/transaction/{signature}` endpoint in this section uses Base URL `https://api.solanabeach.io/v1`
 581 | 
 582 | #### `GET /transaction/{signature}` 
 583 | **Fetch transaction**
 584 | 
 585 | Returns detailed information about a specific transaction.
 586 | 
 587 | <details>
 588 | <summary>Response Schema</summary>
 589 | <br>
 590 | 
 591 | ```json
 592 | {
 593 |   "transactionHash": "string",
 594 |   "blockNumber": 0,
 595 |   "index": 0,
 596 |   "accounts": [
 597 |     {
 598 |       "account": {
 599 |         "address": "string",
 600 |         "name": "string",
 601 |         "logo": "string",
 602 |         "ticker": "string",
 603 |         "cmcId": "string"
 604 |       },
 605 |       "writable": true,
 606 |       "signer": true,
 607 |       "program": true
 608 |     }
 609 |   ],
 610 |   "header": {
 611 |     "numRequiredSignatures": 0,
 612 |     "numReadonlySignedAccounts": 0,
 613 |     "numReadonlyUnsignedAccounts": 0
 614 |   },
 615 |   "instructions": [
 616 |     {
 617 |       "parsed": {},
 618 |       "raw": {
 619 |         "data": "string",
 620 |         "accounts": [
 621 |           0
 622 |         ],
 623 |         "programIdIndex": 0
 624 |       }
 625 |     }
 626 |   ],
 627 |   "recentBlockhash": "string",
 628 |   "signatures": [
 629 |     "string"
 630 |   ],
 631 |   "meta": {
 632 |     "err": {},
 633 |     "fee": 0,
 634 |     "status": {},
 635 |     "logMessages": [
 636 |       "string"
 637 |     ],
 638 |     "preBalances": [
 639 |       0
 640 |     ],
 641 |     "postBalances": [
 642 |       0
 643 |     ]
 644 |   },
 645 |   "valid": true,
 646 |   "blocktime": {
 647 |     "absolute": 0,
 648 |     "relative": 0
 649 |   },
 650 |   "mostImportantInstruction": {
 651 |     "name": "string",
 652 |     "weight": 0,
 653 |     "index": 0
 654 |   },
 655 |   "smart": [
 656 |     {
 657 |       "type": "string",
 658 |       "value": "string"
 659 |     }
 660 |   ],
 661 |   "ondemand": true
 662 | }
 663 | ```
 664 | </details>
 665 | <br>
 666 | 
 667 | #### `GET /recent-transactions` 
 668 | **Fetch recent transactions**
 669 | 
 670 | Returns recent transactions with pagination support. Data is cached for 30 seconds.
 671 | 
 672 | <details>
 673 | <summary>Query Options</summary>
 674 | <br>
 675 | 
 676 | | Parameter | Description | Default | Max |
 677 | |-----------|-------------|---------|-----|
 678 | | offset    | Starting position in the transaction list | 0 | - |
 679 | | limit     | Maximum number of transactions to return | 50 | 100 |
 680 | 
 681 | </details>
 682 | <br>
 683 | 
 684 | <details>
 685 | <summary>Response Schema</summary>
 686 | <br>
 687 | 
 688 | ```json
 689 | {
 690 |   "slot": "number",
 691 |   "transactions": [
 692 |     {
 693 |       "transactionHash": "string",
 694 |       "accounts": [
 695 |         {
 696 |           "isSigner": "boolean",
 697 |           "isWritable": "boolean",
 698 |           "isLUT": "boolean",
 699 |           "account": {
 700 |             "address": "string",
 701 |             "name": "string | null",
 702 |             "ticker": "string | null",
 703 |             "cmcId": "string | null",
 704 |             "logo": "string | null",
 705 |             "meta": {
 706 |               "url": "string | null"
 707 |             },
 708 |             "decimals": "number | null"
 709 |           }
 710 |         }
 711 |       ],
 712 |       "recentBlockhash": "string",
 713 |       "signatures": ["string"],
 714 |       "meta": {
 715 |         "computeUnitsConsumed": "number",
 716 |         "err": "object | null",
 717 |         "fee": "number",
 718 |         "loadedAddresses": {
 719 |           "readonly": ["string"],
 720 |           "writable": ["string"]
 721 |         },
 722 |         "logMessages": ["string"],
 723 |         "postBalances": ["number"],
 724 |         "postTokenBalances": [
 725 |           {
 726 |             "accountIndex": "number",
 727 |             "mint": "object",
 728 |             "owner": "object",
 729 |             "uiTokenAmount": "object"
 730 |           }
 731 |         ],
 732 |         "preBalances": ["number"],
 733 |         "preTokenBalances": [
 734 |           {
 735 |             "accountIndex": "number",
 736 |             "mint": "object",
 737 |             "owner": "object",
 738 |             "uiTokenAmount": "object"
 739 |           }
 740 |         ],
 741 |         "rewards": ["object"],
 742 |         "status": "object"
 743 |       },
 744 |       "mostImportantInstruction": {
 745 |         "name": "string",
 746 |         "weight": "number",
 747 |         "index": "number"
 748 |       },
 749 |       "overpaidFees": "number"
 750 |     }
 751 |   ],
 752 |   "pagination": {
 753 |     "total": "number",
 754 |     "offset": "number",
 755 |     "limit": "number"
 756 |   }
 757 | }
 758 | ```
 759 | </details>
 760 | <br>
 761 | 
 762 | 
 763 | 
 764 | ---
 765 | 
 766 | ### 🔍 <a id="validator-data"></a>Validator Data
 767 | 
 768 | #### `GET /validator/:address/stake-accounts` 
 769 | **Fetch validator stake accounts**
 770 | 
 771 | Returns a paginated list of stake accounts for a given validator.
 772 | 
 773 | <details>
 774 | <summary>Query Options</summary>
 775 | <br>
 776 | 
 777 | | Parameter | Description | Default | Max |
 778 | | ------- | ---------------------------------------------------- | ------- | ------- |
 779 | | `offset` | Starting point for pagination | 0 | - |
 780 | | `limit` | Maximum number of results to return | 10 | 1000 |
 781 | 
 782 | </details>
 783 | <br>
 784 | 
 785 | <details>
 786 | <summary>Response Schema</summary>
 787 | <br>
 788 | 
 789 | ```json
 790 | {
 791 |   "stakeAccounts": [
 792 |     {
 793 |       "stakePubkey": "string",
 794 |       "stakeAuthority": "string",
 795 |       "withdrawAuthority": "string",
 796 |       "state": 0,
 797 |       "stake": 0,
 798 |       "activationEpoch": 0,
 799 |       "deactivationEpoch": 0,
 800 |       "lastUpdate": "string"
 801 |     }
 802 |   ],
 803 |   "pagination": {
 804 |     "total": 0,
 805 |     "offset": 0,
 806 |     "limit": 0
 807 |   }
 808 | }
 809 | ```
 810 | </details>
 811 | <br>
 812 | 
 813 | #### `GET /validator/:nodepubkey/block-rewards-history` 
 814 | **Fetch validator block rewards history**
 815 | 
 816 | Returns historical block rewards data for a specific validator.
 817 | 
 818 | <details>
 819 | <summary>Query Options</summary>
 820 | <br>
 821 | 
 822 | | Parameter | Description | Default | Max |
 823 | | ---------- | ---------------------------------------------- | ------- | ------- |
 824 | | `offset` | Starting point for pagination | 0 | - |
 825 | | `limit` | Maximum number of results to return | 10 | 1000 |
 826 | 
 827 | </details>
 828 | <br>
 829 | 
 830 | <details>
 831 | <summary>Response Schema</summary>
 832 | <br>
 833 | 
 834 | ```json
 835 | {
 836 |   "history": [
 837 |     {
 838 |       "epoch": 0,
 839 |       "blocks": 0,
 840 |       "fees": 0
 841 |     }
 842 |   ],
 843 |   "pagination": {
 844 |     "total": 0,
 845 |     "offset": 0,
 846 |     "limit": 0
 847 |   }
 848 | }
 849 | ```
 850 | </details>
 851 | <br>
 852 | 
 853 | #### `GET /validator/:nodepubkey/success-rate-history` 
 854 | **Fetch validator success rate history**
 855 | 
 856 | Returns historical success rate data for a specific validator.
 857 | 
 858 | <details>
 859 | <summary>Query Options</summary>
 860 | <br>
 861 | 
 862 | | Parameter | Description | Default | Max |
 863 | | ---------- | ---------------------------------------------- | ------- | ------- |
 864 | | `offset` | Starting point for pagination | 0 | - |
 865 | | `limit` | Maximum number of results to return | 10 | 1000 |
 866 | 
 867 | </details>
 868 | <br>
 869 | 
 870 | <details>
 871 | <summary>Response Schema</summary>
 872 | <br>
 873 | 
 874 | ```json
 875 | {
 876 |   "history": [
 877 |     {
 878 |       "epoch": 0,
 879 |       "slots": 0,
 880 |       "blocks": 0,
 881 |       "successRate": 0
 882 |     }
 883 |   ],
 884 |   "pagination": {
 885 |     "total": 0,
 886 |     "offset": 0, 
 887 |     "limit": 0
 888 |   }
 889 | }
 890 | ```
 891 | </details>
 892 | <br>
 893 | 
 894 | #### `GET /validator/:votepubkey/stake-accounts-history` 
 895 | **Fetch validator stake accounts history**
 896 | 
 897 | Returns historical stake accounts data for a specific validator.
 898 | 
 899 | <details>
 900 | <summary>Query Options</summary>
 901 | <br>
 902 | 
 903 | | Parameter | Description | Default | Max |
 904 | | ---------- | ---------------------------------------------- | ------- | ------- |
 905 | | `offset` | Starting point for pagination | 0 | - |
 906 | | `limit` | Maximum number of results to return | 10 | 1000 |
 907 | 
 908 | </details>
 909 | <br>
 910 | 
 911 | <details>
 912 | <summary>Response Schema</summary>
 913 | <br>
 914 | 
 915 | ```json
 916 | {
 917 |   "history": [
 918 |     {
 919 |       "epoch": 0,
 920 |       "stakeAccounts": 0
 921 |     }
 922 |   ],
 923 |   "pagination": {
 924 |     "total": 0,
 925 |     "offset": 0,
 926 |     "limit": 0
 927 |   }
 928 | }
 929 | ```
 930 | </details>
 931 | <br>
 932 | 
 933 | #### `GET /validator/:votepubkey/stake-history` 
 934 | **Fetch validator stake history**
 935 | 
 936 | Returns historical stake data for a specific validator.
 937 | 
 938 | <details>
 939 | <summary>Query Options</summary>
 940 | <br>
 941 | 
 942 | | Parameter | Description | Default | Max |
 943 | | ---------- | ---------------------------------------------- | ------- | ------- |
 944 | | `offset` | Starting point for pagination | 0 | - |
 945 | | `limit` | Maximum number of results to return | 10 | 1000 |
 946 | 
 947 | </details>
 948 | <br>
 949 | 
 950 | <details>
 951 | <summary>Response Schema</summary>
 952 | <br>
 953 | 
 954 | ```json
 955 | {
 956 |   "history": [
 957 |     {
 958 |       "epoch": 0, 
 959 |       "activatedStake": 0
 960 |     }
 961 |   ],
 962 |   "pagination": {
 963 |     "total": 0,
 964 |     "offset": 0,
 965 |     "limit": 0
 966 |   }
 967 | }
 968 | ```
 969 | </details>
 970 | <br>
 971 | 
 972 | #### `GET /cluster-block-rewards-history` 
 973 | **Fetch cluster block rewards history**
 974 | 
 975 | Returns aggregated block rewards history for the entire cluster.
 976 | 
 977 | <details>
 978 | <summary>Query Options</summary>
 979 | <br>
 980 | 
 981 | | Parameter | Description | Default | Max |
 982 | | ------ | ---------------------------------------------- | ------- | ------- |
 983 | | `offset` | Starting point for pagination | 0 | - |
 984 | | `limit` | Maximum number of results to return | 10 | 1000 |
 985 | 
 986 | </details>
 987 | <br>
 988 | 
 989 | <details>
 990 | <summary>Response Schema</summary>
 991 | <br>
 992 | 
 993 | ```json
 994 | {
 995 |   "history": [
 996 |     {
 997 |       "epoch": 0,
 998 |       "blocks": 0,
 999 |       "fees": 0
1000 |     }
1001 |   ],
1002 |   "pagination": {
1003 |     "total": 0,
1004 |     "offset": 0,
1005 |     "limit": 0
1006 |   }
1007 | }
1008 | ```
1009 | </details>
1010 | <br>
1011 | 
1012 | #### `GET /cluster-success-rate-history` 
1013 | **Fetch cluster success rate history**
1014 | 
1015 | Returns aggregated success rate history for the entire cluster.
1016 | 
1017 | <details>
1018 | <summary>Query Options</summary>
1019 | <br>
1020 | 
1021 | | Parameter | Description | Default | Max |
1022 | | ------ | ---------------------------------------------- | ------- | ------- |
1023 | | `offset` | Starting point for pagination | 0 | - |
1024 | | `limit` | Maximum number of results to return | 10 | 1000 |
1025 | 
1026 | </details>
1027 | <br>
1028 | 
1029 | <details>
1030 | <summary>Response Schema</summary>
1031 | <br>
1032 | 
1033 | ```json
1034 | {
1035 |   "history": [
1036 |     {
1037 |       "epoch": 0,
1038 |       "slots": 0,
1039 |       "blocks": 0,
1040 |       "success_rate": 0
1041 |     }
1042 |   ],
1043 |   "pagination": {
1044 |     "total": 0,
1045 |     "offset": 0,
1046 |     "limit": 0
1047 |   }
1048 | }
1049 | ```
1050 | </details>
1051 | <br>
1052 | 
1053 | #### `GET /validator/:votepubkey` 
1054 | **Fetch validator details**
1055 | 
1056 | Returns general details about a specific validator.
1057 | 
1058 | <details>
1059 | <summary>Query Options</summary>
1060 | <br>
1061 | 
1062 | | Parameter | Description |
1063 | | ---------- | ---------------------------- |
1064 | | `votepubkey` | The validator's vote public key |
1065 | 
1066 | </details>
1067 | <br>
1068 | 
1069 | <details>
1070 | <summary>Response Schema</summary>
1071 | <br>
1072 | 
1073 | ```json
1074 | {
1075 |   "votePubkey": "string",
1076 |   "nodePubkey": "string",
1077 |   "commission": 0,
1078 |   "lastVote": "number",
1079 |   "delinquent": "true | false",
1080 |   "name": "string",
1081 |   "iconUrl": "string",
1082 |   "website": "string",
1083 |   "details": "string",
1084 |   "version": "string",
1085 |   "continent": "string",
1086 |   "country": "string",
1087 |   "region": "string",
1088 |   "city": "string",
1089 |   "asn": 0,
1090 |   "asnOrganization": "string"
1091 | }
1092 | ```
1093 | </details>
1094 | <br>
1095 | 
1096 | ---
1097 | 
1098 | 
1099 | ### 📈 <a id="validators-data"></a>Validators Data
1100 | 
1101 | #### `GET /skip-rates` 
1102 | **Fetch validator skip rates**
1103 | 
1104 | Returns skip rate data for validators.
1105 | 
1106 | <details>
1107 | <summary>Response Schema</summary>
1108 | <br>
1109 | 
1110 | ```json
1111 | {
1112 |   "skipRate": 0,
1113 |   "stakeWeightedSkipRate": 0
1114 | }
1115 | ```
1116 | </details>
1117 | <br>
1118 | 
1119 | #### `GET /staking-yield` 
1120 | **Fetch staking yield data**
1121 | 
1122 | Returns staking yield data.
1123 | 
1124 | <details>
1125 | <summary>Response Schema</summary>
1126 | <br>
1127 | 
1128 | ```json
1129 | {
1130 |   "inflationRate": 0,
1131 |   "effectiveInflationRate": 0,
1132 |   "inflationRewardsApy": 0,
1133 |   "blockRewardsApy": 0
1134 | }
1135 | ```
1136 | </details>
1137 | <br>
1138 | 
1139 | #### `GET /node-versions` 
1140 | **Fetch node version distribution**
1141 | 
1142 | Returns node version distribution data.
1143 | 
1144 | <details>
1145 | <summary>Response Schema</summary>
1146 | <br>
1147 | 
1148 | ```json
1149 | [
1150 |   {
1151 |     "version": "string",
1152 |     "stake": "number"
1153 |   }
1154 | ]
1155 | ```
1156 | </details>
1157 | <br>
1158 | 
1159 | #### `GET /validator-list` 
1160 | **Fetch paginated list of validators**
1161 | 
1162 | Returns a paginated list of validators.
1163 | 
1164 | <details>
1165 | <summary>Query Options</summary>
1166 | <br>
1167 | 
1168 | | Parameter | Description | Default | Max |
1169 | | ------ | ---------------------------------------------- | ------- | ------- |
1170 | | `offset` | Starting position in the validator list | 0 | - |
1171 | | `limit` | Maximum number of validators to return | 50 | 100 |
1172 | 
1173 | </details>
1174 | <br>
1175 | 
1176 | <details>
1177 | <summary>Response Schema</summary>
1178 | <br>
1179 | 
1180 | ```json
1181 | {
1182 |   "validators": [
1183 |     {
1184 |       "votePubkey": "string",
1185 |       "name": "string",
1186 |       "iconUrl": "string",
1187 |       "version": "string",
1188 |       "activatedStake": "number",
1189 |       "stakeAccounts": "number",
1190 |       "commission": 0,
1191 |       "lastVote": "number",
1192 |       "delinquent": "true | false"
1193 |     }
1194 |   ],
1195 |   "pagination": {
1196 |     "total": "number",
1197 |     "offset": "number",
1198 |     "limit": "number"
1199 |   }
1200 | }
1201 | ```
1202 | </details>
1203 | <br>
1204 | 
1205 | ---
1206 | 
1207 | ## 🧡 <a id="we-appreciate-your-delegation"></a>We appreciate your delegation
1208 | 
1209 | If you're satisfied with this product consider choosing the Solana Beach Validator next time you are confronted with the decision where to delegate.
1210 | 


--------------------------------------------------------------------------------
/solanabeach.svg:
--------------------------------------------------------------------------------
 1 | <svg width="182" height="170" viewBox="0 0 182 170" fill="none" xmlns="http://www.w3.org/2000/svg">
 2 |     <path fill-rule="evenodd" clip-rule="evenodd" d="M92.6415 0C140.669 0 179.602 38.7877 179.602 86.6346C179.602 89.4927 178.707 96.4032 178.267 99.6298C178.132 100.615 177.29 101.343 176.296 101.343L149.248 101.346C147.889 101.346 146.787 102.444 146.787 103.798C146.787 105.073 147.763 106.12 149.011 106.239L149.248 106.25L174.746 106.247C175.965 106.247 176.882 107.365 176.63 108.558C176.312 110.071 174.971 111.156 173.419 111.156H11.8642C8.88022 111.156 11.5133 106.247 14.4974 106.247L47.5204 106.25C48.8797 106.25 49.9816 105.152 49.9816 103.798C49.9816 102.524 49.0055 101.476 47.7575 101.357L47.5204 101.346L9.35011 101.343C8.1437 101.343 7.11664 100.465 6.92857 99.2737C6.69371 97.7854 7.84413 96.4395 9.35078 96.4398L22.9089 96.4423C24.2682 96.4423 25.3701 95.3446 25.3701 93.9904C25.3701 92.7159 24.394 91.6685 23.146 91.5497L22.9089 91.5385L7.78376 91.5369C6.73257 91.5368 5.86064 90.7232 5.801 89.6737C5.74131 88.6236 5.68089 87.3772 5.68089 86.6346C5.68089 38.7877 44.6145 0 92.6415 0ZM165.655 91.5385H147.607C146.248 91.5385 145.146 92.6363 145.146 93.9904C145.146 95.2649 146.122 96.3123 147.37 96.4311L147.607 96.4423H165.655C167.015 96.4423 168.117 95.3446 168.117 93.9904C168.117 92.7159 167.141 91.6685 165.892 91.5497L165.655 91.5385Z" fill="url(#paint0_linear_1299_1427)"/>
 3 |     <path d="M8.96116 117.558C8.96116 116.729 9.63266 116.058 10.461 116.058H171.538C172.366 116.058 173.038 116.729 173.038 117.558V119.462C173.038 120.29 172.366 120.962 171.538 120.962H10.461C9.63266 120.962 8.96116 120.29 8.96116 119.462V117.558Z" fill="url(#paint1_linear_1299_1427)"/>
 4 |     <path d="M0.757812 127.365C0.757812 126.537 1.42932 125.865 2.25766 125.865H35.3548C36.1832 125.865 36.8547 126.537 36.8547 127.365V129.269C36.8547 130.098 36.1832 130.769 35.3548 130.769H2.25766C1.42932 130.769 0.757812 130.098 0.757812 129.269V127.365Z" fill="url(#paint2_linear_1299_1427)"/>
 5 |     <path d="M61.3253 125.865C60.4969 125.865 59.8254 126.537 59.8254 127.365V129.269C59.8254 130.098 60.4969 130.769 61.3253 130.769H117.393C118.221 130.769 118.893 130.098 118.893 129.269V127.365C118.893 126.537 118.221 125.865 117.393 125.865H61.3253Z" fill="url(#paint3_linear_1299_1427)"/>
 6 |     <path d="M127.096 137.173C127.096 136.345 127.768 135.673 128.596 135.673H161.693C162.522 135.673 163.193 136.345 163.193 137.173V139.077C163.193 139.905 162.522 140.577 161.693 140.577H128.596C127.768 140.577 127.096 139.905 127.096 139.077V137.173Z" fill="url(#paint4_linear_1299_1427)"/>
 7 |     <path d="M146.646 125.865C145.817 125.865 145.146 126.537 145.146 127.365V129.269C145.146 130.098 145.817 130.769 146.646 130.769H179.743C180.571 130.769 181.243 130.098 181.243 129.269V127.365C181.243 126.537 180.571 125.865 179.743 125.865H146.646Z" fill="url(#paint5_linear_1299_1427)"/>
 8 |     <path d="M41.7772 127.365C41.7772 126.537 42.4487 125.865 43.2771 125.865H53.4035C54.2319 125.865 54.9034 126.537 54.9034 127.365V129.269C54.9034 130.098 54.2319 130.769 53.4035 130.769H43.2771C42.4487 130.769 41.7772 130.098 41.7772 129.269V127.365Z" fill="url(#paint6_linear_1299_1427)"/>
 9 |     <path d="M126.956 125.865C126.128 125.865 125.456 126.537 125.456 127.365V129.269C125.456 130.098 126.128 130.769 126.956 130.769H137.082C137.911 130.769 138.582 130.098 138.582 129.269V127.365C138.582 126.537 137.911 125.865 137.082 125.865H126.956Z" fill="url(#paint7_linear_1299_1427)"/>
10 |     <path d="M18.806 137.173C18.806 136.345 19.4775 135.673 20.3058 135.673H107.548C108.377 135.673 109.048 136.345 109.048 137.173V139.077C109.048 139.905 108.377 140.577 107.548 140.577H20.3058C19.4775 140.577 18.806 139.905 18.806 139.077V137.173Z" fill="url(#paint8_linear_1299_1427)"/>
11 |     <path d="M46.5587 145.481C45.7303 145.481 45.0588 146.152 45.0588 146.981V148.885C45.0588 149.713 45.7303 150.385 46.5587 150.385H112.471C113.3 150.385 113.971 149.713 113.971 148.885V146.981C113.971 146.152 113.3 145.481 112.471 145.481H46.5587Z" fill="url(#paint9_linear_1299_1427)"/>
12 |     <path d="M72.9518 156.788C72.9518 155.96 73.6233 155.288 74.4517 155.288H119.034C119.863 155.288 120.534 155.96 120.534 156.788V158.692C120.534 159.521 119.863 160.192 119.034 160.192H74.4517C73.6233 160.192 72.9518 159.521 72.9518 158.692V156.788Z" fill="url(#paint10_linear_1299_1427)"/>
13 |     <path d="M82.7967 166.596C82.7967 165.768 83.4682 165.096 84.2965 165.096H102.627C103.455 165.096 104.127 165.768 104.127 166.596V168.5C104.127 169.328 103.455 170 102.627 170H84.2965C83.4682 170 82.7967 169.328 82.7967 168.5V166.596Z" fill="url(#paint11_linear_1299_1427)"/>
14 |     <defs>
15 |         <linearGradient id="paint0_linear_1299_1427" x1="-33.6235" y1="-21.9603" x2="-33.6235" y2="212.808" gradientUnits="userSpaceOnUse">
16 |             <stop stop-color="#F7C300"/>
17 |             <stop offset="0.611485" stop-color="#FA006A"/>
18 |         </linearGradient>
19 |         <linearGradient id="paint1_linear_1299_1427" x1="-33.6235" y1="-21.9603" x2="-33.6235" y2="212.808" gradientUnits="userSpaceOnUse">
20 |             <stop stop-color="#F7C300"/>
21 |             <stop offset="0.611485" stop-color="#FA006A"/>
22 |         </linearGradient>
23 |         <linearGradient id="paint2_linear_1299_1427" x1="-33.6235" y1="-21.9603" x2="-33.6235" y2="212.808" gradientUnits="userSpaceOnUse">
24 |             <stop stop-color="#F7C300"/>
25 |             <stop offset="0.611485" stop-color="#FA006A"/>
26 |         </linearGradient>
27 |         <linearGradient id="paint3_linear_1299_1427" x1="-33.6235" y1="-21.9603" x2="-33.6235" y2="212.808" gradientUnits="userSpaceOnUse">
28 |             <stop stop-color="#F7C300"/>
29 |             <stop offset="0.611485" stop-color="#FA006A"/>
30 |         </linearGradient>
31 |         <linearGradient id="paint4_linear_1299_1427" x1="-33.6235" y1="-21.9603" x2="-33.6235" y2="212.808" gradientUnits="userSpaceOnUse">
32 |             <stop stop-color="#F7C300"/>
33 |             <stop offset="0.611485" stop-color="#FA006A"/>
34 |         </linearGradient>
35 |         <linearGradient id="paint5_linear_1299_1427" x1="-33.6235" y1="-21.9603" x2="-33.6235" y2="212.808" gradientUnits="userSpaceOnUse">
36 |             <stop stop-color="#F7C300"/>
37 |             <stop offset="0.611485" stop-color="#FA006A"/>
38 |         </linearGradient>
39 |         <linearGradient id="paint6_linear_1299_1427" x1="-33.6235" y1="-21.9603" x2="-33.6235" y2="212.808" gradientUnits="userSpaceOnUse">
40 |             <stop stop-color="#F7C300"/>
41 |             <stop offset="0.611485" stop-color="#FA006A"/>
42 |         </linearGradient>
43 |         <linearGradient id="paint7_linear_1299_1427" x1="-33.6235" y1="-21.9603" x2="-33.6235" y2="212.808" gradientUnits="userSpaceOnUse">
44 |             <stop stop-color="#F7C300"/>
45 |             <stop offset="0.611485" stop-color="#FA006A"/>
46 |         </linearGradient>
47 |         <linearGradient id="paint8_linear_1299_1427" x1="-33.6235" y1="-21.9603" x2="-33.6235" y2="212.808" gradientUnits="userSpaceOnUse">
48 |             <stop stop-color="#F7C300"/>
49 |             <stop offset="0.611485" stop-color="#FA006A"/>
50 |         </linearGradient>
51 |         <linearGradient id="paint9_linear_1299_1427" x1="-33.6235" y1="-21.9603" x2="-33.6235" y2="212.808" gradientUnits="userSpaceOnUse">
52 |             <stop stop-color="#F7C300"/>
53 |             <stop offset="0.611485" stop-color="#FA006A"/>
54 |         </linearGradient>
55 |         <linearGradient id="paint10_linear_1299_1427" x1="-33.6235" y1="-21.9603" x2="-33.6235" y2="212.808" gradientUnits="userSpaceOnUse">
56 |             <stop stop-color="#F7C300"/>
57 |             <stop offset="0.611485" stop-color="#FA006A"/>
58 |         </linearGradient>
59 |         <linearGradient id="paint11_linear_1299_1427" x1="-33.6235" y1="-21.9603" x2="-33.6235" y2="212.808" gradientUnits="userSpaceOnUse">
60 |             <stop stop-color="#F7C300"/>
61 |             <stop offset="0.611485" stop-color="#FA006A"/>
62 |         </linearGradient>
63 |     </defs>
64 | </svg>
65 | 


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