Listings
Trade Transfer Commitments Listings (v1.0.0)
Download OpenAPI specification:Download
API Documentation for Trade Transfer Commitments Listings
GetAllCommitments
GetAllCommitments gets all fund committed to any market from any account.
Authorizations:
query Parameters
| pagination.key | string <byte> (key) key is a value returned in PageResponse.next_key to begin querying the next page most efficiently. Only one of offset or key should be set. |
| pagination.offset | integer or string <int64> (offset) offset is a numeric offset that can be used when key is unavailable. It is less efficient than using key. Only one of offset or key should be set. |
| pagination.limit | integer or string <int64> (limit) limit is the total number of results to be returned in the result page. If left empty it will default to a value to be set by each app. |
| pagination.countTotal | boolean (count_total) count_total is set to true to indicate that the result set should include a count of the total number of items available for pagination in UIs. count_total is only respected when offset is used. It is ignored when key is set. |
| pagination.reverse | boolean (reverse) reverse is set to true if results are to be returned in the descending order. Since: cosmos-sdk 0.43 |
Responses
Response samples
- 200
{- "commitments": [
- {
- "account": "string",
- "marketId": 0,
- "amount": [
- {
- "denom": "string",
- "amount": "string"
}
]
}
], - "pagination": {
- "nextKey": "string",
- "total": 0
}
}GetAccountCommitments
GetAccountCommitments gets all the funds in an account that are committed to any market.
Authorizations:
path Parameters
| account required | string (account) account is the bech32 address string of the account with the commitments. |
Responses
Response samples
- 200
{- "commitments": [
- {
- "marketId": 0,
- "amount": [
- {
- "denom": "string",
- "amount": "string"
}
]
}
]
}GetMarketCommitments
GetMarketCommitments gets all the funds committed to a market from any account.
Authorizations:
path Parameters
| market_id required | integer (market_id) market_id is the numeric identifier of the market with the commitment. |
query Parameters
| pagination.key | string <byte> (key) key is a value returned in PageResponse.next_key to begin querying the next page most efficiently. Only one of offset or key should be set. |
| pagination.offset | integer or string <int64> (offset) offset is a numeric offset that can be used when key is unavailable. It is less efficient than using key. Only one of offset or key should be set. |
| pagination.limit | integer or string <int64> (limit) limit is the total number of results to be returned in the result page. If left empty it will default to a value to be set by each app. |
| pagination.countTotal | boolean (count_total) count_total is set to true to indicate that the result set should include a count of the total number of items available for pagination in UIs. count_total is only respected when offset is used. It is ignored when key is set. |
| pagination.reverse | boolean (reverse) reverse is set to true if results are to be returned in the descending order. Since: cosmos-sdk 0.43 |
Responses
Response samples
- 200
{- "commitments": [
- {
- "account": "string",
- "amount": [
- {
- "denom": "string",
- "amount": "string"
}
]
}
], - "pagination": {
- "nextKey": "string",
- "total": 0
}
}