Skip to main content

Get Token History by ID

Retrieves the history of changes for a specific token with pagination and filtering options.

Request

GET /v2/admin/tokens/{tokenID}/history

Parameters

NameTypeInDescription
tokenIDstringpathRequired. The ID of the token

Query Parameters

NameTypeRequiredDescription
pageintegerNoPage number (default: 1)
per_pageintegerNoItems per page (default: 20)
start_datestringNoStart date filter in ISO 8601 format (e.g., 2025-01-01T00:00:00Z)
end_datestringNoEnd date filter in ISO 8601 format (e.g., 2025-12-31T23:59:59Z)
change_typestringNoFilter by change type: value_update or metric_update
change_reasonstringNoFilter by change reason: manual_update, market_adjustment, or system_update
changed_bystringNoFilter by the ID of the supervisor who made the change

Headers

NameDescription
AuthorizationRequired. Bearer token for authentication
Content-TypeRequired. Must be application/json

Example

curl --location 'http://localhost:3453/v2/admin/tokens/6901599cbd0fb7ece2803764/history?page=1&per_page=20&start_date=2025-01-01T00%3A00%3A00Z&end_date=2025-12-31T23%3A59%3A59Z' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJjbGllbnRJRCI6IjhmMzEwOWExLTYyMmMtNDVhZC1hYjI4LTg0ODE5N2ZiMDYwYSIsImV4cGlyYXRpb24iOjE3NjMwNzg1MjQsInN1cGVydmlzb3JFbWFpbCI6InViZXJAYXBleC5jb20iLCJzdXBlcnZpc29ySUQiOiI2NjViMzcyZjNhNzJkN2QwNzkxNTk2YmEiLCJzdXBlcnZpc29yTm9kZUlEIjoiNjY1YWU1MzZhNjM5MmI3NWNmZDQwMzUyIiwic3VwZXJ2aXNvck5vZGVJbnRJRCI6MSwic3VwZXJ2aXNvck5vZGVQYXRoIjoiMSIsInN1cGVydmlzb3JSb2xlSUQiOiI2NjVhZTc5NjEwY2UyMTZkYmMzNWM5M2IiLCJzdXBlcnZpc29yUm9sZVByaW9yaXR5IjoxMDB9.5e1neSV0QQmYGIs42Z9qarTKY3pkSQWutDnl34xYg04'

Response

{
"data": [
{
"id": "69015cb6bd0fb7ece2803767",
"token_id": "6901599cbd0fb7ece2803764",
"node_id": "6901350deb7ed8c1c38de4e9",
"changed_by": "665b372f3a72d7d0791596ba",
"change_type": "metric_update",
"change_reason": "manual_update",
"metric_change": {
"term_duration_in_months": 10,
"min_purchase_quantity": 1,
"max_purchase_quantity": 10,
"min_tokens_required_for_rental_income": 1,
"rental_income": 12,
"rental_income_currency_token_id": "",
"rental_payment_period_in_days": 15
},
"created_at": "2025-10-29T00:15:50.99Z"
}
],
"total": 1,
"page": 1,
"per_page": 20
}

Response Fields

FieldTypeDescription
dataarrayList of token history records
data[].idstringUnique identifier for the history record
data[].token_idstringID of the token
data[].node_idstringID of the associated node
data[].changed_bystringID of the supervisor who made the change
data[].change_typestringType of change: value_update or metric_update
data[].change_reasonstringReason for the change: manual_update, market_adjustment, or system_update
data[].value_changeobject | nullValue change data (present when change_type is value_update)
data[].metric_changeobject | nullMetric change data (present when change_type is metric_update)
data[].created_atstringISO 8601 timestamp when the change was made
totalintegerTotal number of history records
pageintegerCurrent page number
per_pageintegerNumber of items per page

Value Change Data Fields

FieldTypeDescription
total_valueobjectTotal value information (price object)
token_priceobjectToken price information (price object)
salable_percentagenumberPercentage of tokens that are salable
listed_supplyintegerNumber of tokens listed

Metric Change Data Fields

FieldTypeDescription
term_duration_in_monthsinteger | nullDuration of the token term in months
min_purchase_quantityintegerMinimum purchase quantity
max_purchase_quantityintegerMaximum purchase quantity
min_tokens_required_for_rental_incomeintegerMinimum tokens required for rental income
rental_incomenumberRental income amount
rental_income_currency_token_idstringCurrency token ID for rental income
rental_payment_period_in_daysintegerRental payment period in days

Change Types

ValueDescription
value_updateUpdate to token value/price information
metric_updateUpdate to token metrics (rental income, purchase limits, etc.)

Change Reasons

ValueDescription
manual_updateManual update by a supervisor
market_adjustmentAutomatic adjustment based on market conditions
system_updateSystem-generated update

Status Codes

Status CodeDescription
200Success - Token history retrieved successfully
400Bad Request - Invalid request parameters
401Unauthorized - Invalid or missing authentication token
404Not Found - Token ID does not exist
500Internal Server Error