Skip to main content

Address Directory

Address Directory (v1.0.0)

Download OpenAPI specification:Download

API Documentation for Address Directory

SearchAddresses

SearchAddresses returns a list of Bech32 addresses matching the query.

Authorizations:
bearerAuth
query Parameters
query
string (query)

A query string to filter results. Performs a case-insensitive substring match.

limit
integer <int32> (limit)

Optional. The maximum number of results to return.

searchBy
string (search_by)
Enum: "ADDRESS_SEARCH_BY_UNSPECIFIED" "ADDRESS_ONLY" "PUBLIC_NAME_ONLY"

Optional. Specify whether to search by address, public name, or both.

Responses

Response samples

Content type
application/json
{
  • "results": [
    ]
}

GetAddressBalanceDetails

GetAddressBalanceDetails returns detailed balance and pricing info for an address.

Authorizations:
bearerAuth
path Parameters
address
required
string (address)

Bech32 address to get balance details for.

Responses

Response samples

Content type
application/json
{
  • "balances": [
    ]
}