GEThttps://seller-api.playerauctions.com/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"
}
]
}
}Error Response
{
"code": 10002,
"message": "Invalid parameter.",
"requestId": "550e8400-e29b-41d4-a716-446655440000"
}iii. 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. |
| └─ hideOfferWarning | string | Empty string for active offers; otherwise, contains a warning message explaining why the offers are hidden. |
| └─ count | int | Total number of items. |
| └─ items | object[] | Contains the list of offers. |
| └─ └─ offerId | int | Offer ID for the offer. |
| └─ └─ systemStatus | string | Internal status of the offer. |
| └─ └─ offerStatus | string | Status of the offer. (e.g., "active", "hidden", "closed"). |
| └─ └─ title | string | Title of the offer. |
| └─ └─ gameName | string | Game name of the offer. |
| └─ └─ deliveryGuarantee | string | Delivery guarantee of the offer. |
| └─ └─ totalPrice | string | Total price of the offer. |
| └─ └─ expiredTimeString | string | Expiration time string of the offer. |
| └─ └─ productType | string | Product type of the offer. (e.g., "currency", "items", "accounts", "Boosting", "topup"). |
| └─ └─ currencyPerUnit | double | Currency per unit of the offer. Applicable to Currency offers only. |
| └─ └─ everyGold | string | Currency amount per 1 USD. Applicable to Currency offers only. |
| └─ └─ suffix | string | Currency suffix for volume scale (e.g., K, M). Applicable to Currency offers only. |
| └─ └─ name | string | Currency name. Applicable to Currency offers only. |
| └─ └─ itemNameEn | string | Custom item name. Applicable to Item offers only. |
| └─ └─ url | string | URL of the offer. |
| └─ └─ topUpFixQuantity | int | Fixed top-up quantity. Applicable to Top-up offers only. |
| └─ └─ topUpExtraQuantity | int | Extra top-up quantity. Applicable to Top-up offers only. |
| └─ └─ topUpCategoryName | string | Top-up category name. Applicable to Top Up offers only. |