Skip to content

Commit 232f2fb

Browse files
authored
Merge pull request #14541 from 0xshikhar/dev
add JSON-RPC endpoint playground links
2 parents a9fb7b4 + 4e197de commit 232f2fb

File tree

1 file changed

+100
-0
lines changed
  • public/content/developers/docs/apis/json-rpc

1 file changed

+100
-0
lines changed

public/content/developers/docs/apis/json-rpc/index.md

Lines changed: 100 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -303,6 +303,10 @@ curl -X POST --data '{"jsonrpc":"2.0","method":"eth_protocolVersion","params":[]
303303

304304
Returns an object with data about the sync status or `false`.
305305

306+
<ButtonLink size="sm" variant="outline" href="https://ethereum-json-rpc.com/?method=eth_syncing">
307+
Try endpoint in playground
308+
</ButtonLink>
309+
306310
**Parameters**
307311

308312
None
@@ -387,6 +391,10 @@ curl -X POST --data '{"jsonrpc":"2.0","method":"eth_syncing","params":[],"id":1}
387391

388392
Returns the client coinbase address.
389393

394+
<ButtonLink size="sm" variant="outline" href="https://ethereum-json-rpc.com/?method=eth_coinbase">
395+
Try endpoint in playground
396+
</ButtonLink>
397+
390398
> **Note:** This method has been deprecated as of **v1.14.0** and is no longer supported. Attempting to use this method will result in a "Method not supported" error.
391399
392400
**Parameters**
@@ -414,6 +422,10 @@ curl -X POST --data '{"jsonrpc":"2.0","method":"eth_coinbase","params":[],"id":6
414422

415423
Returns the chain ID used for signing replay-protected transactions.
416424

425+
<ButtonLink size="sm" variant="outline" href="https://ethereum-json-rpc.com/?method=eth_chainId">
426+
Try endpoint in playground
427+
</ButtonLink>
428+
417429
**Parameters**
418430

419431
None
@@ -439,6 +451,10 @@ curl -X POST --data '{"jsonrpc":"2.0","method":"eth_chainId","params":[],"id":67
439451

440452
Returns `true` if client is actively mining new blocks. This can only return `true` for proof-of-work networks and may not be available in some clients since [The Merge](/roadmap/merge/).
441453

454+
<ButtonLink size="sm" variant="outline" href="https://ethereum-json-rpc.com/?method=eth_mining">
455+
Try endpoint in playground
456+
</ButtonLink>
457+
442458
**Parameters**
443459

444460
None
@@ -464,6 +480,10 @@ curl -X POST --data '{"jsonrpc":"2.0","method":"eth_mining","params":[],"id":71}
464480

465481
Returns the number of hashes per second that the node is mining with. This can only return `true` for proof-of-work networks and may not be available in some clients since [The Merge](/roadmap/merge/).
466482

483+
<ButtonLink size="sm" variant="outline" href="https://ethereum-json-rpc.com/?method=eth_hashrate">
484+
Try endpoint in playground
485+
</ButtonLink>
486+
467487
**Parameters**
468488

469489
None
@@ -489,6 +509,10 @@ curl -X POST --data '{"jsonrpc":"2.0","method":"eth_hashrate","params":[],"id":7
489509

490510
Returns an estimate of the current price per gas in wei. For example, the Besu client examines the last 100 blocks and returns the median gas unit price by default.
491511

512+
<ButtonLink size="sm" variant="outline" href="https://ethereum-json-rpc.com/?method=eth_gasPrice">
513+
Try endpoint in playground
514+
</ButtonLink>
515+
492516
**Parameters**
493517

494518
None
@@ -514,6 +538,10 @@ curl -X POST --data '{"jsonrpc":"2.0","method":"eth_gasPrice","params":[],"id":7
514538

515539
Returns a list of addresses owned by client.
516540

541+
<ButtonLink size="sm" variant="outline" href="https://ethereum-json-rpc.com/?method=eth_accounts">
542+
Try endpoint in playground
543+
</ButtonLink>
544+
517545
**Parameters**
518546

519547
None
@@ -539,6 +567,10 @@ curl -X POST --data '{"jsonrpc":"2.0","method":"eth_accounts","params":[],"id":1
539567

540568
Returns the number of most recent block.
541569

570+
<ButtonLink size="sm" variant="outline" href="https://ethereum-json-rpc.com/?method=eth_blockNumber">
571+
Try endpoint in playground
572+
</ButtonLink>
573+
542574
**Parameters**
543575

544576
None
@@ -564,6 +596,10 @@ curl -X POST --data '{"jsonrpc":"2.0","method":"eth_blockNumber","params":[],"id
564596

565597
Returns the balance of the account of given address.
566598

599+
<ButtonLink size="sm" variant="outline" href="https://ethereum-json-rpc.com/?method=eth_getBalance">
600+
Try endpoint in playground
601+
</ButtonLink>
602+
567603
**Parameters**
568604

569605
1. `DATA`, 20 Bytes - address to check for balance.
@@ -594,6 +630,10 @@ curl -X POST --data '{"jsonrpc":"2.0","method":"eth_getBalance","params":["0x407
594630

595631
Returns the value from a storage position at a given address.
596632

633+
<ButtonLink size="sm" variant="outline" href="https://ethereum-json-rpc.com/?method=eth_getStorageAt">
634+
Try endpoint in playground
635+
</ButtonLink>
636+
597637
**Parameters**
598638

599639
1. `DATA`, 20 Bytes - address of the storage.
@@ -662,6 +702,10 @@ curl -X POST --data '{"jsonrpc":"2.0", "method": "eth_getStorageAt", "params": [
662702

663703
Returns the number of transactions _sent_ from an address.
664704

705+
<ButtonLink size="sm" variant="outline" href="https://ethereum-json-rpc.com/?method=eth_getTransactionCount">
706+
Try endpoint in playground
707+
</ButtonLink>
708+
665709
**Parameters**
666710

667711
1. `DATA`, 20 Bytes - address.
@@ -695,6 +739,10 @@ curl -X POST --data '{"jsonrpc":"2.0","method":"eth_getTransactionCount","params
695739

696740
Returns the number of transactions in a block from a block matching the given block hash.
697741

742+
<ButtonLink size="sm" variant="outline" href="https://ethereum-json-rpc.com/?method=eth_getBlockTransactionCountByHash">
743+
Try endpoint in playground
744+
</ButtonLink>
745+
698746
**Parameters**
699747

700748
1. `DATA`, 32 Bytes - hash of a block
@@ -724,6 +772,10 @@ curl -X POST --data '{"jsonrpc":"2.0","method":"eth_getBlockTransactionCountByHa
724772

725773
Returns the number of transactions in a block matching the given block number.
726774

775+
<ButtonLink size="sm" variant="outline" href="https://ethereum-json-rpc.com/?method=eth_getBlockTransactionCountByNumber">
776+
Try endpoint in playground
777+
</ButtonLink>
778+
727779
**Parameters**
728780

729781
1. `QUANTITY|TAG` - integer of a block number, or the string `"earliest"`, `"latest"`, `"pending"`, `"safe"` or `"finalized"`, as in the [block parameter](/developers/docs/apis/json-rpc/#block-parameter).
@@ -755,6 +807,10 @@ curl -X POST --data '{"jsonrpc":"2.0","method":"eth_getBlockTransactionCountByNu
755807

756808
Returns the number of uncles in a block from a block matching the given block hash.
757809

810+
<ButtonLink size="sm" variant="outline" href="https://ethereum-json-rpc.com/?method=eth_getUncleCountByBlockHash">
811+
Try endpoint in playground
812+
</ButtonLink>
813+
758814
**Parameters**
759815

760816
1. `DATA`, 32 Bytes - hash of a block
@@ -784,6 +840,10 @@ curl -X POST --data '{"jsonrpc":"2.0","method":"eth_getUncleCountByBlockHash","p
784840

785841
Returns the number of uncles in a block from a block matching the given block number.
786842

843+
<ButtonLink size="sm" variant="outline" href="https://ethereum-json-rpc.com/?method=eth_getUncleCountByBlockNumber">
844+
Try endpoint in playground
845+
</ButtonLink>
846+
787847
**Parameters**
788848

789849
1. `QUANTITY|TAG` - integer of a block number, or the string `"latest"`, `"earliest"`, `"pending"`, `"safe"` or `"finalized"`, see the [block parameter](/developers/docs/apis/json-rpc/#block-parameter)
@@ -815,6 +875,10 @@ curl -X POST --data '{"jsonrpc":"2.0","method":"eth_getUncleCountByBlockNumber",
815875

816876
Returns code at a given address.
817877

878+
<ButtonLink size="sm" variant="outline" href="https://ethereum-json-rpc.com/?method=eth_getCode">
879+
Try endpoint in playground
880+
</ButtonLink>
881+
818882
**Parameters**
819883

820884
1. `DATA`, 20 Bytes - address
@@ -994,6 +1058,10 @@ curl -X POST --data '{"jsonrpc":"2.0","method":"eth_sendRawTransaction","params"
9941058

9951059
Executes a new message call immediately without creating a transaction on the blockchain. Often used for executing read-only smart contract functions, for example the `balanceOf` for an ERC-20 contract.
9961060

1061+
<ButtonLink size="sm" variant="outline" href="https://ethereum-json-rpc.com/?method=eth_call">
1062+
Try endpoint in playground
1063+
</ButtonLink>
1064+
9971065
**Parameters**
9981066

9991067
1. `Object` - The transaction call object
@@ -1028,6 +1096,10 @@ curl -X POST --data '{"jsonrpc":"2.0","method":"eth_call","params":[{see above}]
10281096

10291097
Generates and returns an estimate of how much gas is necessary to allow the transaction to complete. The transaction will not be added to the blockchain. Note that the estimate may be significantly more than the amount of gas actually used by the transaction, for a variety of reasons including EVM mechanics and node performance.
10301098

1099+
<ButtonLink size="sm" variant="outline" href="https://ethereum-json-rpc.com/?method=eth_estimateGas">
1100+
Try endpoint in playground
1101+
</ButtonLink>
1102+
10311103
**Parameters**
10321104

10331105
See [eth_call](#eth_call) parameters, except that all properties are optional. If no gas limit is specified geth uses the block gas limit from the pending block as an upper bound. As a result the returned estimate might not be enough to executed the call/transaction when the amount of gas is higher than the pending block gas limit.
@@ -1053,6 +1125,10 @@ curl -X POST --data '{"jsonrpc":"2.0","method":"eth_estimateGas","params":[{see
10531125

10541126
Returns information about a block by hash.
10551127

1128+
<ButtonLink size="sm" variant="outline" href="https://ethereum-json-rpc.com/?method=eth_getBlockByHash">
1129+
Try endpoint in playground
1130+
</ButtonLink>
1131+
10561132
**Parameters**
10571133

10581134
1. `DATA`, 32 Bytes - Hash of a block.
@@ -1130,6 +1206,10 @@ curl -X POST --data '{"jsonrpc":"2.0","method":"eth_getBlockByHash","params":["0
11301206
11311207
Returns information about a block by block number.
11321208
1209+
<ButtonLink size="sm" variant="outline" href="https://ethereum-json-rpc.com/?method=eth_getBlockByNumber">
1210+
Try endpoint in playground
1211+
</ButtonLink>
1212+
11331213
**Parameters**
11341214
11351215
1. `QUANTITY|TAG` - integer of a block number, or the string `"earliest"`, `"latest"`, `"pending"`, `"safe"` or `"finalized"`, as in the [block parameter](/developers/docs/apis/json-rpc/#block-parameter).
@@ -1158,6 +1238,10 @@ Result see [eth_getBlockByHash](#eth_getblockbyhash)
11581238
11591239
Returns the information about a transaction requested by transaction hash.
11601240
1241+
<ButtonLink size="sm" variant="outline" href="https://ethereum-json-rpc.com/?method=eth_getTransactionByHash">
1242+
Try endpoint in playground
1243+
</ButtonLink>
1244+
11611245
**Parameters**
11621246
11631247
1. `DATA`, 32 Bytes - hash of a transaction
@@ -1217,6 +1301,10 @@ curl -X POST --data '{"jsonrpc":"2.0","method":"eth_getTransactionByHash","param
12171301
12181302
Returns information about a transaction by block hash and transaction index position.
12191303
1304+
<ButtonLink size="sm" variant="outline" href="https://ethereum-json-rpc.com/?method=eth_getTransactionByBlockHashAndIndex">
1305+
Try endpoint in playground
1306+
</ButtonLink>
1307+
12201308
**Parameters**
12211309
12221310
1. `DATA`, 32 Bytes - hash of a block.
@@ -1245,6 +1333,10 @@ Result see [eth_getTransactionByHash](#eth_gettransactionbyhash)
12451333
12461334
Returns information about a transaction by block number and transaction index position.
12471335
1336+
<ButtonLink size="sm" variant="outline" href="https://ethereum-json-rpc.com/?method=eth_getTransactionByBlockNumberAndIndex">
1337+
Try endpoint in playground
1338+
</ButtonLink>
1339+
12481340
**Parameters**
12491341
12501342
1. `QUANTITY|TAG` - a block number, or the string `"earliest"`, `"latest"`, `"pending"`, `"safe"` or `"finalized"`, as in the [block parameter](/developers/docs/apis/json-rpc/#block-parameter).
@@ -1341,6 +1433,10 @@ curl -X POST --data '{"jsonrpc":"2.0","method":"eth_getTransactionReceipt","para
13411433
13421434
Returns information about a uncle of a block by hash and uncle index position.
13431435
1436+
<ButtonLink size="sm" variant="outline" href="https://ethereum-json-rpc.com/?method=eth_getUncleByBlockHashAndIndex">
1437+
Try endpoint in playground
1438+
</ButtonLink>
1439+
13441440
**Parameters**
13451441
13461442
1. `DATA`, 32 Bytes - The hash of a block.
@@ -1371,6 +1467,10 @@ Result see [eth_getBlockByHash](#eth_getblockbyhash)
13711467
13721468
Returns information about a uncle of a block by number and uncle index position.
13731469
1470+
<ButtonLink size="sm" variant="outline" href="https://ethereum-json-rpc.com/?method=eth_getUncleByBlockNumberAndIndex">
1471+
Try endpoint in playground
1472+
</ButtonLink>
1473+
13741474
**Parameters**
13751475
13761476
1. `QUANTITY|TAG` - a block number, or the string `"earliest"`, `"latest"`, `"pending"`, `"safe"`, `"finalized"`, as in the [block parameter](/developers/docs/apis/json-rpc/#block-parameter).

0 commit comments

Comments
 (0)