• Public
  • Public/Protected
  • All

Defines the params used to search blocks. With this criteria, you can sort and filter block queries using rest.




Optional beneficiaryAddress

beneficiaryAddress: string

beneficiary address. (optional)

Optional offset

offset: string

Entry id at which to start pagination. If the ordering parameter is set to -id, the elements returned precede the identifier. Otherwise, newer elements with respect to the id are returned. (optional)

Optional order

order: Asc | Desc

Sort responses in ascending or descending order based on the collection property set on the param ''order''. If the request does not specify ''order'', REST returns the collection ordered by id. (optional)

Optional orderBy

orderBy: Id | Height

Order by block id or height. (optional)

Optional pageNumber

pageNumber: number

Filter by page number. (optional)

Optional pageSize

pageSize: number

Number of entities to return for each request. (optional)

Optional signerPublicKey

signerPublicKey: string

Public key of the account signing the entity. (optional)

Generated using TypeDoc