Skip to main content
API docs by Redocly

Assetmanager Scope Lookups (v1.0.0)

Download OpenAPI specification:Download

NUVA Labs: inbound@nuvalabs.com URL: https://nuvalabs.com/ License: Apache 2.0 Terms of Service

API Documentation for Assetmanager Scope Lookups

Scope

Scope searches for a scope.

The scope id, if provided, must either be scope uuid, e.g. 91978ba2-5f35-459a-86a7-feca1b0512e0 or a scope address, e.g. scope1qzge0zaztu65tx5x5llv5xc9ztsqxlkwel. The session addr, if provided, must be a bech32 session address, e.g. session1qxge0zaztu65tx5x5llv5xc9zts9sqlch3sxwn44j50jzgt8rshvqyfrjcr. The record_addr, if provided, must be a bech32 record address, e.g. record1q2ge0zaztu65tx5x5llv5xc9ztsw42dq2jdvmdazuwzcaddhh8gmu3mcze3.

  • If only a scope_id is provided, that scope is returned.
  • If only a session_addr is provided, the scope containing that session is returned.
  • If only a record_addr is provided, the scope containing that record is returned.
  • If more than one of scope_id, session_addr, and record_addr are provided, and they don't refer to the same scope, a bad request is returned.

Providing a session addr or record addr does not limit the sessions and records returned (if requested). Those parameters are only used to find the scope.

By default, sessions and records are not included. Set include_sessions and/or include_records to true to include sessions and/or records.

Authorizations:
bearerAuth
path Parameters
scope_id
required
string (scope_id)

scope_id can either be a uuid, e.g. 91978ba2-5f35-459a-86a7-feca1b0512e0 or a bech32 scope address, e.g. scope1qzge0zaztu65tx5x5llv5xc9ztsqxlkwel.

query Parameters
sessionAddr
string (session_addr)

session_addr is a bech32 session address, e.g. session1qxge0zaztu65tx5x5llv5xc9zts9sqlch3sxwn44j50jzgt8rshvqyfrjcr.

recordAddr
string (record_addr)

record_addr is a bech32 record address, e.g. record1q2ge0zaztu65tx5x5llv5xc9ztsw42dq2jdvmdazuwzcaddhh8gmu3mcze3.

includeSessions
boolean (include_sessions)

include_sessions is a flag for whether to include the sessions of the scope in the response.

includeRecords
boolean (include_records)

include_records is a flag for whether to include the records of the scope in the response.

excludeIdInfo
boolean (exclude_id_info)

exclude_id_info is a flag for whether to exclude the id info from the response.

includeRequest
boolean (include_request)

include_request is a flag for whether to include this request in your result.

Responses

Response samples

Content type
application/json
{
  • "scope": {
    },
  • "sessions": [
    ],
  • "records": [
    ],
  • "request": {
    }
}

ScopesAll

ScopesAll retrieves all scopes.

Authorizations:
bearerAuth
query Parameters
excludeIdInfo
boolean (exclude_id_info)

exclude_id_info is a flag for whether to exclude the id info from the response.

includeRequest
boolean (include_request)

include_request is a flag for whether to include this request in your result.

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
{
  • "scopes": [
    ],
  • "request": {
    },
  • "pagination": {
    }
}

ScopeSpecification

ScopeSpecification returns a scope specification for the given specification id.

The specification_id can either be a uuid, e.g. dc83ea70-eacd-40fe-9adf-1cf6148bf8a2 or a bech32 scope specification address, e.g. scopespec1qnwg86nsatx5pl56muw0v9ytlz3qu3jx6m.

By default, the contract and record specifications are not included. Set include_contract_specs and/or include_record_specs to true to include contract and/or record specifications.

Authorizations:
bearerAuth
path Parameters
specification_id
required
string (specification_id)

specification_id can either be a uuid, e.g. dc83ea70-eacd-40fe-9adf-1cf6148bf8a2 or a bech32 scope specification address, e.g. scopespec1qnwg86nsatx5pl56muw0v9ytlz3qu3jx6m.

query Parameters
includeContractSpecs
boolean (include_contract_specs)

include_contract_specs is a flag for whether to include the contract specifications of the scope specification in the response.

includeRecordSpecs
boolean (include_record_specs)

include_record_specs is a flag for whether to include the record specifications of the scope specification in the response.

excludeIdInfo
boolean (exclude_id_info)

exclude_id_info is a flag for whether to exclude the id info from the response.

includeRequest
boolean (include_request)

include_request is a flag for whether to include this request in your result.

Responses

Response samples

Content type
application/json
{
  • "scopeSpecification": {
    },
  • "contractSpecs": [
    ],
  • "recordSpecs": [
    ],
  • "request": {
    }
}

Get scope

Authorizations:
BearerAuth
path Parameters
required
string or string (ScopeId)

Scope identifier

query Parameters
hydrate
Array of strings or null

A list of record names to hydrate and return raw data for, defaults to hydrating all records when not provided. Hydration of records is a time consuming process so it is recommended to not hydrate more than is needed for improved response times.

block_height
integer or null <int64> >= 0

When provided, fetches a scope's state based on a previous block height. Defaults to the current (head) chain state.

Responses

Response samples

Content type
application/json
{
  • "scope": {
    },
  • "records": [
    ]
}