Documentation Powered by ReDoc

Infura Filecoin Documentation (1.0.0)

Infura Support: support@infura.io

Securing Your Credentials

The Filecoin endpoint currently supports basic auth which requires passing in a username and password.

The username is your `Project ID` and password is your `Project Secret` which you can find by navigating to your project settings at `https://infura.io/dashboard/filecoin//settings`

Stateless and Streaming APIs

Most RPC methods are stateless and are made available through HTTPS. These can be queried with curl:

curl -X POST -H "Content-Type: application/json"
  --user <PROJECT_ID>:<PROJECT_SECRET>
  --url https://filecoin.infura.io
  --data '{ "id": 0, "jsonrpc": "2.0", "method": "Filecoin.ChainHead", "params": [] }'

Methods that are designed to stream updates to the client are available only through Websockets.

wscat can be used to try these from CLI.

wscat --auth <PROJECT_ID>:<PROJECT_SECRET> --connect wss://filecoin.infura.io

> { "jsonrpc": "2.0", "method": "Filecoin.ChainNotify", "params": [], "id": 3 }

Authentication

basicAuth

Security Scheme Type HTTP
HTTP Authorization Scheme basic

Chain

ChainNotify

ChainNotify returns channel with chain head updates. First message is guaranteed to be of len == 1, and type == 'current'.

Authorizations:
basicAuth
Request Body schema: application/json
id
required
number
jsonrpc
required
string
Value: "2.0"
method
required
string
Value: "Filecoin.ChainNotify"
params
required
Array of any

Responses

Request samples

Content type
application/json
{
  • "id": 0,
  • "jsonrpc": "2.0",
  • "method": "Filecoin.ChainNotify",
  • "params": [
    ]
}

Response samples

Content type
application/json
Example
ChainNotifyResponse
ChainNotifyResponse
ErrorResponse
{
  • "id": 0,
  • "jsonrpc": "2.0",
  • "result": [
    ]
}

ChainHead

ChainHead returns the current head of the chain.

Authorizations:
basicAuth
Request Body schema: application/json
id
required
number
jsonrpc
required
string
Value: "2.0"
method
required
string
Value: "Filecoin.ChainHead"
params
required
Array of any

Responses

Request samples

Content type
application/json
{
  • "id": 0,
  • "jsonrpc": "2.0",
  • "method": "Filecoin.ChainHead",
  • "params": [
    ]
}

Response samples

Content type
application/json
Example
ChainHeadResponse
ChainHeadResponse
ErrorResponse
{
  • "id": 0,
  • "jsonrpc": "2.0",
  • "result": "string"
}

ChainGetBlock

ChainGetBlock returns the block specified by the given CID.

Authorizations:
basicAuth
Request Body schema: application/json
id
required
number
jsonrpc
required
string
Value: "2.0"
method
required
string
Value: "Filecoin.ChainGetBlock"
required
Array of []byte (string) 1 items

Responses

Request samples

Content type
application/json
{
  • "id": 0,
  • "jsonrpc": "2.0",
  • "method": "Filecoin.ChainGetBlock",
  • "params": [
    ]
}

Response samples

Content type
application/json
Example
ChainGetBlockResponse
ChainGetBlockResponse
ErrorResponse
{
  • "id": 0,
  • "jsonrpc": "2.0",
  • "result": {
    }
}

ChainGetTipSet

ChainGetTipSet returns the tipset specified by the given TipSetKey.

Authorizations:
basicAuth
Request Body schema: application/json
id
required
number
jsonrpc
required
string
Value: "2.0"
method
required
string
Value: "Filecoin.ChainGetTipSet"
required
Array of TipSetKey (string) 1 items

Responses

Request samples

Content type
application/json
{
  • "id": 0,
  • "jsonrpc": "2.0",
  • "method": "Filecoin.ChainGetTipSet",
  • "params": [
    ]
}

Response samples

Content type
application/json
Example
ChainGetTipSetResponse
ChainGetTipSetResponse
ErrorResponse
{
  • "id": 0,
  • "jsonrpc": "2.0",
  • "result": "string"
}

ChainGetBlockMessages

ChainGetBlockMessages returns messages stored in the specified block.

Authorizations:
basicAuth
Request Body schema: application/json
id
required
number
jsonrpc
required
string
Value: "2.0"
method
required
string
Value: "Filecoin.ChainGetBlockMessages"
required
Array of []byte (string) 1 items

Responses

Request samples

Content type
application/json
{
  • "id": 0,
  • "jsonrpc": "2.0",
  • "method": "Filecoin.ChainGetBlockMessages",
  • "params": [
    ]
}

Response samples

Content type
application/json
Example
ChainGetBlockMessagesResponse
ChainGetBlockMessagesResponse
ErrorResponse
{
  • "id": 0,
  • "jsonrpc": "2.0",
  • "result": {
    }
}

ChainGetParentReceipts

ChainGetParentReceipts returns receipts for messages in parent tipset of the specified block.

Authorizations:
basicAuth
Request Body schema: application/json
id
required
number
jsonrpc
required
string
Value: "2.0"
method
required
string
Value: "Filecoin.ChainGetParentReceipts"
required
Array of []byte (string) 1 items

Responses

Request samples

Content type
application/json
{
  • "id": 0,
  • "jsonrpc": "2.0",
  • "method": "Filecoin.ChainGetParentReceipts",
  • "params": [
    ]
}

Response samples

Content type
application/json
Example
ChainGetParentReceiptsResponse
ChainGetParentReceiptsResponse
ErrorResponse
{
  • "id": 0,
  • "jsonrpc": "2.0",
  • "result": [
    ]
}

ChainGetParentMessages

ChainGetParentMessages returns messages stored in parent tipset of the specified block.

Authorizations:
basicAuth
Request Body schema: application/json
id
required
number
jsonrpc
required
string
Value: "2.0"
method
required
string
Value: "Filecoin.ChainGetParentMessages"
required
Array of []byte (string) 1 items

Responses

Request samples

Content type
application/json
{
  • "id": 0,
  • "jsonrpc": "2.0",
  • "method": "Filecoin.ChainGetParentMessages",
  • "params": [
    ]
}

Response samples

Content type
application/json
Example
ChainGetParentMessagesResponse
ChainGetParentMessagesResponse
ErrorResponse
{
  • "id": 0,
  • "jsonrpc": "2.0",
  • "result": [
    ]
}

ChainGetTipSetByHeight

ChainGetTipSetByHeight looks back for a tipset at the specified epoch. If there are no blocks at the specified epoch, a tipset at an earlier epoch will be returned.

Authorizations:
basicAuth
Request Body schema: application/json
id
required
number
jsonrpc
required
string
Value: "2.0"
method
required
string
Value: "Filecoin.ChainGetTipSetByHeight"
required
Array of ChainEpoch (integer) or TipSetKey (string) 2 items

Responses

Request samples

Content type
application/json
{
  • "id": 0,
  • "jsonrpc": "2.0",
  • "method": "Filecoin.ChainGetTipSetByHeight",
  • "params": [
    ]
}

Response samples

Content type
application/json
Example
ChainGetTipSetByHeightResponse
ChainGetTipSetByHeightResponse
ErrorResponse
{
  • "id": 0,
  • "jsonrpc": "2.0",
  • "result": "string"
}

ChainReadObj

ChainReadObj reads ipld nodes referenced by the specified CID from chain blockstore and returns raw bytes.

Authorizations:
basicAuth
Request Body schema: application/json
id
required
number
jsonrpc
required
string
Value: "2.0"
method
required
string
Value: "Filecoin.ChainReadObj"
required
Array of []byte (string) 1 items

Responses

Request samples

Content type
application/json
{
  • "id": 0,
  • "jsonrpc": "2.0",
  • "method": "Filecoin.ChainReadObj",
  • "params": [
    ]
}

Response samples

Content type
application/json
Example
ChainReadObjResponse
ChainReadObjResponse
ErrorResponse
{
  • "id": 0,
  • "jsonrpc": "2.0",
  • "result": "string"
}

ChainHasObj

ChainHasObj checks if a given CID exists in the chain blockstore.

Authorizations:
basicAuth
Request Body schema: application/json
id
required
number
jsonrpc
required
string
Value: "2.0"
method
required
string
Value: "Filecoin.ChainHasObj"
required
Array of []byte (string) 1 items

Responses

Request samples

Content type
application/json
{
  • "id": 0,
  • "jsonrpc": "2.0",
  • "method": "Filecoin.ChainHasObj",
  • "params": [
    ]
}

Response samples

Content type
application/json
Example
ChainHasObjResponse
ChainHasObjResponse
ErrorResponse
{
  • "id": 0,
  • "jsonrpc": "2.0",
  • "result": true
}

ChainStatObj

ChainStatObj returns statistics about the graph referenced by 'obj'. If 'base' is also specified, then the returned stat will be a diff between the two objects.

Authorizations:
basicAuth
Request Body schema: application/json
id
required
number
jsonrpc
required
string
Value: "2.0"
method
required
string
Value: "Filecoin.ChainStatObj"
required
Array of []byte (string) or []byte (string) 2 items

Responses

Request samples

Content type
application/json
{
  • "id": 0,
  • "jsonrpc": "2.0",
  • "method": "Filecoin.ChainStatObj",
  • "params": [
    ]
}

Response samples

Content type
application/json
Example
ChainStatObjResponse
ChainStatObjResponse
ErrorResponse
{
  • "id": 0,
  • "jsonrpc": "2.0",
  • "result": {
    }
}

ChainGetGenesis

ChainGetGenesis returns the genesis tipset. ChainTipSetWeight computes weight for the specified tipset.

Authorizations:
basicAuth
Request Body schema: application/json
id
required
number
jsonrpc
required
string
Value: "2.0"
method
required
string
Value: "Filecoin.ChainGetGenesis"
params
required
Array of any

Responses

Request samples

Content type
application/json
{
  • "id": 0,
  • "jsonrpc": "2.0",
  • "method": "Filecoin.ChainGetGenesis",
  • "params": [
    ]
}

Response samples

Content type
application/json
Example
ChainGetGenesisResponse
ChainGetGenesisResponse
ErrorResponse
{
  • "id": 0,
  • "jsonrpc": "2.0",
  • "result": "string"
}

ChainTipSetWeight

Authorizations:
basicAuth
Request Body schema: application/json
id
required
number
jsonrpc
required
string
Value: "2.0"
method
required
string
Value: "Filecoin.ChainTipSetWeight"
required
Array of TipSetKey (string) 1 items

Responses

Request samples

Content type
application/json
{
  • "id": 0,
  • "jsonrpc": "2.0",
  • "method": "Filecoin.ChainTipSetWeight",
  • "params": [
    ]
}

Response samples

Content type
application/json
Example
ChainTipSetWeightResponse
ChainTipSetWeightResponse
ErrorResponse
{
  • "id": 0,
  • "jsonrpc": "2.0",
  • "result": "string"
}

ChainGetMessage

ChainGetMessage reads a message referenced by the specified CID from the chain blockstore.

Authorizations:
basicAuth
Request Body schema: application/json
id
required
number
jsonrpc
required
string
Value: "2.0"
method
required
string
Value: "Filecoin.ChainGetMessage"
required
Array of []byte (string) 1 items

Responses

Request samples

Content type
application/json
{
  • "id": 0,
  • "jsonrpc": "2.0",
  • "method": "Filecoin.ChainGetMessage",
  • "params": [
    ]
}

Response samples

Content type
application/json
Example
ChainGetMessageResponse
ChainGetMessageResponse
ErrorResponse
{
  • "id": 0,
  • "jsonrpc": "2.0",
  • "result": "string"
}

ChainGetPath

ChainGetPath returns a set of revert/apply operations needed to get from one tipset to another, for example:to ^ from tAA ^ ^ tBA tAB ^---*--^ ^ tRR Would return [revert(tBA), apply(tAB), apply(tAA)]

Authorizations:
basicAuth
Request Body schema: application/json
id
required
number
jsonrpc
required
string
Value: "2.0"
method
required
string
Value: "Filecoin.ChainGetPath"
required
Array of TipSetKey (string) or TipSetKey (string) 2 items

Responses

Request samples

Content type
application/json
{
  • "id": 0,
  • "jsonrpc": "2.0",
  • "method": "Filecoin.ChainGetPath",
  • "params": [
    ]
}

Response samples

Content type
application/json
Example
ChainGetPathResponse
ChainGetPathResponse
ErrorResponse
{
  • "id": 0,
  • "jsonrpc": "2.0",
  • "result": [
    ]
}

Gas

GasEstimateFeeCap

GasEstimateFeeCap estimates gas fee cap

Authorizations:
basicAuth
Request Body schema: application/json
id
required
number
jsonrpc
required
string
Value: "2.0"
method
required
string
Value: "Filecoin.GasEstimateFeeCap"
required
Array of Message (string) or int64 (integer) or TipSetKey (string) 3 items

Responses

Request samples

Content type
application/json
{
  • "id": 0,
  • "jsonrpc": "2.0",
  • "method": "Filecoin.GasEstimateFeeCap",
  • "params": [
    ]
}

Response samples

Content type
application/json
Example
GasEstimateFeeCapResponse
GasEstimateFeeCapResponse
ErrorResponse
{
  • "id": 0,
  • "jsonrpc": "2.0",
  • "result": "string"
}

GasEstimateGasLimit

GasEstimateGasLimit estimates gas used by the message and returns it. It fails if message fails to execute.

Authorizations:
basicAuth
Request Body schema: application/json
id
required
number
jsonrpc
required
string
Value: "2.0"
method
required
string
Value: "Filecoin.GasEstimateGasLimit"
required
Array of Message (string) or TipSetKey (string) 2 items

Responses

Request samples

Content type
application/json
{
  • "id": 0,
  • "jsonrpc": "2.0",
  • "method": "Filecoin.GasEstimateGasLimit",
  • "params": [
    ]
}

Response samples

Content type
application/json
Example
GasEstimateGasLimitResponse
GasEstimateGasLimitResponse
ErrorResponse
{
  • "id": 0,
  • "jsonrpc": "2.0",
  • "result": 0
}

GasEstimateGasPremium

Authorizations:
basicAuth
Request Body schema: application/json
id
required
number
jsonrpc
required
string
Value: "2.0"
method
required
string
Value: "Filecoin.GasEstimateGasPremium"
required
Array of uint64 (integer) or Address (string) or int64 (integer) or TipSetKey (string) 4 items

Responses

Request samples

Content type
application/json
{
  • "id": 0,
  • "jsonrpc": "2.0",
  • "method": "Filecoin.GasEstimateGasPremium",
  • "params": [
    ]
}

Response samples

Content type
application/json
Example
GasEstimateGasPremiumResponse
GasEstimateGasPremiumResponse
ErrorResponse
{
  • "id": 0,
  • "jsonrpc": "2.0",
  • "result": "string"
}

GasEstimateMessageGas

GasEstimateMessageGas estimates gas values for unset message gas fields

Authorizations:
basicAuth
Request Body schema: application/json
id
required
number
jsonrpc
required
string
Value: "2.0"
method
required
string
Value: "Filecoin.GasEstimateMessageGas"
required
Array of Message (string) or MessageSendSpec (object) or TipSetKey (string) 3 items

Responses

Request samples

Content type
application/json
{
  • "id": 0,
  • "jsonrpc": "2.0",
  • "method": "Filecoin.GasEstimateMessageGas",
  • "params": [
    ]
}

Response samples

Content type
application/json
Example
GasEstimateMessageGasResponse
GasEstimateMessageGasResponse
ErrorResponse
{
  • "id": 0,
  • "jsonrpc": "2.0",
  • "result": "string"
}

Sync

SyncState

SyncState returns the current status of the lotus sync system.

Authorizations:
basicAuth
Request Body schema: application/json
id
required
number
jsonrpc
required
string
Value: "2.0"
method
required
string
Value: "Filecoin.SyncState"
params
required
Array of any

Responses

Request samples

Content type
application/json
{
  • "id": 0,
  • "jsonrpc": "2.0",
  • "method": "Filecoin.SyncState",
  • "params": [
    ]
}

Response samples

Content type
application/json
Example
SyncStateResponse
SyncStateResponse
ErrorResponse
{
  • "id": 0,
  • "jsonrpc": "2.0",
  • "result": {
    }
}

SyncIncomingBlocks

SyncIncomingBlocks returns a channel streaming incoming, potentially not yet synced block headers.

Authorizations:
basicAuth
Request Body schema: application/json
id
required
number
jsonrpc
required
string
Value: "2.0"
method
required
string
Value: "Filecoin.SyncIncomingBlocks"
params
required
Array of any

Responses

Request samples

Content type
application/json
{
  • "id": 0,
  • "jsonrpc": "2.0",
  • "method": "Filecoin.SyncIncomingBlocks",
  • "params": [
    ]
}

Response samples

Content type
application/json
Example
SyncIncomingBlocksResponse
SyncIncomingBlocksResponse
ErrorResponse
{
  • "id": 0,
  • "jsonrpc": "2.0",
  • "result": {
    }
}

Mpool

MpoolPending

MpoolPending returns pending mempool messages.

Authorizations:
basicAuth
Request Body schema: application/json
id
required
number
jsonrpc
required
string
Value: "2.0"
method
required
string
Value: "Filecoin.MpoolPending"
required
Array of TipSetKey (string) 1 items

Responses

Request samples

Content type
application/json
{
  • "id": 0,
  • "jsonrpc": "2.0",
  • "method": "Filecoin.MpoolPending",
  • "params": [
    ]
}

Response samples

Content type
application/json
Example
MpoolPendingResponse
MpoolPendingResponse
ErrorResponse
{
  • "id": 0,
  • "jsonrpc": "2.0",
  • "result": [
    ]
}

MpoolPush

MpoolPush pushes a signed message to mempool.

Authorizations:
basicAuth
Request Body schema: application/json
id
required
number
jsonrpc
required
string
Value: "2.0"
method
required
string
Value: "Filecoin.MpoolPush"
required
Array of SignedMessage (string) 1 items

Responses

Request samples

Content type
application/json
{
  • "id": 0,
  • "jsonrpc": "2.0",
  • "method": "Filecoin.MpoolPush",
  • "params": [
    ]
}

Response samples

Content type
application/json
Example
MpoolPushResponse
MpoolPushResponse
ErrorResponse
{
  • "id": 0,
  • "jsonrpc": "2.0",
  • "result": "string"
}

MpoolGetNonce

Authorizations:
basicAuth
Request Body schema: application/json
id
required
number
jsonrpc
required
string
Value: "2.0"
method
required
string
Value: "Filecoin.MpoolGetNonce"
required
Array of Address (string) 1 items

Responses

Request samples

Content type
application/json
{
  • "id": 0,
  • "jsonrpc": "2.0",
  • "method": "Filecoin.MpoolGetNonce",
  • "params": [
    ]
}

Response samples

Content type
application/json
Example
MpoolGetNonceResponse
MpoolGetNonceResponse
ErrorResponse
{
  • "id": 0,
  • "jsonrpc": "2.0",
  • "result": 0
}

MpoolSub

Authorizations:
basicAuth
Request Body schema: application/json
id
required
number
jsonrpc
required
string
Value: "2.0"
method
required
string
Value: "Filecoin.MpoolSub"
params
required
Array of any

Responses

Request samples

Content type
application/json
{
  • "id": 0,
  • "jsonrpc": "2.0",
  • "method": "Filecoin.MpoolSub",
  • "params": [
    ]
}

Response samples

Content type
application/json
Example
MpoolSubResponse
MpoolSubResponse
ErrorResponse
{
  • "id": 0,
  • "jsonrpc": "2.0",
  • "result": {
    }
}

Wallet

WalletBalance

WalletBalance returns the balance of the given address at the current head of the chain.

Authorizations:
basicAuth
Request Body schema: application/json
id
required
number
jsonrpc
required
string
Value: "2.0"
method
required
string
Value: "Filecoin.WalletBalance"
required
Array of Address (string) 1 items

Responses

Request samples

Content type
application/json
{
  • "id": 0,
  • "jsonrpc": "2.0",
  • "method": "Filecoin.WalletBalance",
  • "params": [
    ]
}

Response samples

Content type
application/json
Example
WalletBalanceResponse
WalletBalanceResponse
ErrorResponse
{
  • "id": 0,
  • "jsonrpc": "2.0",
  • "result": "string"
}

WalletVerify

WalletVerify takes an address, a signature, and some bytes, and indicates whether the signature is valid. The address does not have to be in the wallet.

Authorizations:
basicAuth
Request Body schema: application/json
id
required
number
jsonrpc
required
string
Value: "2.0"
method
required
string
Value: "Filecoin.WalletVerify"
required
Array of Address (string) or []byte (string) or Signature (object) 3 items

Responses

Request samples

Content type
application/json
{
  • "id": 0,
  • "jsonrpc": "2.0",
  • "method": "Filecoin.WalletVerify",
  • "params": [
    ]
}

Response samples

Content type
application/json
Example
WalletVerifyResponse
WalletVerifyResponse
ErrorResponse
{
  • "id": 0,
  • "jsonrpc": "2.0",
  • "result": true
}

WalletValidateAddress

WalletValidateAddress validates whether a given string can be decoded as a well-formed address

Authorizations:
basicAuth
Request Body schema: application/json
id
required
number
jsonrpc
required
string
Value: "2.0"
method
required
string
Value: "Filecoin.WalletValidateAddress"
required
Array of strings (string) 1 items

Responses

Request samples

Content type
application/json
{
  • "id": 0,
  • "jsonrpc": "2.0",
  • "method": "Filecoin.WalletValidateAddress",
  • "params": [
    ]
}

Response samples

Content type
application/json
Example
WalletValidateAddressResponse
WalletValidateAddressResponse
ErrorResponse
{
  • "id": 0,
  • "jsonrpc": "2.0",
  • "result": "string"
}

Client

ClientQueryAsk

ClientQueryAsk returns a signed StorageAsk from the specified miner.

Authorizations:
basicAuth
Request Body schema: application/json
id
required
number
jsonrpc
required
string
Value: "2.0"
method
required
string
Value: "Filecoin.ClientQueryAsk"
required
Array of ID (string) or Address (string) 2 items

Responses

Request samples

Content type
application/json
{
  • "id": 0,
  • "jsonrpc": "2.0",
  • "method": "Filecoin.ClientQueryAsk",
  • "params": [
    ]
}

Response samples

Content type
application/json
Example
ClientQueryAskResponse
ClientQueryAskResponse
ErrorResponse
{
  • "id": 0,
  • "jsonrpc": "2.0",
  • "result": {
    }
}

State

StateGetActor

StateGetActor returns the indicated actor's nonce and balance.

Authorizations:
basicAuth
Request Body schema: application/json
id
required
number
jsonrpc
required
string
Value: "2.0"
method
required
string
Value: "Filecoin.StateGetActor"
required
Array of Address (string) or TipSetKey (string) 2 items

Responses

Request samples

Content type
application/json
{
  • "id": 0,
  • "jsonrpc": "2.0",
  • "method": "Filecoin.StateGetActor",
  • "params": [
    ]
}

Response samples

Content type
application/json
Example
StateGetActorResponse
StateGetActorResponse
ErrorResponse
{
  • "id": 0,
  • "jsonrpc": "2.0",
  • "result": {
    }
}

StateReadState

StateReadState returns the indicated actor's state.

Authorizations:
basicAuth
Request Body schema: application/json
id
required
number
jsonrpc
required
string
Value: "2.0"
method
required
string
Value: "Filecoin.StateReadState"
required
Array of Address (string) or TipSetKey (string) 2 items

Responses

Request samples

Content type
application/json
{
  • "id": 0,
  • "jsonrpc": "2.0",
  • "method": "Filecoin.StateReadState",
  • "params": [
    ]
}

Response samples

Content type
application/json
Example
StateReadStateResponse
StateReadStateResponse
ErrorResponse
{
  • "id": 0,
  • "jsonrpc": "2.0",
  • "result": {
    }
}

StateListMessages

StateListMessages looks back and returns all messages with a matching to or from address, stopping at the given height.

Authorizations:
basicAuth
Request Body schema: application/json
id
required
number
jsonrpc
required
string
Value: "2.0"
method
required
string
Value: "Filecoin.StateListMessages"
required
Array of MessageMatch (object) or TipSetKey (string) or ChainEpoch (integer) 3 items

Responses

Request samples

Content type
application/json
{
  • "id": 0,
  • "jsonrpc": "2.0",
  • "method": "Filecoin.StateListMessages",
  • "params": [
    ]
}

Response samples

Content type
application/json
Example
StateListMessagesResponse
StateListMessagesResponse
ErrorResponse
{
  • "id": 0,
  • "jsonrpc": "2.0",
  • "result": [
    ]
}

StateNetworkName

StateNetworkName returns the name of the network the node is synced to

Authorizations:
basicAuth
Request Body schema: application/json
id
required
number
jsonrpc
required
string
Value: "2.0"
method
required
string
Value: "Filecoin.StateNetworkName"
params
required
Array of any

Responses

Request samples

Content type
application/json
{
  • "id": 0,
  • "jsonrpc": "2.0",
  • "method": "Filecoin.StateNetworkName",
  • "params": [
    ]
}

Response samples

Content type
application/json
Example
StateNetworkNameResponse
StateNetworkNameResponse
ErrorResponse
{
  • "id": 0,
  • "jsonrpc": "2.0",
  • "result": "string"
}

StateMinerSectors

StateMinerSectors returns info about the given miner's sectors. If the filter bitfield is nil, all sectors are included.

Authorizations:
basicAuth
Request Body schema: application/json
id
required
number
jsonrpc
required
string
Value: "2.0"
method
required
string
Value: "Filecoin.StateMinerSectors"
required
Array of Address (string) or []byte (string) or TipSetKey (string) 3 items

Responses

Request samples

Content type
application/json
{
  • "id": 0,
  • "jsonrpc": "2.0",
  • "method": "Filecoin.StateMinerSectors",
  • "params": [
    ]
}

Response samples

Content type
application/json
Example
StateMinerSectorsResponse
StateMinerSectorsResponse
ErrorResponse
{
  • "id": 0,
  • "jsonrpc": "2.0",
  • "result": [
    ]
}

StateMinerPower

StateMinerPower returns the power of the indicated miner

Authorizations:
basicAuth
Request Body schema: application/json
id
required
number
jsonrpc
required
string
Value: "2.0"
method
required
string
Value: "Filecoin.StateMinerPower"
required
Array of Address (string) or TipSetKey (string) 2 items

Responses

Request samples

Content type
application/json
{
  • "id": 0,
  • "jsonrpc": "2.0",
  • "method": "Filecoin.StateMinerPower",
  • "params": [
    ]
}

Response samples

Content type
application/json
Example
StateMinerPowerResponse
StateMinerPowerResponse
ErrorResponse
{
  • "id": 0,
  • "jsonrpc": "2.0",
  • "result": {
    }
}

StateMinerInfo

StateMinerInfo returns info about the indicated miner

Authorizations:
basicAuth
Request Body schema: application/json
id
required
number
jsonrpc
required
string
Value: "2.0"
method
required
string
Value: "Filecoin.StateMinerInfo"
required
Array of Address (string) or TipSetKey (string) 2 items

Responses

Request samples

Content type
application/json
{
  • "id": 0,
  • "jsonrpc": "2.0",
  • "method": "Filecoin.StateMinerInfo",
  • "params": [
    ]
}

Response samples

Content type
application/json
Example
StateMinerInfoResponse
StateMinerInfoResponse
ErrorResponse
{
  • "id": 0,
  • "jsonrpc": "2.0",
  • "result": {
    }
}

StateMinerFaults

StateMinerFaults returns a bitfield indicating the faulty sectors of the given miner

Authorizations:
basicAuth
Request Body schema: application/json
id
required
number
jsonrpc
required
string
Value: "2.0"
method
required
string
Value: "Filecoin.StateMinerFaults"
required
Array of Address (string) or TipSetKey (string) 2 items

Responses

Request samples

Content type
application/json
{
  • "id": 0,
  • "jsonrpc": "2.0",
  • "method": "Filecoin.StateMinerFaults",
  • "params": [
    ]
}

Response samples

Content type
application/json
Example
StateMinerFaultsResponse
StateMinerFaultsResponse
ErrorResponse
{
  • "id": 0,
  • "jsonrpc": "2.0",
  • "result": "string"
}

StateSearchMsg

StateSearchMsg searches for a message in the chain, and returns its receipt and the tipset where it was executed

Authorizations:
basicAuth
Request Body schema: application/json
id
required
number
jsonrpc
required
string
Value: "2.0"
method
required
string
Value: "Filecoin.StateSearchMsg"
required
Array of []byte (string) 1 items

Responses

Request samples

Content type
application/json
{
  • "id": 0,
  • "jsonrpc": "2.0",
  • "method": "Filecoin.StateSearchMsg",
  • "params": [
    ]
}

Response samples

Content type
application/json
Example
StateSearchMsgResponse
StateSearchMsgResponse
ErrorResponse
{
  • "id": 0,
  • "jsonrpc": "2.0",
  • "result": {
    }
}

StateWaitMsg

StateWaitMsg looks back in the chain for a message. If not found, it blocks until the message arrives on chain, and gets to the indicated confidence depth.

Authorizations:
basicAuth
Request Body schema: application/json
id
required
number
jsonrpc
required
string
Value: "2.0"
method
required
string
Value: "Filecoin.StateWaitMsg"
required
Array of []byte (string) or uint64 (integer) 2 items

Responses

Request samples

Content type
application/json
{
  • "id": 0,
  • "jsonrpc": "2.0",
  • "method": "Filecoin.StateWaitMsg",
  • "params": [
    ]
}

Response samples

Content type
application/json
Example
StateWaitMsgResponse
StateWaitMsgResponse
ErrorResponse
{
  • "id": 0,
  • "jsonrpc": "2.0",
  • "result": {
    }
}

StateListMiners

StateListMiners returns the addresses of every miner that has claimed power in the Power Actor

Authorizations:
basicAuth
Request Body schema: application/json
id
required
number
jsonrpc
required
string
Value: "2.0"
method
required
string
Value: "Filecoin.StateListMiners"
required
Array of TipSetKey (string) 1 items

Responses

Request samples

Content type
application/json
{
  • "id": 0,
  • "jsonrpc": "2.0",
  • "method": "Filecoin.StateListMiners",
  • "params": [
    ]
}

Response samples

Content type
application/json
Example
StateListMinersResponse
StateListMinersResponse
ErrorResponse
{
  • "id": 0,
  • "jsonrpc": "2.0",
  • "result": [
    ]
}

StateListActors

StateListActors returns the addresses of every actor in the state

Authorizations:
basicAuth
Request Body schema: application/json
id
required
number
jsonrpc
required
string
Value: "2.0"
method
required
string
Value: "Filecoin.StateListActors"
required
Array of TipSetKey (string) 1 items

Responses

Request samples

Content type
application/json
{
  • "id": 0,
  • "jsonrpc": "2.0",
  • "method": "Filecoin.StateListActors",
  • "params": [
    ]
}

Response samples

Content type
application/json
Example
StateListActorsResponse
StateListActorsResponse
ErrorResponse
{
  • "id": 0,
  • "jsonrpc": "2.0",
  • "result": [
    ]
}

StateMarketBalance

StateMarketBalance looks up the Escrow and Locked balances of the given address in the Storage Market

Authorizations:
basicAuth
Request Body schema: application/json
id
required
number
jsonrpc
required
string
Value: "2.0"
method
required
string
Value: "Filecoin.StateMarketBalance"
required
Array of Address (string) or TipSetKey (string) 2 items

Responses

Request samples

Content type
application/json
{
  • "id": 0,
  • "jsonrpc": "2.0",
  • "method": "Filecoin.StateMarketBalance",
  • "params": [
    ]
}

Response samples

Content type
application/json
Example
StateMarketBalanceResponse
StateMarketBalanceResponse
ErrorResponse
{
  • "id": 0,
  • "jsonrpc": "2.0",
  • "result": {
    }
}

StateMarketParticipants

StateMarketParticipants returns the Escrow and Locked balances of every participant in the Storage Market

Authorizations:
basicAuth
Request Body schema: application/json
id
required
number
jsonrpc
required
string
Value: "2.0"
method
required
string
Value: "Filecoin.StateMarketParticipants"
required
Array of TipSetKey (string) 1 items

Responses

Request samples

Content type
application/json
{
  • "id": 0,
  • "jsonrpc": "2.0",
  • "method": "Filecoin.StateMarketParticipants",
  • "params": [
    ]
}

Response samples

Content type
application/json
Example
StateMarketParticipantsResponse
StateMarketParticipantsResponse
ErrorResponse
{
  • "id": 0,
  • "jsonrpc": "2.0",
  • "result": {
    }
}

StateMarketDeals

StateMarketDeals returns information about every deal in the Storage Market

Authorizations:
basicAuth
Request Body schema: application/json
id
required
number
jsonrpc
required
string
Value: "2.0"
method
required
string
Value: "Filecoin.StateMarketDeals"
required
Array of TipSetKey (string) 1 items

Responses

Request samples

Content type
application/json
{
  • "id": 0,
  • "jsonrpc": "2.0",
  • "method": "Filecoin.StateMarketDeals",
  • "params": [
    ]
}

Response samples

Content type
application/json
Example
StateMarketDealsResponse
StateMarketDealsResponse
ErrorResponse
{
  • "id": 0,
  • "jsonrpc": "2.0",
  • "result": {
    }
}

StateMarketStorageDeal

StateMarketStorageDeal returns information about the indicated deal

Authorizations:
basicAuth
Request Body schema: application/json
id
required
number
jsonrpc
required
string
Value: "2.0"
method
required
string
Value: "Filecoin.StateMarketStorageDeal"
required
Array of DealID (integer) or TipSetKey (string) 2 items

Responses

Request samples

Content type
application/json
{
  • "id": 0,
  • "jsonrpc": "2.0",
  • "method": "Filecoin.StateMarketStorageDeal",
  • "params": [
    ]
}

Response samples

Content type
application/json
Example
StateMarketStorageDealResponse
StateMarketStorageDealResponse
ErrorResponse
{
  • "id": 0,
  • "jsonrpc": "2.0",
  • "result": {
    }
}

StateLookupID

StateLookupID retrieves the ID address of the given address

Authorizations:
basicAuth
Request Body schema: application/json
id
required
number
jsonrpc
required
string
Value: "2.0"
method
required
string
Value: "Filecoin.StateLookupID"
required
Array of Address (string) or TipSetKey (string) 2 items

Responses

Request samples

Content type
application/json
{
  • "id": 0,
  • "jsonrpc": "2.0",
  • "method": "Filecoin.StateLookupID",
  • "params": [
    ]
}

Response samples

Content type
application/json
Example
StateLookupIDResponse
StateLookupIDResponse
ErrorResponse
{
  • "id": 0,
  • "jsonrpc": "2.0",
  • "result": "string"
}

StateAccountKey

StateAccountKey returns the public key address of the given ID address

Authorizations:
basicAuth
Request Body schema: application/json
id
required
number
jsonrpc
required
string
Value: "2.0"
method
required
string
Value: "Filecoin.StateAccountKey"
required
Array of Address (string) or TipSetKey (string) 2 items

Responses

Request samples

Content type
application/json
{
  • "id": 0,
  • "jsonrpc": "2.0",
  • "method": "Filecoin.StateAccountKey",
  • "params": [
    ]
}

Response samples

Content type
application/json
Example
StateAccountKeyResponse
StateAccountKeyResponse
ErrorResponse
{
  • "id": 0,
  • "jsonrpc": "2.0",
  • "result": "string"
}

StateGetReceipt

StateGetReceipt returns the message receipt for the given message

Authorizations:
basicAuth
Request Body schema: application/json
id
required
number
jsonrpc
required
string
Value: "2.0"
method
required
string
Value: "Filecoin.StateGetReceipt"
required
Array of []byte (string) or TipSetKey (string) 2 items

Responses

Request samples

Content type
application/json
{
  • "id": 0,
  • "jsonrpc": "2.0",
  • "method": "Filecoin.StateGetReceipt",
  • "params": [
    ]
}

Response samples

Content type
application/json
Example
StateGetReceiptResponse
StateGetReceiptResponse
ErrorResponse
{
  • "id": 0,
  • "jsonrpc": "2.0",
  • "result": {
    }
}

StateMinerSectorCount

StateMinerSectorCount returns the number of sectors in a miner's sector set and proving set

Authorizations:
basicAuth
Request Body schema: application/json
id
required
number
jsonrpc
required
string
Value: "2.0"
method
required
string
Value: "Filecoin.StateMinerSectorCount"
required
Array of Address (string) or TipSetKey (string) 2 items

Responses

Request samples

Content type
application/json
{
  • "id": 0,
  • "jsonrpc": "2.0",
  • "method": "Filecoin.StateMinerSectorCount",
  • "params": [
    ]
}

Response samples

Content type
application/json
Example
StateMinerSectorCountResponse
StateMinerSectorCountResponse
ErrorResponse
{
  • "id": 0,
  • "jsonrpc": "2.0",
  • "result": {
    }
}