Quota

Get Quota for the current Api Key

This will return the number of monthly tokens minted and the remaining amount for your plan.

An Api Key must be passed in the header of the request see Authentication

HTTP Request

GET https://platform.taal.com/token-studio/api/v1/quota

cURL

curl --location --request GET  \
  "https://platform.taal.com/token-studio/api/v1/quota" \
  --header "Apikey: ## VALID_API_KEY ##"

Response JSON structure

{
  "success": true,
  "data": {
    "apiKey": "testnet_abcdefghijklmnopqrstuvwxyz",
    "startDate": "2023-03-02T09:40:11.521Z",
    "endDate": "2023-03-02T09:40:11.521Z",
    "monthlyMintLimit": 5,
    "totalUsed": 2,
    "available": 3
  }
}

Get Quota for a collection of api keys

This will return the number of monthly tokens minted and the remaining amount for the plan for api keys that are passed to it. The api keys must belong to the same user that the authentication api key belongs to.

An Api Key must be passed in the header of the request see Authentication

HTTP Request

POST https://platform.taal.com/token-studio/api/v1/quota/keys

cURL

curl --location --request POST \
  "https://platform.taal.com/token-studio/api/v1/quota/keys" \
  --header "Apikey: ## VALID_API_KEY ##" \
  --header "Content-Type: application/json" \
  --data "{\"apiKeys\" : [\"testnet_abcdefghijklmnopqrstuvwxyz\",\"testnet_zyxwvutsrqponmlkjihgfedcba\" ] }"

The JSON structure for the above post request:

{
  "apiKeys": [
    "testnet_abcdefghijklmnopqrstuvwxyz",
    "testnet_zyxwvutsrqponmlkjihgfedcba"
  ]
}

Response JSON structure

{
  "success": true,
  "data": [
    {
      "apiKey": "testnet_abcdefghijklmnopqrstuvwxyz",
      "startDate": "2023-03-02T09:42:49.768Z",
      "endDate": "2023-03-02T09:42:49.768Z",
      "monthlyMintLimit": 5,
      "totalUsed": 2,
      "available": 3
    },
    {
      "apiKey": "testnet_zyxwvutsrqponmlkjihgfedcba",
      "startDate": "2023-03-02T09:42:49.768Z",
      "endDate": "2023-03-02T09:42:49.768Z",
      "monthlyMintLimit": 4,
      "totalUsed": 1,
      "available": 3
    }
  ]
}