Tatum
Powered by Redocly

Service utils

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).

SecurityX-API-Key
Responses
200

OK

401

Unauthorized. Not valid or inactive subscription key present in the HTTP Header.

403

Forbidden. The request is authenticated, but it is not possible to required perform operation due to logical error or invalid permissions.

500

Internal server error. There was an error on the server while processing the request.

get/v3/tatum/usage
Request samples 
Response samples 
application/json
[
  • {
    }
]
Get API version
1 credit per API call.

Get current version of the API.
SecurityX-API-Key 
Responses 
200
OK


401
Unauthorized. Not valid or inactive subscription key present in the HTTP Header.


500
Internal server error. There was an error on the server while processing the request.


get/v3/tatum/version
Request samples 
Response samples 
application/json
{
  • "version": "3.0.2",
  • "status": "ACTIVE",
  • "testnet": true,
  • "planName": "Free",
  • "planCode": "FREE",
  • "price": 9,
  • "expiration": 4113115784397,
  • "creditLimit": 1000000000,
  • "usage": 25656634,
  • "rolloverDay": 4
}
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.


SecurityX-API-Key 
Responses 
204
OK


401
Unauthorized. Not valid or inactive subscription key present in the HTTP Header.


500
Internal server error. There was an error on the server while processing the request.


put/v3/tatum/freeze
Request samples 
Response samples 
application/json
{
  • "errorCode": "subscription.not.active",
  • "message": "Subscription not active anymore.",
  • "statusCode": 401
}
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.


SecurityX-API-Key 
Responses 
204
OK


401
Unauthorized. Not valid or inactive subscription key present in the HTTP Header.


500
Internal server error. There was an error on the server while processing the request.


delete/v3/tatum/freeze
Request samples 
Response samples 
application/json
{
  • "errorCode": "subscription.not.active",
  • "message": "Subscription not active anymore.",
  • "statusCode": 401
}