Rights

Get rights

Returns a list of rights.

get/v1/rights

Query parameters

eqstring nullable

Equal filter mode (optional, i.e. param.eq=123 is the same as param=123).
Specify baking right type to get items where the specified field is equal to the specified value.

Example: ?type=baking.

nestring nullable

Not equal filter mode.
Specify baking right type to get items where the specified field is not equal to the specified value.

Example: ?type.ne=attestation.

Filters rights by type (baking, attestation)

eqstring nullable

Equal filter mode (optional, i.e. param.eq=123 is the same as param=123).
Specify a tz or KT address to get items where the specified field is equal to the specified value.

Example: ?sender=tz1WnfXMPaNTBmH7DBPwqCWs9cPDJdkGBTZ8.

nestring nullable

Not equal filter mode.
Specify a tz or KT address to get items where the specified field is not equal to the specified value.

Example: ?sender.ne=tz1WnfXMPaNTBmH7DBPwqCWs9cPDJdkGBTZ8.

instring[] nullable

In list (any of) filter mode.
Specify a comma-separated list of addresses to get items where the specified field is equal to one of the specified values.

Example: ?sender.in=tz1WnfXMPaNTBWnfXMPaNTBWnfXMPaNTBNTB,tz1SiPXX4MYGNJNDSiPXX4MYGNJNDSiPXX4M.

nistring[] nullable

Not in list (none of) filter mode.
Specify a comma-separated list of addresses to get items where the specified field is not equal to all the specified values.

Example: ?sender.ni=tz1WnfXMPaNTBWnfXMPaNTBWnfXMPaNTBNTB,tz1SiPXX4MYGNJNDSiPXX4MYGNJNDSiPXX4M.

eqxstring nullable

Equal to another field filter mode.
Specify a field name to get items where the specified fields are equal.

Example: ?sender.eqx=target.

nexstring nullable

Not equal to another field filter mode.
Specify a field name to get items where the specified fields are not equal.

Example: ?sender.nex=initiator.

nullboolean nullable

Is null filter mode.
Use this mode to get items where the specified field is null or not.

Example: ?initiator.null or ?initiator.null=false.

Filters rights by baker

eqinteger nullable

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.

neinteger nullable

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.

gtinteger nullable

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.

geinteger nullable

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.

ltinteger nullable

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.

leinteger nullable

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.

ininteger[] nullable

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.

niinteger[] nullable

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 rights by cycle

eqinteger nullable

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.

neinteger nullable

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.

gtinteger nullable

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.

geinteger nullable

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.

ltinteger nullable

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.

leinteger nullable

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.

ininteger[] nullable

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.

niinteger[] nullable

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 rights by level

eqinteger nullable

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.

neinteger nullable

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.

gtinteger nullable

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.

geinteger nullable

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.

ltinteger nullable

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.

leinteger nullable

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.

ininteger[] nullable

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.

niinteger[] nullable

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.

nullboolean nullable

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 rights by slots

eqinteger nullable

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.

neinteger nullable

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.

gtinteger nullable

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.

geinteger nullable

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.

ltinteger nullable

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.

leinteger nullable

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.

ininteger[] nullable

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.

niinteger[] nullable

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.

nullboolean nullable

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 rights by round

eqstring nullable

Equal filter mode (optional, i.e. param.eq=123 is the same as param=123).
Specify baking right status to get items where the specified field is equal to the specified value.

Example: ?type=future.

nestring nullable

Not equal filter mode.
Specify baking right status to get items where the specified field is not equal to the specified value.

Example: ?type.ne=missed.

Filters rights by status (future, realized, missed)

fieldsstring[] nullable

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 } ].

valuesstring[] nullable

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.

ascstring nullable

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.

descstring nullable

Descending sort mode.
Specify a field name to sort by descending.

Example: ?sort.desc=id.

Sorts rights by specified field. Supported fields: level (default).

elinteger nullable

Elements offset mode (optional, i.e. offset.el=123 is the same as offset=123).
Skips specified number of elements.

Example: ?offset=100.

pginteger nullable

Page offset mode.
Skips page * limit elements. This is a classic pagination.

Example: ?offset.pg=1.

crinteger nullable

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

limitinteger

Maximum number of items to return

Response

typestring required

Type of the right:

baking - right to bake (produce) a block;
attestation - right to attest (validate) a block.

cycleinteger

Cycle on which the right can be realized.

levelinteger

Level at which a block must be baked or an attestation must be sent.

timestampstring date-time

Time (estimated, in case of future rights) when a block must be baked or an attestation must be sent.

roundinteger nullable

Round (0 - ∞) at which the baker can propose/produce a block. If a baker at round 0 doesn't produce a block within the given time interval, then the right goes to a baker at round 1, etc. For attestation rights this field is always null.

slotsinteger nullable

Number of slots to be attested. For baking rights this field is always null.

statusstring required

Status of the baking or attestation right:

future - the right is not realized yet;
realized - the right was successfully realized;
missed - the right was not realized.

Changes

No recorded changes to this endpoint across all 1 revision of this API.