Skip to main content

Pending Transfers

Cosmos.quarantine.v1beta1.Query (v1.0.0)

Download OpenAPI specification:Download

API Documentation for Cosmos.quarantine.v1beta1.Query

IsQuarantined

IsQuarantined checks if an account has opted into quarantine.

Authorizations:
bearerAuth
path Parameters
to_address
required
string (to_address)

to_address is the address to check.

Responses

Response samples

Content type
application/json
{
  • "isQuarantined": true
}

AutoResponses

AutoResponses gets the auto-response settings for a quarantined account.

The to_address is required. If a from_address is provided only the auto response for that from_address will be returned. If no from_address is provided, all auto-response settings for the given to_address will be returned.

Authorizations:
bearerAuth
path Parameters
to_address
required
string (to_address)

to_address is the quarantined account to get info on.

query Parameters
fromAddress
string (from_address)

from_address is an optional sender address to limit results.

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

Content type
application/json
{
  • "autoResponses": [
    ],
  • "pagination": {
    }
}

AutoResponses

AutoResponses gets the auto-response settings for a quarantined account.

The to_address is required. If a from_address is provided only the auto response for that from_address will be returned. If no from_address is provided, all auto-response settings for the given to_address will be returned.

Authorizations:
bearerAuth
path Parameters
to_address
required
string (to_address)

to_address is the quarantined account to get info on.

from_address
required
string (from_address)

from_address is an optional sender address to limit results.

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

Content type
application/json
{
  • "autoResponses": [
    ],
  • "pagination": {
    }
}

QuarantinedFunds

QuarantinedFunds gets information about funds that have been quarantined.

If both a to_address and from_address are provided, any such quarantined funds will be returned regardless of whether they've been declined. If only a to_address is provided, the unaccepted and undeclined funds waiting on a response from to_address will be returned. If neither a to_address nor from_address is provided, all non-declined quarantined funds for any address will be returned. The request is invalid if only a from_address is provided.

Authorizations:
bearerAuth
query Parameters
toAddress
string (to_address)

to_address is the intended recipient of the coins that have been quarantined.

fromAddress
string (from_address)

from_address is the sender of the coins. If provided, a to_address must also be provided.

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

Content type
application/json
{
  • "quarantinedFunds": [
    ],
  • "pagination": {
    }
}

QuarantinedFunds

QuarantinedFunds gets information about funds that have been quarantined.

If both a to_address and from_address are provided, any such quarantined funds will be returned regardless of whether they've been declined. If only a to_address is provided, the unaccepted and undeclined funds waiting on a response from to_address will be returned. If neither a to_address nor from_address is provided, all non-declined quarantined funds for any address will be returned. The request is invalid if only a from_address is provided.

Authorizations:
bearerAuth
path Parameters
to_address
required
string (to_address)

to_address is the intended recipient of the coins that have been quarantined.

query Parameters
fromAddress
string (from_address)

from_address is the sender of the coins. If provided, a to_address must also be provided.

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

Content type
application/json
{
  • "quarantinedFunds": [
    ],
  • "pagination": {
    }
}

QuarantinedFunds

QuarantinedFunds gets information about funds that have been quarantined.

If both a to_address and from_address are provided, any such quarantined funds will be returned regardless of whether they've been declined. If only a to_address is provided, the unaccepted and undeclined funds waiting on a response from to_address will be returned. If neither a to_address nor from_address is provided, all non-declined quarantined funds for any address will be returned. The request is invalid if only a from_address is provided.

Authorizations:
bearerAuth
path Parameters
to_address
required
string (to_address)

to_address is the intended recipient of the coins that have been quarantined.

from_address
required
string (from_address)

from_address is the sender of the coins. If provided, a to_address must also be provided.

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

Content type
application/json
{
  • "quarantinedFunds": [
    ],
  • "pagination": {
    }
}