TraderItem API Endpoints

The TraderItem API allows you to manage trader items for your DayZ server instances. Trader items define what items can be bought and sold at trader locations in the game, along with their prices.

Note: All API requests require authentication. See the Authentication page for details.

List Trader Items

Retrieve a paginated list of trader items for a specific instance.

Request

GET /api/instance/{instance_sid}/trader-item

URL Parameters

Parameter	Type	Description
instance_sid	string	The SID of the instance

Query Parameters

Parameter	Type	Description
`page`	integer	Page number for pagination (default: 1)
`amount`	integer	Number of items per page (default: 30)
`like`	string	Filter items by classname (partial match)

Response

{
  "current_page": 1,
  "data": [
    {
      "id": 1,
      "sid": "abc123",
      "instance_id": 1,
      "seller_id": 1,
      "category_id": 1,
      "classname_id": 1,
      "quantity": "1",
      "buy": 100,
      "sell": 50,
      "created_at": "2023-05-01T12:00:00.000000Z",
      "updated_at": "2023-05-01T12:00:00.000000Z",
      "classname": {
        "id": 1,
        "name": "AKM"
      },
      "category": {
        "id": 1,
        "name": "Weapons"
      },
      "seller": {
        "id": 1,
        "name": "Weapons Trader"
      }
    },
    {
      "id": 2,
      "sid": "def456",
      "instance_id": 1,
      "seller_id": 1,
      "category_id": 1,
      "classname_id": 2,
      "quantity": "1",
      "buy": 120,
      "sell": 60,
      "created_at": "2023-05-01T12:30:00.000000Z",
      "updated_at": "2023-05-01T12:30:00.000000Z",
      "classname": {
        "id": 2,
        "name": "M4A1"
      },
      "category": {
        "id": 1,
        "name": "Weapons"
      },
      "seller": {
        "id": 1,
        "name": "Weapons Trader"
      }
    }
  ],
  "first_page_url": "http://example.com/api/instance/xyz789/trader-item?page=1",
  "from": 1,
  "last_page": 10,
  "last_page_url": "http://example.com/api/instance/xyz789/trader-item?page=10",
  "links": [
    {
      "url": null,
      "label": "« Previous",
      "active": false
    },
    {
      "url": "http://example.com/api/instance/xyz789/trader-item?page=1",
      "label": "1",
      "active": true
    },
    {
      "url": "http://example.com/api/instance/xyz789/trader-item?page=2",
      "label": "2",
      "active": false
    },
    {
      "url": "http://example.com/api/instance/xyz789/trader-item?page=2",
      "label": "Next »",
      "active": false
    }
  ],
  "next_page_url": "http://example.com/api/instance/xyz789/trader-item?page=2",
  "path": "http://example.com/api/instance/xyz789/trader-item",
  "per_page": 30,
  "prev_page_url": null,
  "to": 30,
  "total": 300
}

Get Trader Item

Retrieve details of a specific trader item.

Request

GET /api/instance/{instance_sid}/trader-item/{trader_item_sid}

URL Parameters

Parameter	Type	Description
`instance_sid`	string	The SID of the instance
`trader_item_sid`	string	The SID of the trader item

Response

{
  "id": 1,
  "sid": "abc123",
  "instance_id": 1,
  "seller_id": 1,
  "category_id": 1,
  "classname_id": 1,
  "quantity": "1",
  "buy": 100,
  "sell": 50,
  "created_at": "2023-05-01T12:00:00.000000Z",
  "updated_at": "2023-05-01T12:00:00.000000Z",
  "classname": {
    "id": 1,
    "name": "AKM"
  },
  "category": {
    "id": 1,
    "name": "Weapons"
  },
  "seller": {
    "id": 1,
    "name": "Weapons Trader"
  }
}

Create Trader Item

Create a new trader item for an instance.

Request

POST /api/instance/{instance_sid}/trader-item

URL Parameters

Parameter	Type	Description
`instance_sid`	string	The SID of the instance

Request Body

Parameter	Type	Required	Description
`seller_id`	integer	Required	ID of the trader seller
`category_id`	integer	Required	ID of the trader category
`classname_id`	integer	Required	ID of the classname
`quantity`	string	Required	Quantity of the item
`buy`	integer	Required	Buy price of the item
`sell`	integer	Required	Sell price of the item

Response

{
  "id": 3,
  "sid": "ghi789",
  "instance_id": 1,
  "seller_id": 1,
  "category_id": 1,
  "classname_id": 3,
  "quantity": "1",
  "buy": 150,
  "sell": 75,
  "created_at": "2023-05-01T13:00:00.000000Z",
  "updated_at": "2023-05-01T13:00:00.000000Z"
}

Update Trader Item

Update an existing trader item.

Request

PATCH /api/instance/{instance_sid}/trader-item/{trader_item_sid}

URL Parameters

Parameter	Type	Description
`instance_sid`	string	The SID of the instance
`trader_item_sid`	string	The SID of the trader item

Request Body

Parameter	Type	Required	Description
`seller_id`	integer	Optional	ID of the trader seller
`category_id`	integer	Optional	ID of the trader category
`classname_id`	integer	Optional	ID of the classname
`quantity`	string	Optional	Quantity of the item
`buy`	integer	Optional	Buy price of the item
`sell`	integer	Optional	Sell price of the item

Response

{
  "id": 1,
  "sid": "abc123",
  "instance_id": 1,
  "seller_id": 1,
  "category_id": 1,
  "classname_id": 1,
  "quantity": "2",
  "buy": 90,
  "sell": 45,
  "created_at": "2023-05-01T12:00:00.000000Z",
  "updated_at": "2023-05-01T13:30:00.000000Z"
}

Delete Trader Item

Delete a trader item.

Request

DELETE /api/instance/{instance_sid}/trader-item/{trader_item_sid}

URL Parameters

Parameter	Type	Description
`instance_sid`	string	The SID of the instance
`trader_item_sid`	string	The SID of the trader item

Response

{
  "result": true
}

Previous: File Uploads API Back to API Documentation

Wiki Navigation

TraderItem API Endpoints

List Trader Items

Request

URL Parameters

Query Parameters

Response

Get Trader Item

Request

URL Parameters

Response

Create Trader Item

Request

URL Parameters

Request Body

Response

Update Trader Item

Request

URL Parameters

Request Body

Response

Delete Trader Item

Request

URL Parameters

Response