Offer List – PlayerAuctions Help Center

GET api/v1/offers

Query Offers.

i. Request Parameters

Query Parameters

Parameter	Type	Required	Description
keyword	string	No	Fuzzy search by Offer Title.
listingStatus	string	No	Listing status to filter offers (e.g., "active", "hidden", "closed"). default: "active".
productType	string	No	Product type to filter offers (e.g., "all", "currency", "items", "accounts", "powerleveling", "topup"). default: "all".
serverId	int?	No	Server ID to filter offers.
factionId	int?	No	Faction ID to filter offers. If serverId is provided, this parameter will be ignored.
gameId	int?	No	Game ID to filter offers.
pageIndex	int?	No	Page index for pagination.
pageSize	int?	No	Page size for pagination.

ii. Response Example

Success Response

{
  "code": 10000,
  "message": "Operation Successful.",
  "requestId": "550e8400-e29b-41d4-a716-446655440000",
  "data": {
    "hideOfferWarning": "",
    "count": 1,
    "items": [
      {
        "offerId": 71394124,
        "systemStatus": "Active",
        "offerStatus": "Active",
        "title": "Divine Orb Runes of Aldur Standard",
        "gameName": "Path of Exile 2",
        "deliveryGuarantee": "1 Hour",
        "totalPrice": "$ 5.00",
        "expiredTimeString": "Jul-08-2026 10:35:54 PM",
        "productType": "Currency",
        "currencyPerUnit": 100.0,
        "everyGold": "20",
        "suffix": "",
        "name": "Currency",
        "itemNameEn": "",
        "url": "https://www.playerauctions.com/path-of-exile-2-currency/71394124c!divine-orb-runes-of-aldur-standard/",
        "topUpFixQuantity": 0,
        "topUpExtraQuantity": 0,
        "topUpCategoryName": "V-Bucks"
      }
    ]
  }
}

Response Parameters

Parameter	Type	Description
code	int	Response code. 10000 indicates success, other values indicate an error.
message	string	Response message. Contains error details on failure.
requestId	string	Unique identifier for the request, used for tracking.
data	object	Contains the list of offers.
data.hideOfferWarning	string	Empty string for active offers; otherwise, contains a warning message explaining why the offers are hidden.
data.count	int	Total number of items.
data.items	object[]	Contains the list of offers.
data.items[].offerId	int	Offer ID for the offer.
data.items[].systemStatus	string	Internal status of the offer.
data.items[].offerStatus	string	Status of the offer. (e.g., "active", "hidden", "closed").
data.items[].title	string	Title of the offer.
data.items[].gameName	string	Game name of the offer.
data.items[].deliveryGuarantee	string	Delivery guarantee of the offer.
data.items[].totalPrice	string	Total price of the offer.
data.items[].expiredTimeString	string	Expiration time string of the offer.
data.items[].productType	string	Product type of the offer. (e.g., "currency", "items", "accounts", "Boosting", "topup").
data.items[].currencyPerUnit	double	Currency per unit of the offer. (Only applicable for currency offers.)
data.items[].everyGold	string	Currency amount per 1 USD of each offer. (Only applicable for currency offers.)
data.items[].suffix	string	Suffix of the currency offer's currency. (Only applicable for currency offers.)
data.items[].name	string	Currency name of the currency offer. (Only applicable for currency offers.)
data.items[].itemNameEn	string	Custom name of the item if the offer is an item offer.
data.items[].url	string	URL of the offer.
data.items[].topUpFixQuantity	int	Top-up fix quantity of the offer. (Only applicable for topup offers.)
data.items[].topUpExtraQuantity	int	Top-up extra quantity of the offer. (Only applicable for topup offers.)
data.items[].topUpCategoryName	string	Top-up category name of the offer. (Only applicable for topup offers.)

iii. Error Response Example

Error Response

{
  "code": 10002,
  "message": "Invalid parameter.",
  "requestId": "550e8400-e29b-41d4-a716-446655440000"
}

Common Error Codes

Parameter	Type	Description
code	int	Error code. Common values: 10002 (Invalid parameter), 50001 (Internal server error).
message	string	Detailed error message explaining what went wrong.
requestId	string	Unique identifier for the request, used for tracking.