Manage trader currencies to define what items can be used as money. Configure item values for your server's trading economy.
Authentication required: All endpoints require a valid Bearer token. See Authentication for details.
Retrieve a paginated list of trader currencies for a specific instance.
GET /api/instance/{instance_sid}/trader-currency
instance_sid
The SID of the instance (URL parameter)
like
string
Filter currencies by classname using partial match.
{
"current_page": 1,
"data": [
{
"id": 1,
"sid": "cur123",
"classname_id": 456,
"value": 100,
"instance_id": 5,
"classname": {
"id": 456,
"name": "MoneyRuble100"
}
}
],
"per_page": 30,
"total": 5
}Retrieve details of a specific trader currency, including its associated classname.
GET /api/instance/{instance_sid}/trader-currency/{currency_sid}
instance_sid
required
The SID of the instance
currency_sid
required
The SID of the trader currency
{
"id": 1,
"sid": "cur123",
"classname_id": 456,
"value": 100,
"instance_id": 5,
"classname": {
"id": 456,
"name": "MoneyRuble100",
"category_id": 10,
"subcategory_id": 25
}
}Create a new trader currency for an instance.
POST /api/instance/{instance_sid}/trader-currency
classname_id
ID of the classname to use as currency
value
Monetary value of this currency item (min: 0)
{
"classname_id": 456,
"value": 100
}PATCH /api/instance/{instance_sid}/trader-currency/{currency_sid}
Update an existing currency's classname or value.
DELETE /api/instance/{instance_sid}/trader-currency/{currency_sid}
Permanently delete a currency from the instance.
Currencies define what items players can use to buy and sell at traders. Common setups include using ruble notes (MoneyRuble100, MoneyRuble1000) or custom currency items. Set different value amounts for different denominations. For example, MoneyRuble100 = 100, MoneyRuble1000 = 1000.