Read a Token

You can read the details of a token by sending a GET request to the /token endpoint with the token name in the path.

Read the details of a token.

GET https://api.playfix.io/token/<token_name>

Path Parameters

Name	Type	Description
token_name	String	An automatically generated token name. This will start with a prefix of "tokens/" followed by a ULID. Example: tokens/01gfrf15n9hqw3v08sqearsgh9

Headers

Name	Type	Description
Authorization	String	Bearer <your_access_token>

200: OK Successfully read the token details.

{
  "name": "<token_name>",
  "project": "projects/01gfav9m1c4zd6eq154th2pafz",
  "title": "The Block Party Token",
  "config": {
    "name": "Blocked",
    "symbol": "BPT",
    "decimals": "18",
    "initialSupply": "1000",
    "totalSupply": "10000",
    "mintable": true,
    "burnable": true,
    "pausable": true,
    "permit": true,
    "votes": true,
    "flashMinting": true,
    "snapshots": true,
    "ownerAddress": "<your_wallet_address>"
    },
  "network": "NETWORK_POLYGON_MUMBAI",
  "address": "<contract_address>",
  "deployTxHash": ""
}

Example cURL API Call

curl --request GET \
  --url 'https://api.playfix.io/token/<token_name>' \
  --header 'Authorization: Bearer <access_token>'

Example Python API Call

import requests

r = requests.get(
    "https://api.playfix.io/token/<token_name>",
    headers = {
        "Authorization": "Bearer <access_token>"
        }
    )

print(r.text)

Response

{
  "name": "<token_name>",
  "project": "projects/01gfav9m1c4zd6eq154th2pafz",
  "title": "The Block Party Token",
  "config": {
    "name": "Blocked",
    "symbol": "BPT",
    "decimals": "18",
    "initialSupply": "1000",
    "totalSupply": "10000",
    "mintable": true,
    "burnable": true,
    "pausable": true,
    "permit": true,
    "votes": true,
    "flashMinting": true,
    "snapshots": true,
    "ownerAddress": "<your_wallet_address>"
    },
  "network": "NETWORK_POLYGON_MUMBAI",
  "address": "<contract_address>",
  "deployTxHash": ""
}