Utilities

Token

Update Global Token Metadata

Update the metadata of the contract token.

HTTP Method: POST

Roles: User Admin

Endpoint: {{BASE_RESTFUL_URL}}/v1/update-global-token-metadata

Params:

{
  "token": {
    "data": {
      "metadata": {
        "logo": "https://assets.coingecko.com/coins/images/19201/standard/jFLSu4U9_400x400.png?1696518648",
        "price": 0.02
      },
      "token": {
        "tokenId": "57d31729-85f9-461f-b748-fb83dee71671"
      }
    }
  }
}

Response

{
  "v1UpdateGlobalPlanMetadata": {
    "res": {
      "id": "f8f6925d-f20a-40a6-bb57-40bed4de188e"
    },
    "success": true
  }
}

Get Token Price

Get the current instance configuration.

HTTP Method: GET

Roles: Guest

Endpoint: {{BASE_RESTFUL_URL}}/v1/get-token-price

Params:

{
  "symbol": "FACTR"
}

Response

{
    "token_price": [
        "price": 0.02,
        "symbol": "FACTR",
        "date": "2025-03-07T00:00:00.000Z"
     ]
}

config

Get the current instance configuration.

HTTP Method: GET

Roles: Guest

Endpoint: {{BASE_RESTFUL_URL}}/config

Params:

{}

Response

{
    "getConfig": {
      "res": {
        "inactiveNetworks": [
          "polygon",
          "base",
          "bsc"
        ],
        "networks": [
          {
            "contracts": [
              {
                "abi": [...],
                "address": "0x",
                "name": "STAKING",
                "params": {
                  "fromBlock": 0,
                  "nextBlock": 1000,
"lastHistoricalValueLockedUpdate": "2024-01-01T00:00:00.000Z",
                  "nextTimeTokenPrice": "2024-01-01T100:00:00.000Z"
                }
              }
            ],
            "inactiveContracts": [],
            "name": "ethereum",
            "providerHttps": "provider",
            "services": [
              "LISTENER"
            ],
            "tokensInfo": [
              {
                "isCoingeckoEnabled": true,
                "name": "defactor",
                "symbol": "FACTR"
              }
            ],
            "workers": [
              "BLOCK CATCHER",
              "TOKEN PRICE FETCHER",
              "EVENT MATURITY",
              "HISTORICAL VALUE LOCKED UPDATER"
            ]
          }
        ]
      },
      "success": true
    }
  }

v1 Get Circulating Supply

Makes an HTTP GET request to retrieve the circulating supply. The request does not include a request body.

HTTP Method: GET

Endpoint: {{BASE_RESTFUL_URL}}/v1-get-circulating-supply

Params:

{
  "global": {
    "networks": ["{{NETWORK_BASE}}"]
  }
}