Shopee Item Display Snapshot API (V1)
Retrieve a display snapshot for a Shopee item in the selected marketplace site. Supply a marketplace site and a shop ID. Sample fields include prices and currency codes. Use it for catalog research or marketplace monitoring. The GET request schema also lists shopId, itemId.
- Selected price
- $0.030769 / callPublished pricing
- Sellers / implementations
- 1 / 1
- Requests · 30d
- —Loading...
- Success rate · 30d
- —Loading...
| Seller | Pricing | Requests · 30d | Performance | Access |
|---|---|---|---|---|
justoneapiCurrent Shopee Item Display Snapshot API (V1) · GET | $0.030769 / call | — | —successP50— |
Run sends a real API request. Charges follow the published API contract.
Response structure
codeintegerdataobjectcompletebooleanmarketstringpriceobjectcurrencystringfallback_usedbooleanmaxintegerminintegerobservation_countintegerraw_valuesinteger[]scaleintegersourcestringvaluesinteger[]
productobjectimage_idstringimage_urlstringitem_idintegernamestringshop_idintegervariation_optionsobject[]namestringoptionsobject[]imagestringnamestring
variation_review_countsobject[]countintegernamestring
review_filtersobjectinsight_filtersunknown[]size_filter_countintegertag_filtersunknown[]
sitestringwarningsunknown[]
messagenullrecordTimestring
// Inferred from response examples. Fields are optional and other fields may be returned.
export type ApiResponse = {
code?: number;
data?: {
complete?: boolean;
market?: string;
price?: {
currency?: string;
fallback_used?: boolean;
max?: number;
min?: number;
observation_count?: number;
raw_values?: Array<number>;
scale?: number;
source?: string;
values?: Array<number>;
};
product?: {
image_id?: string;
image_url?: string;
item_id?: number;
name?: string;
shop_id?: number;
variation_options?: Array<{
name?: string;
options?: Array<{
image?: string;
name?: string;
}>;
}>;
variation_review_counts?: Array<{
count?: number;
name?: string;
}>;
};
review_filters?: {
insight_filters?: Array<unknown>;
size_filter_count?: number;
tag_filters?: Array<unknown>;
};
site?: string;
warnings?: Array<unknown>;
};
message?: null;
recordTime?: string;
};- Method
- GET
- Endpoint
https://api.openany.si/v1/agent-apis/justoneapi/api/shopee/get-item-snapshot/v1- Content type
- application/json
- Authentication
Authorization: Bearer $OPENANY_API_KEY
Correct the request fields in Playground to generate a code example.
Input parameters
Fields in this listing; additional options and input encoding can vary by provider.
| Parameter | Location | Type | Required | Description |
|---|---|---|---|---|
site | URL query parametersquery | string | Yes | Shopee marketplace site.
Available Values:
- `TW`: Taiwan
- `ID`: Indonesia
- `TH`: Thailand enum: "TW", "ID", "TH" |
shopId | URL query parametersquery | integer | Yes | Shopee shop ID. |
itemId | URL query parametersquery | integer | Yes | Shopee item ID. |
Required markers inside a nested object or variant apply when that object or variant is used.
Sample response
Sample response · Documented HTTP 200 Example from the provider's documentation. Field values in your results will differ.
{
"code": 0,
"data": {
"complete": true,
"market": "Taiwan",
"price": {
"currency": "TWD",
"fallback_used": false,
"max": 1880,
"min": 1880,
"observation_count": 48,
"raw_values": [
188000000
],
"scale": 100000,
"source": "installment_plan",
"values": [
1880
]
},
"product": {
"image_id": "tw-11134207-7r98w-lvpoigvt1z2q48",
"image_url": "https://down-tw.img.susercontent.com/file/tw-11134207-7r98w-lvpoigvt1z2q48",
"item_id": 24428454365,
"name": "MHW-3BOMBER 轟炸機 馭系列旋風攪粉針 58mm 咖啡布粉針旋轉均勻打散結塊 散粉針 按壓式攪粉針 針式布粉器",
"shop_id": 526184774,
"variation_options": [
{
"name": "規格",
"options": [
{
"image": "tw-11134207-7r990-luw6zdym86vf57",
"name": "馭系列-旋風攪粉針-58MM通用"
},
{
"image": "tw-11134207-7rasl-m5wmvl4kyw9984",
"name": "馭系列-旋風攪粉針-53MM通用"
},
{
"image": "tw-11134207-7rasj-m4sguw1h5x3h52",
"name": "馭系列-旋風攪粉針-51MM通用"
},
{
"image": "tw-11134207-7rbk6-mamcni1h9lh589",
"name": "馭系列三件組-58mm通用"
},
{
"image": "tw-11134207-7rbka-mamcnktd7f95f6",
"name": "馭系列五件組-58mm通用"
},
{
"image": "tw-11134207-7ra0l-md2p6mkdh3l647",
"name": "馭系列三件與有槽壓粉墊組合-58mm通用"
},
{
"image": "tw-11134207-7ra0r-md2p6qyt194a6a",
"name": "馭系列四件與有槽壓粉墊組合-58mm通用"
}
]
}
],
"variation_review_counts": [
{
"count": 416,
"name": "0"
},
{
"count": 19,
"name": "1"
},
{
"count": 15,
"name": "2"
},
{
"count": 4,
"name": "3"
},
{
"count": 3,
"name": "4"
},
{
"count": 2,
"name": "5"
},
{
"count": 10,
"name": "6"
}
]
},
"review_filters": {
"insight_filters": [],
"size_filter_count": 0,
"tag_filters": []
},
"site": "TW",
"warnings": []
},
"message": null,
"recordTime": "2026-08-12T13:57:48.846348327"
}Agent integration
Copy the resource contract without sharing an API key.
View API Markdown
# Shopee Item Display Snapshot API (V1)
Retrieve a display snapshot for a Shopee item in the selected marketplace site. Supply a marketplace site and a shop ID. Sample fields include prices and currency codes. Use it for catalog research or marketplace monitoring. The GET request schema also lists shopId, itemId.
## Available implementations
justoneapi · Shopee Item Display Snapshot API (V1): https://openany.si/markets/apis/capabilities/shopee-item-display-snapshot-api-v1?offering=54bb7348-0be8-4ab5-9655-f88d0105395b · $0.030769 / call
## Selected API contract
Documentation: https://openany.si/markets/apis/capabilities/shopee-item-display-snapshot-api-v1
Method: GET
Endpoint: https://api.openany.si/v1/agent-apis/justoneapi/api/shopee/get-item-snapshot/v1
Price: $0.030769 / call
Provider: justoneapi
Contract revision: 3
Price source: OpenAny public API contract and documented provider unit rates. Price update time: not supplied.
Use OPENANY_API_KEY from the environment. API Key calls use your shared balance.
The request template contains errors. Correct it in Playground to generate a command.
## API contract
```json
{
"resource_type": "api",
"name": "Shopee Item Display Snapshot API (V1)",
"endpoint": "https://api.openany.si/v1/agent-apis/justoneapi/api/shopee/get-item-snapshot/v1",
"method": "GET",
"content_type": "none",
"execution_mode": "sync",
"authentication": {
"type": "bearer",
"environment_variable": "OPENANY_API_KEY"
},
"inputs": [
{
"description": "Shopee marketplace site.\n\nAvailable Values:\n- `TW`: Taiwan\n- `ID`: Indonesia\n- `TH`: Thailand",
"enum_values": [
"TW",
"ID",
"TH"
],
"location": "query",
"name": "site",
"nullable": false,
"required": true,
"type": "string"
},
{
"description": "Shopee shop ID.",
"location": "query",
"name": "shopId",
"nullable": false,
"required": true,
"type": "integer"
},
{
"description": "Shopee item ID.",
"location": "query",
"name": "itemId",
"nullable": false,
"required": true,
"type": "integer"
}
],
"billing": {
"currency": "USD",
"mode": "fixed",
"priceMicroUsd": "30769",
"rounding": null,
"unit": "call",
"unitQuantity": null
},
"examples": [
{
"http_status": 200,
"name": "Official example · Historical response; independent request temp",
"request": {
"body": null,
"headers": {},
"path": {},
"query": {
"itemId": "<REPLACE_ITEMID>",
"shopId": "<REPLACE_SHOPID>",
"site": "TW"
}
},
"response_body": {
"code": 0,
"data": {
"complete": true,
"market": "Taiwan",
"price": {
"currency": "TWD",
"fallback_used": false,
"max": 1880,
"min": 1880,
"observation_count": 48,
"raw_values": [
188000000
],
"scale": 100000,
"source": "installment_plan",
"values": [
1880
]
},
"product": {
"image_id": "tw-11134207-7r98w-lvpoigvt1z2q48",
"image_url": "https://down-tw.img.susercontent.com/file/tw-11134207-7r98w-lvpoigvt1z2q48",
"item_id": 24428454365,
"name": "MHW-3BOMBER 轟炸機 馭系列旋風攪粉針 58mm 咖啡布粉針旋轉均勻打散結塊 散粉針 按壓式攪粉針 針式布粉器",
"shop_id": 526184774,
"variation_options": [
{
"name": "規格",
"options": [
{
"image": "tw-11134207-7r990-luw6zdym86vf57",
"name": "馭系列-旋風攪粉針-58MM通用"
},
{
"image": "tw-11134207-7rasl-m5wmvl4kyw9984",
"name": "馭系列-旋風攪粉針-53MM通用"
},
{
"image": "tw-11134207-7rasj-m4sguw1h5x3h52",
"name": "馭系列-旋風攪粉針-51MM通用"
},
{
"image": "tw-11134207-7rbk6-mamcni1h9lh589",
"name": "馭系列三件組-58mm通用"
},
{
"image": "tw-11134207-7rbka-mamcnktd7f95f6",
"name": "馭系列五件組-58mm通用"
},
{
"image": "tw-11134207-7ra0l-md2p6mkdh3l647",
"name": "馭系列三件與有槽壓粉墊組合-58mm通用"
},
{
"image": "tw-11134207-7ra0r-md2p6qyt194a6a",
"name": "馭系列四件與有槽壓粉墊組合-58mm通用"
}
]
}
],
"variation_review_counts": [
{
"count": 416,
"name": "0"
},
{
"count": 19,
"name": "1"
},
{
"count": 15,
"name": "2"
},
{
"count": 4,
"name": "3"
},
{
"count": 3,
"name": "4"
},
{
"count": 2,
"name": "5"
},
{
"count": 10,
"name": "6"
}
]
},
"review_filters": {
"insight_filters": [],
"size_filter_count": 0,
"tag_filters": []
},
"site": "TW",
"warnings": []
},
"message": null,
"recordTime": "2026-08-12T13:57:48.846348327"
}
}
]
}
```Error handling
| Status | Next step |
|---|---|
400 | Check the offering and request fields. |
401 / 403 | Verify your credentials and access permissions. |
402 | Inspect the selected access mode and returned payment requirements. |
429 | Respect the returned rate limit and retry guidance. |
5xx | Inspect the error and usage record before retrying a paid operation. |
Official example · Historical response; independent request temp
Example from the provider's documentation. Field values in your results will differ.
Prepare your environment
Use a terminal with cURL installed.
Use an OpenAny API key with shared-balance access. Confirm availability and price before running; a call may charge your balance.
Set the key in your terminal using the hidden prompt below. Keep its value out of source files and logs.
Terminal · macOS / Linuxprintf 'OpenAny API key: ' read -r -s OPENANY_API_KEY export OPENANY_API_KEY printf '\n'Run the request
Paste the complete command below into your terminal.
Values to replace before running 3
Review these request fields before running. Keep the published provider and request method unchanged.
site- Shopee marketplace site. Available Values: - `TW`: Taiwan - `ID`: Indonesia - `TH`: Thailand
shopId- Shopee shop ID.
itemId- Shopee item ID.
Terminal · cURLcurl \ 'https://api.openany.si/v1/agent-apis/justoneapi/api/shopee/get-item-snapshot/v1?itemId=%3CREPLACE_ITEMID%3E&shopId=%3CREPLACE_SHOPID%3E&site=TW' \ -X GET \ -H "Authorization: Bearer $OPENANY_API_KEY" \ -H 'Content-Type: application/json'Check the response
Sample response · Documented HTTP 200
Sample response{ "code": 0, "data": { "complete": true, "market": "Taiwan", "price": { "currency": "TWD", "fallback_used": false, "max": 1880, "min": 1880, "observation_count": 48, "raw_values": [ 188000000 ], "scale": 100000, "source": "installment_plan", "values": [ 1880 ] }, "product": { "image_id": "tw-11134207-7r98w-lvpoigvt1z2q48", "image_url": "https://down-tw.img.susercontent.com/file/tw-11134207-7r98w-lvpoigvt1z2q48", "item_id": 24428454365, "name": "MHW-3BOMBER 轟炸機 馭系列旋風攪粉針 58mm 咖啡布粉針旋轉均勻打散結塊 散粉針 按壓式攪粉針 針式布粉器", "shop_id": 526184774, "variation_options": [ { "name": "規格", "options": [ { "image": "tw-11134207-7r990-luw6zdym86vf57", "name": "馭系列-旋風攪粉針-58MM通用" }, { "image": "tw-11134207-7rasl-m5wmvl4kyw9984", "name": "馭系列-旋風攪粉針-53MM通用" }, { "image": "tw-11134207-7rasj-m4sguw1h5x3h52", "name": "馭系列-旋風攪粉針-51MM通用" }, { "image": "tw-11134207-7rbk6-mamcni1h9lh589", "name": "馭系列三件組-58mm通用" }, { "image": "tw-11134207-7rbka-mamcnktd7f95f6", "name": "馭系列五件組-58mm通用" }, { "image": "tw-11134207-7ra0l-md2p6mkdh3l647", "name": "馭系列三件與有槽壓粉墊組合-58mm通用" }, { "image": "tw-11134207-7ra0r-md2p6qyt194a6a", "name": "馭系列四件與有槽壓粉墊組合-58mm通用" } ] } ], "variation_review_counts": [ { "count": 416, "name": "0" }, { "count": 19, "name": "1" }, { "count": 15, "name": "2" }, { "count": 4, "name": "3" }, { "count": 3, "name": "4" }, { "count": 2, "name": "5" }, { "count": 10, "name": "6" } ] }, "review_filters": { "insight_filters": [], "size_filter_count": 0, "tag_filters": [] }, "site": "TW", "warnings": [] }, "message": null, "recordTime": "2026-08-12T13:57:48.846348327" }
Common questions
Do I need a separate key for every provider?
Use your OpenAny API key for standard API access. Read it from OPENANY_API_KEY in your environment and keep it out of prompts, source code and logs.
Are these providers interchangeable?
No. Each offering has its own inputs, pricing and response contract. Selecting a catalog offering does not establish automatic routing or fallback. Confirm the service contract before calling.
How is this API billed?
API-key calls use your shared balance at the selected implementation's published rate. Check the billing unit and request-specific pricing rules before making a paid call. Recorded usage determines the final charge under that contract.
Where do the price and contract come from?
The selected implementation publishes its provider, request contract, revision and billing rules through OpenAny's public API catalog. A revision number identifies a contract version, not a price update date. A price update timestamp is not supplied; do not treat a page date as one.
How do OpenAny Balance and x402 differ?
OpenAny Balance uses an API key and one shared balance. Card, USDC and x402 top-ups, card auto top-up and USDC subscriptions fund that balance; available routes appear on the Credits page. Direct x402 is a separate pay-per-request flow, available only on listings that show it and requiring an authorized payment client.
Does Playground send a paid request?
Yes. After you sign in, Run sends a real API request using an active OpenAny API key. Charges follow the published API contract and use your shared balance. Selecting an implementation, editing inputs and viewing sample responses do not send requests.
Use Shopee Item Display Snapshot API (V1) with your agent
Inspect endpoint contracts and confirm availability and pricing before a paid call.