Get Organization Gas Tank Details
Overview
This API endpoint allows you to retrieve the details of an organization's gas tank, including balance and token information.
- HTTP Method: GET
- Endpoint:
{{BASE_URL}}/api/v1/client/gasTank
Request Headers
X-CLIENT-ID
: (required): Client ID which was generated when registering in Xellar Account Abstraction API Service Dashboard.X-SIGNATURE
: (required): Calculated signature, please refer to Authorization section.X-TIMESTAMP
: (required): Request timestamp in RFC3339 format.
Example Request Syntax
curl -X GET -H "Content-Type: application/json" \
-H "x-client-id: $YOUR_CLIENT_ID" \
-H "x-signature: $CALCULATED_SIGNATURE" \
-H "x-timestamp: $TIMESTAMP" \
"{{BASE_URL}}/api/v1/client/gasTank"
Response
The response will include a JSON object with the following properties:
status
(number): The HTTP status code of the response (e.g., 200 for success).message
(string): A message indicating the result of the request.data
(array): An array of objects, each representing a gas tank with the following properties:id
(string): The unique identifier of the gas tank.createdAt
(string): The timestamp when the gas tank was created.updatedAt
(string|null): The timestamp when the gas tank was last updated, if applicable.clientId
(string): The client ID associated with the gas tank.balance
(string): The current balance of the gas tank.type
(string): The type of the gas tank (e.g., "token").tokenName
(string): The name of the token used in the gas tank.decimals
(number): The number of decimals used by the token.
Example Response
{
"status": 200,
"message": "success",
"data": [
{
"id": "67a4711c28acbaf72c2cf541",
"createdAt": "2025-02-06T08:21:48.363Z",
"updatedAt": null,
"clientId": "19eb9738-dc52-493a-a602-b4d08f946bba",
"balance": "0",
"type": "token",
"tokenName": "USDT",
"decimals": 18
}
]
}