Api/ServiceUtilsApi
// Set your API Keys 👇 here
$sdk = new \Tatum\Sdk();
// MainNet API Call
$sdk->mainnet()->api()->serviceUtils();
// TestNet API Call
$sdk->testnet()->api()->serviceUtils();
Methods
| Method | Description |
|---|---|
| freezeApiKey() | Freeze API Key |
| getCredits() | Get information about your credit consumption for the last month |
| getVersion() | Get API version |
| unfreezeApiKey() | Unfreeze API Key |
freezeApiKey()
Example
#️⃣ Execute command in terminal
Request
PUT
/v3/tatum/freeze
Type signature
(new \Tatum\Sdk())->{mainnet/testnet}()->api()->serviceUtils()->freezeApiKey()
Parameters
This endpoint does not need any parameter.
Return type
void (empty response body)
Description
Freeze API Key
2 credits per API call.
Freeze the API Key. It’s not possible to perform sensitive operations like send ledger transaction, send off-chain transaction, send blockchain transaction, broadcast blockchain transaction, perform Order book trade or create blockage. Only read operations are permitted.
getCredits()
Example
#️⃣ Execute command in terminal
Request
GET
/v3/tatum/usage
Type signature
(new \Tatum\Sdk())->{mainnet/testnet}()->api()->serviceUtils()->getCredits(): \Tatum\Model\Consumption[]
Parameters
This endpoint does not need any parameter.
Return type
Description
Get information about your credit consumption for the last month
1 credit per API call
Get information about your credit consumption for the last month (used credits per day).
getVersion()
Example
#️⃣ Execute command in terminal
Request
GET
/v3/tatum/version
Type signature
(new \Tatum\Sdk())->{mainnet/testnet}()->api()->serviceUtils()->getVersion(): \Tatum\Model\GetVersion200Response
Parameters
This endpoint does not need any parameter.
Return type
\Tatum\Model\GetVersion200Response
Description
Get API version
1 credit per API call.
Get current version of the API.
unfreezeApiKey()
Example
#️⃣ Execute command in terminal
Request
DELETE
/v3/tatum/freeze
Type signature
(new \Tatum\Sdk())->{mainnet/testnet}()->api()->serviceUtils()->unfreezeApiKey()
Parameters
This endpoint does not need any parameter.
Return type
void (empty response body)
Description
Unfreeze API Key
2 credits per API call.
Unfreeze the API Key. It’s possible to perform sensitive operations like send ledger transaction, send off-chain transaction, send blockchain transaction, broadcast blockchain transaction, perform Order book trade or create blockage again.