Download OpenAPI specification:Download
Welcome to Insolar documentation for a read-only MainNet REST-like API provided by an Observer node.
The Observer node pulls data from Insolar MainNet and offloads read requests from it by hosting a fast report service.
Additionally, Observer provides coin statistics and notification messages.
Insolar is being developed to provide interoperability between enterprises.
From a business perspective:
From a technical perspective:
Therefore, an entity wishing to transfer funds to/from its account from/to a particular address, in Insolar's terms, is a member object identified by its reference wishing to transfer funds to another member object identified by the corresponding reference.
Insolar uses these terms in method and parameter names.
API changes in particular Insolar releases and uses the SemVer 2.0 versioning system.
Read-only MainNet API versions do not have to tally with Insolar Observer versions.
Gets the following information on a member
object:
reference
, accountReference
, and walletReference
.balance
.deposits
associated with the member, if any.migrationAddress
used during the migration period.To invoke this request, specify the member reference
or the corresponding migrationAddress
.
reference required | string ^insolar:[A-z0-9_-]+$ Example: insolar:1GlDeBOnc7Ar5N34ShBdkx_SAVOfnZJKUCoQMi0_OcvE Reference to the Note: Path parameters must be properly included into the URL, so |
OK
Reference not found
Invalid reference format
Endpoint not found
Internal server error
MainNet
TestNet
{- "balance": "1000000000000",
- "reference": "insolar:1GlDeBOnc7Ar5N34ShBdkx_SAVOfnZJKUCoQMi0_OcvE",
- "walletReference": "insolar:1AfNjPWh7Ut-P7Ky7Mj7HLCte3gjGXi4RpXNxTvrhlww",
- "accountReference": "insolar:1LBBNgDpzKt0YGkrInkqGlsME4RAnSzQRIySreTX0j7g",
- "deposits": [
- {
- "index": 1,
- "memberReference": "insolar:1GlDeBOnc7Ar5N34ShBdkx_SAVOfnZJKUCoQMi0_OcvE",
- "depositReference": "insolar:1FUpUFSfNpmyX05nustQ7B8al0xj-_j3_ndqXfgLRra4",
- "amountOnHold": "1000",
- "availableAmount": "500",
- "ethTxHash": "0xd1844c003fc2531625538800e2f7834b4913be73f34765472ad6fb547d0ce2df",
- "holdReleaseDate": 1569801600,
- "releasedAmount": "500",
- "releaseEndDate": 1575958400,
- "status": "LOCKED",
- "timestamp": 1575158400
}, - {
- "index": 2,
- "memberReference": "insolar:1GlDeBOnc7Ar5N34ShBdkx_SAVOfnZJKUCoQMi0_OcvE",
- "depositReference": "insolar:1FUpUFSfNpmyX05nustQ7B8al0xj-_j3_ndqXfgLRra3",
- "amountOnHold": "100000000",
- "availableAmount": "50000",
- "ethTxHash": "0xd1944c003fc2531625538800e2f7834b4913be73f34765472ad6fb547d0ce2df",
- "holdReleaseDate": 1569801600,
- "releasedAmount": "50000",
- "releaseEndDate": 1575958400,
- "status": "AVAILABLE",
- "timestamp": 1575158400
}, - {
- "index": 3,
- "memberReference": "insolar:1GlDeBOnc7Ar5N34ShBdkx_SAVOfnZJKUCoQMi0_OcvE",
- "depositReference": "insolar:1FUpUFSfNpmyX05nustQ7B8al0xj-_j3_ndqXfgLRra2",
- "amountOnHold": "1",
- "availableAmount": "10",
- "ethTxHash": "0xd2044c003fc2531625538800e2f7834b4913be73f34765472ad6fb547d0ce2df",
- "holdReleaseDate": 1569801600,
- "releasedAmount": "10",
- "releaseEndDate": 1575958400,
- "status": "MIGRATION",
- "timestamp": 1575158400
}, - {
- "index": 4,
- "memberReference": "insolar:1GlDeBOnc7Ar5N34ShBdkx_SAVOfnZJKUCoQMi0_OcvE",
- "depositReference": "insolar:1FUpUFSfNpmyX05nustQ7B8al0xj-_j3_ndqXfgLRra1",
- "amountOnHold": "0",
- "availableAmount": "300",
- "ethTxHash": "0xd2144c003fc2531625538800e2f7834b4913be73f34765472ad6fb547d0ce2df",
- "holdReleaseDate": 1569801600,
- "nextRelease": {
- "amount": 50,
- "timestamp": 1575758400
}, - "releasedAmount": "300",
- "releaseEndDate": 1575958400,
- "status": "AVAILABLE",
- "timestamp": 1575158400
}
]
}
Gets the following information on a member
object:
reference
, accountReference
, and walletReference
.balance
.deposits
associated with the member, if any.migrationAddress
used during the migration period.To invoke this request, specify the member's publicKey
.
publicKey required | string Example: publicKey=-----BEGIN PUBLIC KEY-----MFYwEAYHKoZIzj0CAQYFK4EEAAoDQgAE9qmU2JVIlNPE/hGxuJnXprOyFIIL5fkcJlFOLMIQnNK8uPyFgexekQKFvyy3/dvPCEYoXOVi25CQ9t2UAj4v+Q==-----END PUBLIC KEY----- Public key of the target Note: Query parameters must be properly included into the URL, so |
OK
Reference not found
Endpoint not found
Internal server error
MainNet
TestNet
{- "reference": "insolar:1AfNjPWh7Ut-P7Ky7Mj7HLCte3gjGXi4RpXNxTvrhlww",
- "balance": "1000000000",
- "walletReference": "insolar:1AfNjPWh7Ut-P7Ky7Mj7HLCte3gjGXi4RpXNxTvrhlww",
- "accountReference": "insolar:1LBBNgDpzKt0YGkrInkqGlsME4RAnSzQRIySreTX0j7g",
- "deposits": [
- {
- "index": 1,
- "memberReference": "insolar:1GlDeBOnc7Ar5N34ShBdkx_SAVOfnZJKUCoQMi0_OcvE",
- "depositReference": "insolar:1FUpUFSfNpmyX05nustQ7B8al0xj-_j3_ndqXfgLRra4",
- "amountOnHold": "100",
- "availableAmount": "10",
- "ethTxHash": "0xd1844c003fc2531625538800e2f7834b4913be73f34765472ad6fb547d0ce2df",
- "holdReleaseDate": 1569801600,
- "nextRelease": {
- "amount": "1",
- "timestamp": 1572436800
}, - "releasedAmount": "1000000000",
- "releaseEndDate": 1569801600,
- "status": "AVAILABLE",
- "timestamp": 1560254400
}
], - "migrationAddress": "0xF4e1507486dFE411785B00d7D00A1f1a484f00E6"
}
Gets the balance
of a member's account.
To invoke this request, specify the member reference
.
reference required | string ^insolar:[A-z0-9_-]+$ Example: insolar:1GlDeBOnc7Ar5N34ShBdkx_SAVOfnZJKUCoQMi0_OcvE Reference to the Note: Path parameters must be properly included into the URL, so |
OK
Reference not found
Invalid reference format
Endpoint not found
Internal server error
MainNet
TestNet
{- "balance": "1000000000"
}
Gets a list (page) of member's transactions.
To invoke this request, specify the member reference
in path and parameters listed below.
Filters:
direction
of transactions in the list: incoming
, outgoing
, or all
.type
of transactions in the list.status
of transactions in the list.Pagination parameters and chronological order:
order
of the transaction list: chronological
or reverse
(default).limit
to the number of transactions to get (page size).index
of the last known transaction. The list starts from the next one.Each returned transaction has an index
which can be specified in the corresponding parameter in subsequent requests.
If the index
parameter is not specified, the request returns a list of the most recent or old (depending on the order
value) transactions.
reference required | string ^insolar:[A-z0-9_-]+$ Example: insolar:1GlDeBOnc7Ar5N34ShBdkx_SAVOfnZJKUCoQMi0_OcvE Reference to the Note: Path parameters must be properly included into the URL, so |
limit required | integer [ 1 .. 1000 ] Example: limit=100 Number of entries per list. |
index | string Example: index=38134090:7 Index of the last known transaction. The list starts from the next one.
Each returned transaction has an To get the list of most recent or old (depending on the |
direction | string Default: "all" Enum: "incoming" "outgoing" "all" Example: direction=incoming Transaction direction:
|
order | string Default: "reverse" Enum: "chronological" "reverse" Chronological
|
type | string Enum: "transfer" "migration" "allocation" "release" Example: type=transfer Transaction type:
|
status | string Enum: "registered" "sent" "received" "failed" Example: status=received Transaction status:
|
OK
Reference not found
Invalid parameter(s) format
Endpoint not found
Internal server error
MainNet
TestNet
[- {
- "index": "38134090:58",
- "txID": "insolar:1GlDeBOnc7Ar5N34ShBdkx_SAVOfnZJKUCoQMi0_OcvE.record",
- "amount": "100",
- "fee": "1",
- "timestamp": 1562754412,
- "status": "received",
- "pulseNumber": 22385288,
- "type": "transfer",
- "toMemberReference": "insolar:1AfNjPWh7Ut-P7Ky7Mj7HLCte3gjGXi4RpXNxTvrhlww",
- "fromMemberReference": "insolar:1GlDeBOnc7Ar5N34ShBdkx_SAVOfnZJKUCoQMi0_OcvE"
}, - {
- "index": "38134070:48",
- "txID": "insolar:1M9lO6JFGf6NXmBxkO5156zeeh7ip2SJzT96Vv4vZHeo.record",
- "amount": "150",
- "fee": "1",
- "timestamp": 1562754412,
- "status": "received",
- "pulseNumber": 22385288,
- "type": "migration",
- "fromMemberReference": "insolar:1FUpUFSfNpmyX05nustQ7B8al0xj-_j3_ndqXfgLRra4",
- "toMemberReference": "insolar:1AfNjPWh7Ut-P7Ky7Mj7HLCte3gjGXi4RpXNxTvrhlww",
- "toDepositReference": "insolar:1FUpUFSfNpmyX05nustQ7B8al0xj-_j3_ndqXfgLRra4"
}, - {
- "index": "38133910:31",
- "txID": "insolar:1FUpUFSfNpmyX05nustQ7B8al0xj-_j3_ndqXfgLRra4.record",
- "amount": "160",
- "fee": "1",
- "timestamp": 1562754412,
- "status": "received",
- "pulseNumber": 22385288,
- "type": "release",
- "toMemberReference": "insolar:1Fb0mZP1-Hekj-21wpyFRS2ww-nOdj1SqKPsfKy1R0PY",
- "fromDepositReference": "insolar:1FUpUFSfNpmyX05nustQ7B8al0xj-_j3_ndqXfgLRra3"
}, - {
- "index": "38133860:37",
- "txID": "insolar:6VlDeB2Tc3Ar5N38ShBdkx_SAVOfnZJKUCoQMi0_Occc.record",
- "amount": "100",
- "fee": "1",
- "timestamp": 1562754412,
- "status": "received",
- "pulseNumber": 22385288,
- "type": "transfer",
- "toMemberReference": "insolar:1AfNjPWh7Ut-P7Ky7Mj7HLCte3gjGXi4RpXNxTvrhlww",
- "fromMemberReference": "insolar:1GlDeBOnc7Ar5N34ShBdkx_SAVOfnZJKUCoQMi0_OcvE"
}, - {
- "index": "38133620:7",
- "txID": "insolar:3A6l16JFDf6NXmBxkO5156zeeh7ip2SJzT96Vv4vZfyR.record",
- "amount": "150",
- "fee": "1",
- "timestamp": 1562754412,
- "status": "received",
- "pulseNumber": 22385288,
- "type": "migration",
- "fromMemberReference": "insolar:1FUpUFSfNpmyX05nustQ7B8al0xj-_j3_ndqXfgLRra4",
- "toMemberReference": "insolar:1AfNjPWh7Ut-P7Ky7Mj7HLCte3gjGXi4RpXNxTvrhlww",
- "toDepositReference": "insolar:1FUpUFSfNpmyX05nustQ7B8al0xj-_j3_ndqXfgLRra4"
}, - {
- "index": "38133610:87",
- "txID": "insolar:8AGpUFSsBpmsX92nustQ7B8al0xj-_j3_ndqXfgLshR1.record",
- "amount": "160",
- "fee": "1",
- "timestamp": 1562754412,
- "status": "received",
- "pulseNumber": 22385288,
- "type": "release",
- "toMemberReference": "insolar:1Fb0mZP1-Hekj-21wpyFRS2ww-nOdj1SqKPsfKy1R0PY",
- "fromDepositReference": "insolar:1FUpUFSfNpmyX05nustQ7B8al0xj-_j3_ndqXfgLRra2"
}
]
Gets a list (page) of transactions.
To invoke this request, specify the parameters listed below.
Filters:
value
of txID
, fromMemberReference
, toMemberReference
or pulseNumber
to search (filter) transactions by.type
of transactions in the list.status
of transactions in the list.Pagination parameters and chronological order:
order
of the transaction list: chronological
or reverse
(default).limit
to the number of transactions to get (page size).index
of the last known transaction. List start the next one.Each returned transaction has an index
which can be specified in the corresponding parameter in subsequent requests.
If the index
parameter is not specified, the request returns a list of the most recent or old (depending on the order
value) transactions.
value | string Example: value=insolar:1GlDeBOnc7Ar5N34ShBdkx_SAVOfnZJKUCoQMi0_OcvE Value of Note: Path parameters must be properly included into the URL, so |
limit required | integer [ 1 .. 1000 ] Example: limit=100 Number of entries per list. |
index | string Example: index=38134090:7 Index of the last known transaction. List starts from the next one. Each returned transaction has an To get the list of most recent or old (depending on the |
order | string Default: "reverse" Enum: "chronological" "reverse" Chronological
|
type | string Enum: "transfer" "migration" "allocation" "release" Example: type=transfer Transaction type:
|
status | string Enum: "registered" "sent" "received" "failed" Example: status=received Transaction status:
|
OK
Transactions not found
Invalid parameter(s) format
Endpoint not found
Internal server error
MainNet
TestNet
[- {
- "index": "38134090:58",
- "txID": "insolar:1GlDeBOnc7Ar5N34ShBdkx_SAVOfnZJKUCoQMi0_OcvE.record",
- "amount": "100",
- "fee": "1",
- "timestamp": 1562754412,
- "status": "received",
- "pulseNumber": 22385288,
- "type": "transfer",
- "toMemberReference": "insolar:1AfNjPWh7Ut-P7Ky7Mj7HLCte3gjGXi4RpXNxTvrhlww",
- "fromMemberReference": "insolar:1GlDeBOnc7Ar5N34ShBdkx_SAVOfnZJKUCoQMi0_OcvE"
}, - {
- "index": "38134070:48",
- "txID": "insolar:1M9lO6JFGf6NXmBxkO5156zeeh7ip2SJzT96Vv4vZHeo.record",
- "amount": "150",
- "fee": "1",
- "timestamp": 1562754412,
- "status": "received",
- "pulseNumber": 22385288,
- "type": "migration",
- "fromMemberReference": "insolar:1FUpUFSfNpmyX05nustQ7B8al0xj-_j3_ndqXfgLRra4",
- "toMemberReference": "insolar:1AfNjPWh7Ut-P7Ky7Mj7HLCte3gjGXi4RpXNxTvrhlww",
- "toDepositReference": "insolar:1FUpUFSfNpmyX05nustQ7B8al0xj-_j3_ndqXfgLRra4"
}, - {
- "index": "38133910:31",
- "txID": "insolar:1FUpUFSfNpmyX05nustQ7B8al0xj-_j3_ndqXfgLRra4.record",
- "amount": "160",
- "fee": "1",
- "timestamp": 1562754412,
- "status": "received",
- "pulseNumber": 22385288,
- "type": "release",
- "toMemberReference": "insolar:1Fb0mZP1-Hekj-21wpyFRS2ww-nOdj1SqKPsfKy1R0PY",
- "fromDepositReference": "insolar:1FUpUFSfNpmyX05nustQ7B8al0xj-_j3_ndqXfgLRra3"
}, - {
- "index": "38133860:37",
- "txID": "insolar:6VlDeB2Tc3Ar5N38ShBdkx_SAVOfnZJKUCoQMi0_Occc.record",
- "amount": "100",
- "fee": "1",
- "timestamp": 1562754412,
- "status": "received",
- "pulseNumber": 22385288,
- "type": "transfer",
- "toMemberReference": "insolar:1AfNjPWh7Ut-P7Ky7Mj7HLCte3gjGXi4RpXNxTvrhlww",
- "fromMemberReference": "insolar:1GlDeBOnc7Ar5N34ShBdkx_SAVOfnZJKUCoQMi0_OcvE"
}, - {
- "index": "38133620:7",
- "txID": "insolar:3A6l16JFDf6NXmBxkO5156zeeh7ip2SJzT96Vv4vZfyR.record",
- "amount": "150",
- "fee": "1",
- "timestamp": 1562754412,
- "status": "received",
- "pulseNumber": 22385288,
- "type": "migration",
- "fromMemberReference": "insolar:1FUpUFSfNpmyX05nustQ7B8al0xj-_j3_ndqXfgLRra4",
- "toMemberReference": "insolar:1AfNjPWh7Ut-P7Ky7Mj7HLCte3gjGXi4RpXNxTvrhlww",
- "toDepositReference": "insolar:1FUpUFSfNpmyX05nustQ7B8al0xj-_j3_ndqXfgLRra4"
}, - {
- "index": "38133610:87",
- "txID": "insolar:8AGpUFSsBpmsX92nustQ7B8al0xj-_j3_ndqXfgLshR1.record",
- "amount": "160",
- "fee": "1",
- "timestamp": 1562754412,
- "status": "received",
- "pulseNumber": 22385288,
- "type": "release",
- "toMemberReference": "insolar:1Fb0mZP1-Hekj-21wpyFRS2ww-nOdj1SqKPsfKy1R0PY",
- "fromDepositReference": "insolar:1FUpUFSfNpmyX05nustQ7B8al0xj-_j3_ndqXfgLRra2"
}
]
Gets a list (page) of closed transactions (only with received
and failed
statuses).
To invoke this request, specify:
limit
to the number of transactions to get (page size).index
of the last known transaction. The list starts from the next one.order
of the transaction list: chronological
or reverse
(default).Note: Indexes in the list of closed transactions do not match the indexes in the lists returned by member transactions, transactions, and transactions in pulse range.
Each returned transaction has an index
which can be specified in the corresponding parameter in subsequent requests for closed transactions.
If the index
parameter is not specified, the request returns a list of the most recent or old (depending on the order
value) transactions.
limit required | integer [ 1 .. 1000 ] Example: limit=100 Number of entries per list. |
index |