API
List marketplaces
GET /websites — List marketplaces
Operation
GET /websites
Behavior
Returns the catalogue of marketplaces the API covers, such as the Steam Community Market and third-party skin markets. Each entry's code is the identifier used by the other endpoints that take a marketplace.
- Results are ordered by
code. - Marketplaces that are no longer supported are hidden unless
include_deprecated=true; they then appear withis_deprecated: true.
[!note] The catalogue is maintained by the platform and is read-only through the API.
Usage
{
"authentication": "public",
"credit_cost": 0,
"premium": false,
"recommended_interval_seconds": 300,
"rate_limit": null,
"unit_pricing": null
}Request
{
"parameters": [
{
"name": "include_deprecated",
"in": "query",
"required": false,
"schema": {
"type": "boolean",
"description": "Also return marketplaces that are no longer supported (`is_deprecated: true`).",
"default": false,
"title": "Include Deprecated"
},
"description": "Also return marketplaces that are no longer supported (`is_deprecated: true`)."
}
]
}Responses
{
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Envelope_list_WebsiteOut__"
}
}
}
},
"422": {
"description": "A parameter or the request body is invalid",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorEnvelope"
}
}
}
},
"503": {
"description": "The service is temporarily unavailable; retry later",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorEnvelope"
}
}
}
}
}Models
{
"CreditMeta": {
"properties": {
"cost": {
"type": "integer",
"title": "Cost",
"description": "Credits this request costs."
},
"remaining": {
"type": "integer",
"title": "Remaining",
"description": "Estimated credit balance left after this request. A hint rather than a ledger: concurrent requests can make it slightly off."
}
},
"type": "object",
"required": [
"cost",
"remaining"
],
"title": "CreditMeta",
"description": "Credit accounting for a billable request."
},
"Envelope_list_WebsiteOut__": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/WebsiteOut"
},
"type": "array",
"title": "Data",
"description": "The endpoint payload."
},
"meta": {
"$ref": "#/components/schemas/Meta",
"description": "Request metadata."
}
},
"type": "object",
"required": [
"data",
"meta"
],
"title": "Envelope[list[WebsiteOut]]"
},
"ErrorBody": {
"properties": {
"code": {
"type": "string",
"title": "Code",
"description": "Stable machine-readable error code. Branch on this value, not on `message`."
},
"message": {
"type": "string",
"title": "Message",
"description": "Human-readable explanation. The wording may change."
},
"details": {
"anyOf": [
{
"additionalProperties": true,
"type": "object"
},
{
"type": "null"
}
],
"title": "Details",
"description": "Optional structured context, such as the list of validation errors or, for `credit_insufficient`, the required and remaining credits."
}
},
"type": "object",
"required": [
"code",
"message"
],
"title": "ErrorBody",
"description": "Details of a failed request."
},
"ErrorEnvelope": {
"properties": {
"error": {
"$ref": "#/components/schemas/ErrorBody",
"description": "What went wrong."
},
"meta": {
"$ref": "#/components/schemas/Meta",
"description": "Request metadata."
}
},
"type": "object",
"required": [
"error",
"meta"
],
"title": "ErrorEnvelope",
"description": "Error response: the error in `error` plus request metadata in `meta`."
},
"Meta": {
"properties": {
"request_id": {
"type": "string",
"title": "Request Id",
"description": "Unique identifier of this request, identical to the `X-Request-ID` response header. Quote it when contacting support."
},
"billable": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "Billable",
"description": "Whether the request is billed in credits. Present only on metered endpoints; `false` means the request is free, for example because it costs nothing or your subscription covers it."
},
"credit": {
"anyOf": [
{
"$ref": "#/components/schemas/CreditMeta"
},
{
"type": "null"
}
],
"description": "Cost of the request and your estimated remaining balance. Present only when `billable` is `true`."
}
},
"type": "object",
"required": [
"request_id"
],
"title": "Meta",
"description": "Request metadata included in every enveloped response."
},
"WebsiteOut": {
"properties": {
"code": {
"type": "string",
"title": "Code",
"description": "Unique marketplace code used across the API, e.g. `steam`."
},
"name": {
"type": "string",
"title": "Name",
"description": "Display name."
},
"url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Url",
"description": "Marketplace homepage, if known."
},
"category": {
"type": "string",
"title": "Category",
"description": "Marketplace category, e.g. `market`."
},
"subCategory": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Subcategory",
"description": "Finer category, if any."
},
"is_deprecated": {
"type": "boolean",
"title": "Is Deprecated",
"description": "Whether the marketplace is no longer supported."
}
},
"additionalProperties": false,
"type": "object",
"required": [
"code",
"name",
"url",
"category",
"subCategory",
"is_deprecated"
],
"title": "WebsiteOut",
"description": "A marketplace in the platform catalog."
}
}