Infura Filecoin Documentation (1.0.0)
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/
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 }
ChainNotify
First message is guaranteed to be of len == 1, and type == 'current'.
Authorizations:
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
- Payload
{- "id": 0,
- "jsonrpc": "2.0",
- "method": "Filecoin.ChainNotify",
- "params": [
- null
]
}
Response samples
- 200
- 429
{- "id": 0,
- "jsonrpc": "2.0",
- "result": [
- {
- "Type": "string",
- "Val": "string"
}
]
}
ChainHead
Authorizations:
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
- Payload
{- "id": 0,
- "jsonrpc": "2.0",
- "method": "Filecoin.ChainHead",
- "params": [
- null
]
}
Response samples
- 200
- 429
{- "id": 0,
- "jsonrpc": "2.0",
- "result": "string"
}
ChainGetBlock
Authorizations:
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
- Payload
{- "id": 0,
- "jsonrpc": "2.0",
- "method": "Filecoin.ChainGetBlock",
- "params": [
- "string"
]
}
Response samples
- 200
- 429
{- "id": 0,
- "jsonrpc": "2.0",
- "result": {
- "Miner": "string",
- "Ticket": {
- "VRFProof": "string"
}, - "ElectionProof": {
- "WinCount": 0,
- "VRFProof": "string"
}, - "BeaconEntries": [
- {
- "Round": 0,
- "Data": "string"
}
], - "WinPoStProof": [
- null
], - "Parents": [
- "string"
], - "ParentWeight": "string",
- "Height": 0,
- "ParentStateRoot": "string",
- "ParentMessageReceipts": "string",
- "Messages": "string",
- "BLSAggregate": {
- "Type": 0,
- "Data": "string"
}, - "Timestamp": 0,
- "BlockSig": {
- "Type": 0,
- "Data": "string"
}, - "ForkSignaling": 0,
- "ParentBaseFee": "string"
}
}
ChainGetTipSet
Authorizations:
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
- Payload
{- "id": 0,
- "jsonrpc": "2.0",
- "method": "Filecoin.ChainGetTipSet",
- "params": [
- "string"
]
}
Response samples
- 200
- 429
{- "id": 0,
- "jsonrpc": "2.0",
- "result": "string"
}
ChainGetBlockMessages
Authorizations:
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
- Payload
{- "id": 0,
- "jsonrpc": "2.0",
- "method": "Filecoin.ChainGetBlockMessages",
- "params": [
- "string"
]
}
Response samples
- 200
- 429
{- "id": 0,
- "jsonrpc": "2.0",
- "result": {
- "BlsMessages": [
- "string"
], - "SecpkMessages": [
- "string"
], - "Cids": [
- "string"
]
}
}
ChainGetParentReceipts
the specified block.
Authorizations:
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
- Payload
{- "id": 0,
- "jsonrpc": "2.0",
- "method": "Filecoin.ChainGetParentReceipts",
- "params": [
- "string"
]
}
Response samples
- 200
- 429
{- "id": 0,
- "jsonrpc": "2.0",
- "result": [
- {
- "ExitCode": 0,
- "Return": "string",
- "GasUsed": 0
}
]
}
ChainGetParentMessages
specified block.
Authorizations:
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
- Payload
{- "id": 0,
- "jsonrpc": "2.0",
- "method": "Filecoin.ChainGetParentMessages",
- "params": [
- "string"
]
}
Response samples
- 200
- 429
{- "id": 0,
- "jsonrpc": "2.0",
- "result": [
- "string"
]
}
ChainGetTipSetByHeight
If there are no blocks at the specified epoch, a tipset at an earlier epoch will be returned.
Authorizations:
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
- Payload
{- "id": 0,
- "jsonrpc": "2.0",
- "method": "Filecoin.ChainGetTipSetByHeight",
- "params": [
- 0,
- 0
]
}
Response samples
- 200
- 429
{- "id": 0,
- "jsonrpc": "2.0",
- "result": "string"
}
ChainReadObj
blockstore and returns raw bytes.
Authorizations:
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
- Payload
{- "id": 0,
- "jsonrpc": "2.0",
- "method": "Filecoin.ChainReadObj",
- "params": [
- "string"
]
}
Response samples
- 200
- 429
{- "id": 0,
- "jsonrpc": "2.0",
- "result": "string"
}
ChainHasObj
Authorizations:
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
- Payload
{- "id": 0,
- "jsonrpc": "2.0",
- "method": "Filecoin.ChainHasObj",
- "params": [
- "string"
]
}
Response samples
- 200
- 429
{- "id": 0,
- "jsonrpc": "2.0",
- "result": true
}
ChainStatObj
If 'base' is also specified, then the returned stat will be a diff between the two objects.
Authorizations:
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
- Payload
{- "id": 0,
- "jsonrpc": "2.0",
- "method": "Filecoin.ChainStatObj",
- "params": [
- "string",
- "string"
]
}
Response samples
- 200
- 429
{- "id": 0,
- "jsonrpc": "2.0",
- "result": {
- "Size": 0,
- "Links": 0
}
}
ChainGetGenesis
ChainTipSetWeight computes weight for the specified tipset.
Authorizations:
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
- Payload
{- "id": 0,
- "jsonrpc": "2.0",
- "method": "Filecoin.ChainGetGenesis",
- "params": [
- null
]
}
Response samples
- 200
- 429
{- "id": 0,
- "jsonrpc": "2.0",
- "result": "string"
}
ChainTipSetWeight
Authorizations:
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
- Payload
{- "id": 0,
- "jsonrpc": "2.0",
- "method": "Filecoin.ChainTipSetWeight",
- "params": [
- "string"
]
}
Response samples
- 200
- 429
{- "id": 0,
- "jsonrpc": "2.0",
- "result": "string"
}
ChainGetMessage
chain blockstore.
Authorizations:
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
- Payload
{- "id": 0,
- "jsonrpc": "2.0",
- "method": "Filecoin.ChainGetMessage",
- "params": [
- "string"
]
}
Response samples
- 200
- 429
{- "id": 0,
- "jsonrpc": "2.0",
- "result": "string"
}
ChainGetPath
one tipset to another, for example:“to ^ from tAA ^ ^ tBA tAB ^---*--^ ^ tRR“
Would return [revert(tBA), apply(tAB), apply(tAA)]
Authorizations:
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
- Payload
{- "id": 0,
- "jsonrpc": "2.0",
- "method": "Filecoin.ChainGetPath",
- "params": [
- "string",
- "string"
]
}
Response samples
- 200
- 429
{- "id": 0,
- "jsonrpc": "2.0",
- "result": [
- {
- "Type": "string",
- "Val": "string"
}
]
}
GasEstimateFeeCap
Authorizations:
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
- Payload
{- "id": 0,
- "jsonrpc": "2.0",
- "method": "Filecoin.GasEstimateFeeCap",
- "params": [
- "string",
- "string",
- "string"
]
}
Response samples
- 200
- 429
{- "id": 0,
- "jsonrpc": "2.0",
- "result": "string"
}
GasEstimateGasLimit
It fails if message fails to execute.
Authorizations:
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
- Payload
{- "id": 0,
- "jsonrpc": "2.0",
- "method": "Filecoin.GasEstimateGasLimit",
- "params": [
- "string",
- "string"
]
}
Response samples
- 200
- 429
{- "id": 0,
- "jsonrpc": "2.0",
- "result": 0
}
GasEstimateGasPremium
Authorizations:
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
- Payload
{- "id": 0,
- "jsonrpc": "2.0",
- "method": "Filecoin.GasEstimateGasPremium",
- "params": [
- 0,
- 0,
- 0,
- 0
]
}
Response samples
- 200
- 429
{- "id": 0,
- "jsonrpc": "2.0",
- "result": "string"
}
GasEstimateMessageGas
Authorizations:
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
- Payload
{- "id": 0,
- "jsonrpc": "2.0",
- "method": "Filecoin.GasEstimateMessageGas",
- "params": [
- "string",
- "string",
- "string"
]
}
Response samples
- 200
- 429
{- "id": 0,
- "jsonrpc": "2.0",
- "result": "string"
}
SyncState
Authorizations:
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
- Payload
{- "id": 0,
- "jsonrpc": "2.0",
- "method": "Filecoin.SyncState",
- "params": [
- null
]
}
Response samples
- 200
- 429
{- "id": 0,
- "jsonrpc": "2.0",
- "result": {
- "ActiveSyncs": [
- {
- "WorkerID": 0,
- "Base": "string",
- "Target": "string",
- "Stage": 0,
- "Height": 0,
- "Start": "string",
- "End": "string",
- "Message": "string"
}
], - "VMApplied": 0
}
}
SyncIncomingBlocks
yet synced block headers.
Authorizations:
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
- Payload
{- "id": 0,
- "jsonrpc": "2.0",
- "method": "Filecoin.SyncIncomingBlocks",
- "params": [
- null
]
}
Response samples
- 200
- 429
{- "id": 0,
- "jsonrpc": "2.0",
- "result": {
- "Miner": "string",
- "Ticket": {
- "VRFProof": "string"
}, - "ElectionProof": {
- "WinCount": 0,
- "VRFProof": "string"
}, - "BeaconEntries": [
- {
- "Round": 0,
- "Data": "string"
}
], - "WinPoStProof": [
- null
], - "Parents": [
- "string"
], - "ParentWeight": "string",
- "Height": 0,
- "ParentStateRoot": "string",
- "ParentMessageReceipts": "string",
- "Messages": "string",
- "BLSAggregate": {
- "Type": 0,
- "Data": "string"
}, - "Timestamp": 0,
- "BlockSig": {
- "Type": 0,
- "Data": "string"
}, - "ForkSignaling": 0,
- "ParentBaseFee": "string"
}
}
MpoolPending
Authorizations:
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
- Payload
{- "id": 0,
- "jsonrpc": "2.0",
- "method": "Filecoin.MpoolPending",
- "params": [
- "string"
]
}
Response samples
- 200
- 429
{- "id": 0,
- "jsonrpc": "2.0",
- "result": [
- "string"
]
}
MpoolPush
Authorizations:
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
- Payload
{- "id": 0,
- "jsonrpc": "2.0",
- "method": "Filecoin.MpoolPush",
- "params": [
- "string"
]
}
Response samples
- 200
- 429
{- "id": 0,
- "jsonrpc": "2.0",
- "result": "string"
}
MpoolGetNonce
Authorizations:
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
- Payload
{- "id": 0,
- "jsonrpc": "2.0",
- "method": "Filecoin.MpoolGetNonce",
- "params": [
- "string"
]
}
Response samples
- 200
- 429
{- "id": 0,
- "jsonrpc": "2.0",
- "result": 0
}
MpoolSub
Authorizations:
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
- Payload
{- "id": 0,
- "jsonrpc": "2.0",
- "method": "Filecoin.MpoolSub",
- "params": [
- null
]
}
Response samples
- 200
- 429
{- "id": 0,
- "jsonrpc": "2.0",
- "result": {
- "Type": 0,
- "Message": "string"
}
}
WalletBalance
Authorizations:
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
- Payload
{- "id": 0,
- "jsonrpc": "2.0",
- "method": "Filecoin.WalletBalance",
- "params": [
- "string"
]
}
Response samples
- 200
- 429
{- "id": 0,
- "jsonrpc": "2.0",
- "result": "string"
}
WalletVerify
The address does not have to be in the wallet.
Authorizations:
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
- Payload
{- "id": 0,
- "jsonrpc": "2.0",
- "method": "Filecoin.WalletVerify",
- "params": [
- "string",
- "string",
- "string"
]
}
Response samples
- 200
- 429
{- "id": 0,
- "jsonrpc": "2.0",
- "result": true
}
WalletValidateAddress
Authorizations:
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
- Payload
{- "id": 0,
- "jsonrpc": "2.0",
- "method": "Filecoin.WalletValidateAddress",
- "params": [
- "string"
]
}
Response samples
- 200
- 429
{- "id": 0,
- "jsonrpc": "2.0",
- "result": "string"
}
ClientQueryAsk
Authorizations:
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
- Payload
{- "id": 0,
- "jsonrpc": "2.0",
- "method": "Filecoin.ClientQueryAsk",
- "params": [
- "string",
- "string"
]
}
Response samples
- 200
- 429
{- "id": 0,
- "jsonrpc": "2.0",
- "result": {
- "Price": "string",
- "VerifiedPrice": "string",
- "MinPieceSize": 0,
- "MaxPieceSize": 0,
- "Miner": "string",
- "Timestamp": 0,
- "Expiry": 0,
- "SeqNo": 0
}
}
StateReplay
If no tipset key is provided, the appropriate tipset is looked up.
Authorizations:
Request Body schema: application/json
id required | number |
jsonrpc required | string Value: "2.0" |
method required | string Value: "Filecoin.StateReplay" |
required | Array of TipSetKey (string) or []byte (string) 2 items |
Responses
Request samples
- Payload
{- "id": 0,
- "jsonrpc": "2.0",
- "method": "Filecoin.StateReplay",
- "params": [
- "string",
- "string"
]
}
Response samples
- 200
- 429
{- "id": 0,
- "jsonrpc": "2.0",
- "result": {
- "MsgCid": "string",
- "Msg": "string",
- "MsgRct": {
- "ExitCode": 0,
- "Return": "string",
- "GasUsed": 0
}, - "GasCost": {
- "Message": "string",
- "GasUsed": "string",
- "BaseFeeBurn": "string",
- "OverEstimationBurn": "string",
- "MinerPenalty": "string",
- "MinerTip": "string",
- "Refund": "string",
- "TotalCost": "string"
}, - "ExecutionTrace": {
- "Msg": "string",
- "MsgRct": {
- "ExitCode": 0,
- "Return": "string",
- "GasUsed": 0
}, - "Error": "string",
- "Duration": 0,
- "GasCharges": [
- "string"
], - "Subcalls": [
- { }
]
}, - "Error": "string",
- "Duration": 0
}
}
StateGetActor
Authorizations:
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
- Payload
{- "id": 0,
- "jsonrpc": "2.0",
- "method": "Filecoin.StateGetActor",
- "params": [
- "string",
- "string"
]
}
Response samples
- 200
- 429
{- "id": 0,
- "jsonrpc": "2.0",
- "result": {
- "Code": "string",
- "Head": "string",
- "Nonce": 0,
- "Balance": "string"
}
}
StateReadState
Authorizations:
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
- Payload
{- "id": 0,
- "jsonrpc": "2.0",
- "method": "Filecoin.StateReadState",
- "params": [
- "string",
- "string"
]
}
Response samples
- 200
- 429
{- "id": 0,
- "jsonrpc": "2.0",
- "result": {
- "Balance": "string",
- "Code": "string",
- "State": null
}
}
StateListMessages
Authorizations:
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
- Payload
{- "id": 0,
- "jsonrpc": "2.0",
- "method": "Filecoin.StateListMessages",
- "params": [
- {
- "To": "string",
- "From": "string"
}, - {
- "To": "string",
- "From": "string"
}, - {
- "To": "string",
- "From": "string"
}
]
}
Response samples
- 200
- 429
{- "id": 0,
- "jsonrpc": "2.0",
- "result": [
- "string"
]
}
StateDecodeParams
Authorizations:
Request Body schema: application/json
id required | number |
jsonrpc required | string Value: "2.0" |
method required | string Value: "Filecoin.StateDecodeParams" |
required | Array of Address (string) or MethodNum (integer) or []byte (string) or TipSetKey (string) 4 items |
Responses
Request samples
- Payload
{- "id": 0,
- "jsonrpc": "2.0",
- "method": "Filecoin.StateDecodeParams",
- "params": [
- "string",
- "string",
- "string",
- "string"
]
}
Response samples
- 200
- 429
{- "id": 0,
- "jsonrpc": "2.0",
- "result": null
}
StateNetworkName
Authorizations:
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
- Payload
{- "id": 0,
- "jsonrpc": "2.0",
- "method": "Filecoin.StateNetworkName",
- "params": [
- null
]
}
Response samples
- 200
- 429
{- "id": 0,
- "jsonrpc": "2.0",
- "result": "string"
}
StateMinerSectors
Authorizations:
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
- Payload
{- "id": 0,
- "jsonrpc": "2.0",
- "method": "Filecoin.StateMinerSectors",
- "params": [
- "string",
- "string",
- "string"
]
}
Response samples
- 200
- 429
{- "id": 0,
- "jsonrpc": "2.0",
- "result": [
- {
- "SectorNumber": 0,
- "SealProof": 0,
- "SealedCID": "string",
- "DealIDs": [
- 0
], - "Activation": 0,
- "Expiration": 0,
- "DealWeight": "string",
- "VerifiedDealWeight": "string",
- "InitialPledge": "string",
- "ExpectedDayReward": "string",
- "ExpectedStoragePledge": "string"
}
]
}
StateMinerPower
Authorizations:
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
- Payload
{- "id": 0,
- "jsonrpc": "2.0",
- "method": "Filecoin.StateMinerPower",
- "params": [
- "string",
- "string"
]
}
Response samples
- 200
- 429
{- "id": 0,
- "jsonrpc": "2.0",
- "result": {
- "MinerPower": {
- "RawBytePower": "string",
- "QualityAdjPower": "string"
}, - "TotalPower": {
- "RawBytePower": "string",
- "QualityAdjPower": "string"
}, - "HasMinPower": true
}
}
StateMinerInfo
Authorizations:
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
- Payload
{- "id": 0,
- "jsonrpc": "2.0",
- "method": "Filecoin.StateMinerInfo",
- "params": [
- "string",
- "string"
]
}
Response samples
- 200
- 429
{- "id": 0,
- "jsonrpc": "2.0",
- "result": {
- "Owner": "string",
- "Worker": "string",
- "NewWorker": "string",
- "ControlAddresses": [
- "string"
], - "WorkerChangeEpoch": 0,
- "PeerId": "string",
- "Multiaddrs": [
- "string"
], - "WindowPoStProofType": 0,
- "SectorSize": 0,
- "WindowPoStPartitionSectors": 0,
- "ConsensusFaultElapsed": 0
}
}
StateMinerFaults
Authorizations:
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
- Payload
{- "id": 0,
- "jsonrpc": "2.0",
- "method": "Filecoin.StateMinerFaults",
- "params": [
- "string",
- "string"
]
}
Response samples
- 200
- 429
{- "id": 0,
- "jsonrpc": "2.0",
- "result": "string"
}
StateSearchMsg
Authorizations:
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
- Payload
{- "id": 0,
- "jsonrpc": "2.0",
- "method": "Filecoin.StateSearchMsg",
- "params": [
- "string"
]
}
Response samples
- 200
- 429
{- "id": 0,
- "jsonrpc": "2.0",
- "result": {
- "Message": "string",
- "Receipt": {
- "ExitCode": 0,
- "Return": "string",
- "GasUsed": 0
}, - "ReturnDec": null,
- "TipSet": "string",
- "Height": 0
}
}
StateWaitMsg
message arrives on chain, and gets to the indicated confidence depth.
Authorizations:
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
- Payload
{- "id": 0,
- "jsonrpc": "2.0",
- "method": "Filecoin.StateWaitMsg",
- "params": [
- "string",
- "string"
]
}
Response samples
- 200
- 429
{- "id": 0,
- "jsonrpc": "2.0",
- "result": {
- "Message": "string",
- "Receipt": {
- "ExitCode": 0,
- "Return": "string",
- "GasUsed": 0
}, - "ReturnDec": null,
- "TipSet": "string",
- "Height": 0
}
}
StateListMiners
Authorizations:
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
- Payload
{- "id": 0,
- "jsonrpc": "2.0",
- "method": "Filecoin.StateListMiners",
- "params": [
- "string"
]
}
Response samples
- 200
- 429
{- "id": 0,
- "jsonrpc": "2.0",
- "result": [
- "string"
]
}
StateListActors
Authorizations:
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
- Payload
{- "id": 0,
- "jsonrpc": "2.0",
- "method": "Filecoin.StateListActors",
- "params": [
- "string"
]
}
Response samples
- 200
- 429
{- "id": 0,
- "jsonrpc": "2.0",
- "result": [
- "string"
]
}
StateMarketBalance
Authorizations:
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
- Payload
{- "id": 0,
- "jsonrpc": "2.0",
- "method": "Filecoin.StateMarketBalance",
- "params": [
- "string",
- "string"
]
}
Response samples
- 200
- 429
{- "id": 0,
- "jsonrpc": "2.0",
- "result": {
- "Escrow": "string",
- "Locked": "string"
}
}
StateMarketParticipants
Authorizations:
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
- Payload
{- "id": 0,
- "jsonrpc": "2.0",
- "method": "Filecoin.StateMarketParticipants",
- "params": [
- "string"
]
}
Response samples
- 200
- 429
{- "id": 0,
- "jsonrpc": "2.0",
- "result": {
- "property1": {
- "Escrow": "string",
- "Locked": "string"
}, - "property2": {
- "Escrow": "string",
- "Locked": "string"
}
}
}
StateMarketDeals
Authorizations:
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
- Payload
{- "id": 0,
- "jsonrpc": "2.0",
- "method": "Filecoin.StateMarketDeals",
- "params": [
- "string"
]
}
Response samples
- 200
- 429
{- "id": 0,
- "jsonrpc": "2.0",
- "result": {
- "property1": {
- "Proposal": {
- "PieceCID": "string",
- "PieceSize": 0,
- "VerifiedDeal": true,
- "Client": "string",
- "Provider": "string",
- "Label": "string",
- "StartEpoch": 0,
- "EndEpoch": 0,
- "StoragePricePerEpoch": "string",
- "ProviderCollateral": "string",
- "ClientCollateral": "string"
}, - "State": {
- "SectorStartEpoch": 0,
- "LastUpdatedEpoch": 0,
- "SlashEpoch": 0
}
}, - "property2": {
- "Proposal": {
- "PieceCID": "string",
- "PieceSize": 0,
- "VerifiedDeal": true,
- "Client": "string",
- "Provider": "string",
- "Label": "string",
- "StartEpoch": 0,
- "EndEpoch": 0,
- "StoragePricePerEpoch": "string",
- "ProviderCollateral": "string",
- "ClientCollateral": "string"
}, - "State": {
- "SectorStartEpoch": 0,
- "LastUpdatedEpoch": 0,
- "SlashEpoch": 0
}
}
}
}
StateMarketStorageDeal
Authorizations:
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
- Payload
{- "id": 0,
- "jsonrpc": "2.0",
- "method": "Filecoin.StateMarketStorageDeal",
- "params": [
- 0,
- 0
]
}
Response samples
- 200
- 429
{- "id": 0,
- "jsonrpc": "2.0",
- "result": {
- "Proposal": {
- "PieceCID": "string",
- "PieceSize": 0,
- "VerifiedDeal": true,
- "Client": "string",
- "Provider": "string",
- "Label": "string",
- "StartEpoch": 0,
- "EndEpoch": 0,
- "StoragePricePerEpoch": "string",
- "ProviderCollateral": "string",
- "ClientCollateral": "string"
}, - "State": {
- "SectorStartEpoch": 0,
- "LastUpdatedEpoch": 0,
- "SlashEpoch": 0
}
}
}
StateLookupID
Authorizations:
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
- Payload
{- "id": 0,
- "jsonrpc": "2.0",
- "method": "Filecoin.StateLookupID",
- "params": [
- "string",
- "string"
]
}
Response samples
- 200
- 429
{- "id": 0,
- "jsonrpc": "2.0",
- "result": "string"
}
StateAccountKey
Authorizations:
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
- Payload
{- "id": 0,
- "jsonrpc": "2.0",
- "method": "Filecoin.StateAccountKey",
- "params": [
- "string",
- "string"
]
}
Response samples
- 200
- 429
{- "id": 0,
- "jsonrpc": "2.0",
- "result": "string"
}
StateGetReceipt
Authorizations:
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
- Payload
{- "id": 0,
- "jsonrpc": "2.0",
- "method": "Filecoin.StateGetReceipt",
- "params": [
- "string",
- "string"
]
}
Response samples
- 200
- 429
{- "id": 0,
- "jsonrpc": "2.0",
- "result": {
- "ExitCode": 0,
- "Return": "string",
- "GasUsed": 0
}
}
StateMinerSectorCount
Authorizations:
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
- Payload
{- "id": 0,
- "jsonrpc": "2.0",
- "method": "Filecoin.StateMinerSectorCount",
- "params": [
- "string",
- "string"
]
}
Response samples
- 200
- 429
{- "id": 0,
- "jsonrpc": "2.0",
- "result": {
- "Live": 0,
- "Active": 0,
- "Faulty": 0
}
}