List Omni Tokens By Address

Through this endpoint the customer can receive basic information about a given Omni address based on confirmed/synced blocks only. In the case where there are any incoming or outgoing unconfirmed transactions for the specific address, they will not be counted or calculated here.

GET /blockchain-data/{blockchain}/{network}/omni/addresses/{address}

Path Parameters

  • Required
    network string

    Represents the name of the blockchain network used; blockchain networks are usually identical as technology and software, but they differ in data, e.g. - "mainnet" is the live network with actual data while networks like "testnet", "ropsten", "rinkeby" are test networks.

    Example : testnet
    Possible Values : mainnet testnet
  • Required
    blockchain string

    Represents the specific blockchain protocol name, e.g. Ethereum, Bitcoin, etc.

    Example : bitcoin
    Possible Values : bitcoin
  • Required
    address string

    Represents the public address, which is a compressed and shortened form of a public key.

    Example : mi7iSsKcvyFYNsiYdDZqJmH75RmoHomwmo

Response schema

200 400 401 402 403 409 415 422 429 500
HTTP Status Code: 200
Content-Type: application/json

The request has been successful.

  • Object :

  • Required
    apiVersion string

    Specifies the version of the API that incorporates this endpoint.

    Example : 2.0
  • Required
    requestId string

    Defines the ID of the request. The requestId is generated by Crypto APIs and it's unique for every request.

    Example : 601c1710034ed6d407996b30
  • Optional
    context string

    In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. context is specified by the user.

    Example : You can add any text here
  • Required
    data object
    • Required
      offset integer

      The starting index of the response items, i.e. where the response should start listing the returned items.

      Example : 0
    • Required
      limit integer

      Defines how many items should be returned in the response per page basis.

      Example : 50
    • Required
      total integer

      Defines the total number of items returned in the response.

      Example : 100
    • Required
      items array
      Example : Array ( )
      • Required
        balance string

        Defines the balance of the Omni tokens to send in the address.

        Example : 29
      • Required
        frozen string

        Defines the amount frozen by the issuer (applies to managed properties only).

        Example : 0
      • Required
        name string

        Defines the name of the Omni tokens to send.

        Example : Omni tokens
      • Required
        propertyId integer

        Represents the identifier of the tokens to send.

        Example : 1
      • Required
        reserved string

        Represents the amount reserved by sell offers and accepts.

        Example : 0
Try it out

Request Example

Content-Type: application/json
X-API-Key: my-api-key

Response Example

    "apiVersion": "2.0",
    "requestId": "601c1710034ed6d407996b30",
    "context": "You can add any text here",
    "data": {
        "offset": 0,
        "limit": 50,
        "total": 100,
        "items": [
                "balance": "29",
                "frozen": "0",
                "name": "Omni tokens",
                "propertyId": 1,
                "reserved": "0"