SIsiafoundation
contracts

Query contracts

Changed on

Queries v1 contracts matching the provided filter and returns a paginated result.

post/contracts

Request

  • Base URL
    http://localhost:9980/api
  • URL
    http://localhost:9980/api/contracts
  • Auth
    HTTP basic

Request body

statusesstring[]

Filter by contract statuses.

contractIDsFileContractID[]

Filter by specific contract IDs.

renewedFromFileContractID[]

Filter by the contract ID this contract was renewed from.

renewedToFileContractID[]

Filter by the contract ID this contract was renewed to.

renterKeyPublicKey[]

Filter by renter public keys.

minNegotiationHeightinteger

Minimum block height at which the contract was negotiated.

maxNegotiationHeightinteger

Maximum block height at which the contract was negotiated.

minExpirationHeightinteger

Minimum contract expiration block height.

maxExpirationHeightinteger

Maximum contract expiration block height.

limitinteger

Maximum number of contracts to return per page. Defaults to 100.

offsetinteger

Number of contracts to skip for pagination.

sortFieldstring

Field to sort results by. Valid values are "status", "negotiationHeight", "expirationHeight".

sortDescboolean

Sort in descending order when true.

Response

Contracts matching filter.

countinteger required

Total number of contracts matching the filter.

contractsContract[] required

Contracts matching the filter for the current page.

Changes

  • 42e63d370299Revision changes
    • breaking

      the request property's max was decreased to 100.00

    • breaking

      the request property's min was increased to 1.00

  • 087a58eeff36Revision changes
    • info

      endpoint deprecated

    • info

      the request property's min was decreased from 1.00 to 0.00