Sign in
SmartRollups

Get inbox messages

Returns a list of smart rollup inbox messages.

get/v1/smart_rollups/inbox

Query parameters

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.

Filter by internal TzKT id.
Click on the parameter to expand more details.

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.

Filter by level of the block, where the message was pushed.
Click on the parameter to expand more details.

eqstring date-time nullable

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

Example: ?timestamp=2020-02-20T02:40:57Z.

nestring date-time nullable

Not equal filter mode.
Specify a datetime value to get items where the specified field is not equal to the specified value.

Example: ?timestamp.ne=2020-02-20T02:40:57Z.

gtstring date-time nullable

Greater than filter mode.
Specify a datetime value to get items where the specified field is greater than the specified value.

Example: ?timestamp.gt=2020-02-20T02:40:57Z.

gestring date-time nullable

Greater or equal filter mode.
Specify a datetime value to get items where the specified field is greater than equal to the specified value.

Example: ?timestamp.ge=2020-02-20T02:40:57Z.

ltstring date-time nullable

Less than filter mode.
Specify a datetime value to get items where the specified field is less than the specified value.

Example: ?timestamp.lt=2020-02-20T02:40:57Z.

lestring date-time nullable

Less or equal filter mode.
Specify a datetime value to get items where the specified field is less than or equal to the specified value.

Example: ?timestamp.le=2020-02-20T02:40:57Z.

instring[] nullable

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

Example: ?timestamp.in=2020-02-20,2020-02-21.

nistring[] nullable

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

Example: ?timestamp.ni=2020-02-20,2020-02-21.

Filter by timestamp of the block, where the message was pushed.
Click on the parameter to expand more details.

eqstring nullable

Equal filter mode (.eq suffix can be omitted, i.e. ?param=... is the same as ?param.eq=...).
Specify an inbox message type to get items where the specified field is equal to the specified value.

Example: ?status=external.

nestring nullable

Not equal filter mode.
Specify an inbox message type to get items where the specified field is not equal to the specified value.

Example: ?status.ne=transfer.

instring[] nullable

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

Example: ?status.in=transfer,external.

nistring[] nullable

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

Example: ?status.ni=transfer,external.

Filter by inbox message type (level_start, level_info, level_end, transfer, external, migration).
Click on the parameter to expand more details.

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 items (asc or desc) by the specified field. You can see what fields can be used for sorting in the response description, below.
Click on the parameter to expand more details.

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.
Click on the parameter to expand more details.

limitinteger

Maximum number of items to return.

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 as b,metadata.name as meta_name will result in [ { "address": "asd", "b": 10, "meta_name": "qwe" } ].

valuesstring[] nullable

Values selection mode.
Specify a comma-separated list of fields to include their values into response.

Example: ?select.values=address,balance,metadata.name will result in [ [ "asd", 10, "qwe" ] ].

Specify a comma-separated list of fields to include into response or leave it undefined to get default set of fields. This parameter accepts values of the following format: {field}{path?}{as alias?}, so you can do deep selection (for example, ?select=balance,token.metadata.symbol as token,...).
Note, if you select just one field, the response will be flatten into a simple array of values.
Click on the parameter to expand the details.

micheline'Json' | 'JsonString' | 'Raw' | 'RawString'

Format of smart rollup call parameters: 0 - JSON, 1 - JSON string, 2 - raw micheline, 3 - raw micheline string

Response

idinteger

Internal TzKT id.
[sortable]

levelinteger

Level of the block where the message was pushed.
[sortable]

indexinteger

Index of the inbox message within the block.

timestampstring date-time

Timestamp of the block where the message was pushed.

typestring required

Type of the message (level_start, level_info, level_end, transfer, external, migration).

predecessorHashstring nullable

For level_info messages only. Hash of the predecessor block.

predecessorTimestampstring date-time nullable

For level_info messages only. Timestamp of the predecessor block.

entrypointstring nullable

For transfer messages only. Entrypoint called in the target rollup

{"stackTrail":"components:schemas:SrMessage:properties:parameter","oasType":"schema","type":"unknown","description":"For `transfer` messages only. Value passed to the called entrypoint. Note: you can configure parameters format by setting `micheline` query parameter.","nullable":true}
payloadstring byte nullable

For external messages only. Payload bytes (in base64).

protocolstring nullable

For migration messages only. Version of the new protocol (e.g. 'nairobi_017').

Changes

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