Get commitments
Returns a list of commitments.
Query parameters
Filters commitments by activation status
Equal filter mode (optional, i.e. param.eq=123 is the same as param=123).
Specify an integer number to get items where the specified field is equal to the specified value.
Example: ?balance=1234.
Not equal filter mode.
Specify an integer number to get items where the specified field is not equal to the specified value.
Example: ?balance.ne=1234.
Greater than filter mode.
Specify an integer number to get items where the specified field is greater than the specified value.
Example: ?balance.gt=1234.
Greater or equal filter mode.
Specify an integer number to get items where the specified field is greater than equal to the specified value.
Example: ?balance.ge=1234.
Less than filter mode.
Specify an integer number to get items where the specified field is less than the specified value.
Example: ?balance.lt=1234.
Less or equal filter mode.
Specify an integer number to get items where the specified field is less than or equal to the specified value.
Example: ?balance.le=1234.
In list (any of) filter mode.
Specify a comma-separated list of integers to get items where the specified field is equal to one of the specified values.
Example: ?level.in=12,14,52,69.
Not in list (none of) filter mode.
Specify a comma-separated list of integers to get items where the specified field is not equal to all the specified values.
Example: ?level.ni=12,14,52,69.
Is null filter mode.
Use this mode to get items where the specified field is null or not.
Example: ?nonce.null or ?nonce.null=false.
Filters commitments by activation level
Equal filter mode (optional, i.e. param.eq=123 is the same as param=123).
Specify an integer number to get items where the specified field is equal to the specified value.
Example: ?balance=1234.
Not equal filter mode.
Specify an integer number to get items where the specified field is not equal to the specified value.
Example: ?balance.ne=1234.
Greater than filter mode.
Specify an integer number to get items where the specified field is greater than the specified value.
Example: ?balance.gt=1234.
Greater or equal filter mode.
Specify an integer number to get items where the specified field is greater than equal to the specified value.
Example: ?balance.ge=1234.
Less than filter mode.
Specify an integer number to get items where the specified field is less than the specified value.
Example: ?balance.lt=1234.
Less or equal filter mode.
Specify an integer number to get items where the specified field is less than or equal to the specified value.
Example: ?balance.le=1234.
In list (any of) filter mode.
Specify a comma-separated list of integers to get items where the specified field is equal to one of the specified values.
Example: ?level.in=12,14,52,69.
Not in list (none of) filter mode.
Specify a comma-separated list of integers to get items where the specified field is not equal to all the specified values.
Example: ?level.ni=12,14,52,69.
Filters commitments by activated balance
Fields selection mode (optional, i.e. select.fields=balance is the same as select=balance).
Specify a comma-separated list of fields to include into response.
Example: ?select=address,balance => [ { "address": "asd", "balance": 10 } ].
Values selection mode.
Specify a comma-separated list of fields to include their values into response.
Example: ?select.values=address,balance => [ [ "asd", 10 ] ].
Specify comma-separated list of fields to include into response or leave it undefined to return full object. If you select single field, response will be an array of values in both .fields and .values modes.
Ascending sort mode (optional, i.e. sort.asc=id is the same as sort=id).
Specify a field name to sort by.
Example: ?sort=balance.
Descending sort mode.
Specify a field name to sort by descending.
Example: ?sort.desc=id.
Sorts delegators by specified field. Supported fields: id (default), balance, activationLevel.
Elements offset mode (optional, i.e. offset.el=123 is the same as offset=123).
Skips specified number of elements.
Example: ?offset=100.
Page offset mode.
Skips page * limit elements. This is a classic pagination.
Example: ?offset.pg=1.
Cursor offset mode.
Skips all elements with the cursor before (including) the specified value. Cursor is a field used for sorting, e.g. id.
Avoid using this offset mode with non-unique or non-sequential cursors such as amount, balance, etc.
Example: ?offset.cr=45837.
Specifies which or how many items should be skipped
Maximum number of items to return
Response
Blinded address of the account
Account balance to be activated
Flag showing whether the account has been activated or not.
Level of the block at which the account has been activated. null if the account is not activated yet.
Datetime of the block at which the account has been activated (ISO 8601, e.g. 2020-02-20T02:40:57Z). null if the account is not activated yet.