ERPC Bitcoin RPC エンドポイント ドキュメント
Bitcoin RPC エンドポイント ドキュメント
ERPC を Bitcoin RPC エンドポイントとして、HTTP JSON-RPC リクエストにご利用いただけます。Bitcoin RPC は、Global Edge Blockchain Infrastructure における ERPC の RPC APIs の一部であり、API key は ERPC Web Dashboard から管理できます。
Solana、Ethereum、Avalanche と同じ RPC キーを利用できます。
API key は
api-key クエリパラメータで渡すか、Authorization: Bearer <YOUR_API_KEY> として送信してください。両方が指定された場合は、クエリパラメータが使われます。エンドポイント
JSON-RPC リクエストは、次の URL に対して HTTP POST で送信します。
text
https://edge.erpc.global/bitcoin?api-key=<YOUR_API_KEY>https://edge.erpc.global/bitcoin?api-key=<YOUR_API_KEY>または、次の専用ホストに送信します。
text
https://bitcoin.erpc.global?api-key=<YOUR_API_KEY>https://bitcoin.erpc.global?api-key=<YOUR_API_KEY>リクエストは
/ でのみ受け付けます。使用例
API key をクエリパラメータで指定した HTTP リクエストの例です。
bash
curl 'https://edge.erpc.global/bitcoin?api-key=<YOUR_API_KEY>' --header 'Content-Type: application/json' --data '{
"jsonrpc":"1.0","id":1,
"method":"getblockcount",
"params":[]
}'curl 'https://edge.erpc.global/bitcoin?api-key=<YOUR_API_KEY>' --header 'Content-Type: application/json' --data '{
"jsonrpc":"1.0","id":1,
"method":"getblockcount",
"params":[]
}'API key を
Authorization ヘッダーで指定した、同じリクエストの例です。bash
curl 'https://edge.erpc.global/bitcoin' --header 'Content-Type: application/json' --header 'Authorization: Bearer <YOUR_API_KEY>' --data '{
"jsonrpc":"1.0","id":1,
"method":"getblockcount",
"params":[]
}'curl 'https://edge.erpc.global/bitcoin' --header 'Content-Type: application/json' --header 'Authorization: Bearer <YOUR_API_KEY>' --data '{
"jsonrpc":"1.0","id":1,
"method":"getblockcount",
"params":[]
}'Bitcoin では
jsonrpc を 1.0 または 2.0 に設定するか、省略できます。すべての呼び出しに id が必要です。API key は ERPC Web Dashboard 上にて取得、確認いただけます: ERPC Web Dashboard
バッチリクエスト
1 回の HTTP リクエストにつき 1〜100 件の呼び出しを含む JSON-RPC バッチに対応しています。各呼び出しにはそれぞれ
id が必要で、バッチ内で id の値を重複させることはできません。バッチ内の各呼び出しは、それぞれ個別の呼び出しとして計測されます。リクエストボディの上限は 1 MiB です。利用量の計測
利用量は token として計測され、token レートはメソッドによって異なる場合があります。HTTP バッチ内の各呼び出しは、それぞれ個別に計測されます。
Free プランの制限
Free プランでは、お使いのアカウントから送信できるのは 10 秒に 1 リクエストまでです。この制限はエンドポイントごとではなくアカウントごとに数えられるため、別のチェーンへのリクエストも数えられることがあります。それより早く送ったリクエストには HTTP
429 が返され、retry-after ヘッダーに待機する秒数が示されます。Free プランでは、2 件以上の JSON-RPC 呼び出しを含むリクエストには HTTP
429 が返され、そのリクエストの呼び出しはどれも送信されません。それぞれの呼び出しには、コード -32041 の JSON-RPC エラーが返されます。代わりに、これらの呼び出しを 1 件ずつ送信してください。対応メソッド
本エンドポイントは、次の 32 個の Bitcoin Core JSON-RPC メソッドを提供します。
decoderawtransaction, decodescript, estimatesmartfee, getbestblockhash, getblock, getblockchaininfo, getblockcount, getblockfilter, getblockhash, getblockheader, getblockstats, getchaintips, getchaintxstats, getconnectioncount, getdifficulty, getmempoolancestors, getmempooldescendants, getmempoolinfo, getmininginfo, getnetworkinfo, getrawmempool, getrawtransaction, gettransaction, gettxout, gettxoutproof, gettxoutsetinfo, sendrawtransaction, testmempoolaccept, validateaddress, verifychain, verifymessage, verifytxoutproof一覧にないメソッドには HTTP
400 が返されます。レスポンスステータスコード
| HTTP ステータス | 意味 |
|---|---|
| 200 | アップストリームの JSON-RPC レスポンス。JSON-RPC エラーも HTTP 200 で返されます。リクエストの id と error.code はそのまま保たれ、error.message は ERPC upstream error になり、error.data は返されません |
| 400 | 「対応メソッド」にないメソッドまたはパス、無効な JSON-RPC リクエスト、空のバッチまたは 100 件を超えるバッチ、バッチ内の重複した id、1 MiB を超えるリクエストボディ |
| 401 | API key が未指定または無効、もしくはキーに設定された IP・Origin の制限を満たしていません |
| 405 | POST 以外のリクエストメソッド |
| 426 | WebSocket Upgrade が要求されました。このエンドポイントは HTTP 専用です |
| 429 | レート制限。上記の Free プランの制限（10 秒に 1 リクエストを超える送信、または 1 回のリクエストに 2 件以上の呼び出し）も対象です。retry-after ヘッダーがある場合は、示された秒数だけ待機してください |
| 502 | アップストリームへのリクエストを完了できませんでした（アップストリームの応答が失敗した、応答が 8 MiB を超えた、または 30 秒以内に応答がなかった） |
| 503 | サービスが一時的に利用できません |
Bitcoin RPC メソッドとドキュメント
標準メソッド、パラメータ、仕様の全一覧については、公式ドキュメントをご参照ください。