Sign in

v1

latestOpenAPI 3.0.3Apache-2.02026-07-1348142206.6 KB
tokens

Get token by id

Returns token entity information given the id

get/api/v1/tokens/{tokenId}

Path parameters

tokenIdstring nullable required

Network entity ID in the format of shard.realm.num

Example:0.0.2

Token id

Query parameters

timestampstring

The Unix timestamp in seconds.nanoseconds format. See unixtimestamp.com for a simple way to convert a date to the 'seconds' part of the Unix time.

Response

OK

auto_renew_accountstring nullable

Network entity ID in the format of shard.realm.num

auto_renew_periodinteger nullable
created_timestampstring

A Unix timestamp in seconds.nanoseconds format

decimalsstring
deletedboolean nullable
expiry_timestampinteger nullable

The token's expiration time in nanoseconds since the Unix epoch. Note that this encoding differs from other entity expiry timestamps (e.g., accounts) which use a seconds.nanoseconds string format. This inconsistency is a known issue retained for backwards compatibility.

freeze_defaultboolean
initial_supplystring
max_supplystring
metadatastring byte

Arbitrary binary data associated with this token class encoded in base64.

modified_timestampstring

A Unix timestamp in seconds.nanoseconds format

namestring
memostring
pause_status'NOT_APPLICABLE' | 'PAUSED' | 'UNPAUSED'
supply_type'FINITE' | 'INFINITE'
symbolstring
token_idstring nullable

Network entity ID in the format of shard.realm.num

total_supplystring
treasury_account_idstring nullable

Network entity ID in the format of shard.realm.num

type'FUNGIBLE_COMMON' | 'NON_FUNGIBLE_UNIQUE'

Example response

{
  "admin_key": {
    "_type": "ProtobufEncoded",
    "key": "15706b229b3ba33d4a5a41ff54ce1cfe0a3d308672a33ff382f81583e02bd743"
  },
  "auto_renew_account": "0.0.2",
  "created_timestamp": "1586567700.453054000",
  "deleted": true,
  "expiry_timestamp": 1234567890100000,
  "fee_schedule_key": {
    "_type": "ProtobufEncoded",
    "key": "15706b229b3ba33d4a5a41ff54ce1cfe0a3d308672a33ff382f81583e02bd743"
  },
  "freeze_key": {
    "_type": "ProtobufEncoded",
    "key": "15706b229b3ba33d4a5a41ff54ce1cfe0a3d308672a33ff382f81583e02bd743"
  },
  "initial_supply": "1000000",
  "kyc_key": {
    "_type": "ProtobufEncoded",
    "key": "15706b229b3ba33d4a5a41ff54ce1cfe0a3d308672a33ff382f81583e02bd743"
  },
  "max_supply": "9223372036854775807",
  "metadata_key": {
    "_type": "ProtobufEncoded",
    "key": "15706b229b3ba33d4a5a41ff54ce1cfe0a3d308672a33ff382f81583e02bd743"
  },
  "modified_timestamp": "1586567700.453054000",
  "name": "Token name",
  "memo": "token memo",
  "pause_key": {
    "_type": "ProtobufEncoded",
    "key": "15706b229b3ba33d4a5a41ff54ce1cfe0a3d308672a33ff382f81583e02bd743"
  },
  "pause_status": "UNPAUSED",
  "supply_key": {
    "_type": "ProtobufEncoded",
    "key": "15706b229b3ba33d4a5a41ff54ce1cfe0a3d308672a33ff382f81583e02bd743"
  },
  "supply_type": "INFINITE",
  "symbol": "ORIGINALRDKSE",
  "token_id": "0.0.2",
  "total_supply": "1000000",
  "treasury_account_id": "0.0.2",
  "type": "FUNGIBLE_COMMON",
  "wipe_key": {
    "_type": "ProtobufEncoded",
    "key": "15706b229b3ba33d4a5a41ff54ce1cfe0a3d308672a33ff382f81583e02bd743"
  },
  "custom_fees": {
    "created_timestamp": "1586567700.453054000",
    "fixed_fees": [
      {
        "amount": 100,
        "collector_account_id": "0.0.2",
        "denominating_token_id": "0.0.2"
      }
    ],
    "fractional_fees": [
      {
        "amount": {
          "numerator": 12,
          "denominator": 29
        },
        "collector_account_id": "0.0.2",
        "denominating_token_id": "0.0.2",
        "maximum": 120,
        "minimum": 30,
        "net_of_transfers": true
      }
    ],
    "royalty_fees": [
      {
        "amount": {
          "numerator": 15,
          "denominator": 37
        },
        "collector_account_id": "0.0.2",
        "fallback_fee": {
          "amount": 100,
          "denominating_token_id": "0.0.2"
        }
      }
    ]
  }
}