Sign in
Protocols

Get protocols

Returns a list of protocols.

get/v1/protocols

Query parameters

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 protocols by specified field. Supported fields: code (default), firstLevel, lastLevel.

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

codeinteger

Protocol code, representing a number of protocol changes since genesis (mod 256, but -1 for the genesis block)

hashstring required

Hash of the protocol

versioninteger

Global version number

firstLevelinteger

Block height where the protocol was applied

firstCycleinteger

Index of the first cycle started with the protocol

firstCycleLevelinteger

Level of the first block of the first cycle started with the protocol

lastLevelinteger nullable

Block height where the protocol ends. null if the protocol is active

{"stackTrail":"components:schemas:Protocol:properties:extras","oasType":"schema","type":"unknown","description":"Off-chain extras","nullable":true}

Changes