Japan Yahoo! Shopping Product Search (Official API)
Pricing
from $2.00 / 1,000 record scrapeds
Search Yahoo! Shopping (Japan) products via the official item-search API v3: price, store, brand, JAN, points, review score, stock. You supply your own Yahoo application ID. Unofficial; not affiliated with LY Corporation / Yahoo! JAPAN.
You can access the Japan Yahoo! Shopping Product Search (Official API) programmatically from your own applications by using the Apify API. You can also choose the language preference from below. To use the Apify API, you’ll need an Apify account and your API token, found in API & Integrations in Apify Console.
{ "openapi": "3.0.1", "info": { "version": "0.1", "x-build-id": "eGzhbZXLh7bHatdue" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/jpopendata~japan-yahoo-shopping-api/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-jpopendata-japan-yahoo-shopping-api", "x-openai-isConsequential": false, "summary": "Executes an Actor, waits for its completion, and returns Actor's dataset items in response.", "tags": [ "Run Actor" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inputSchema" } } } }, "parameters": [ { "name": "token", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Enter your Apify token here" } ], "responses": { "200": { "description": "OK" } } } }, "/acts/jpopendata~japan-yahoo-shopping-api/runs": { "post": { "operationId": "runs-sync-jpopendata-japan-yahoo-shopping-api", "x-openai-isConsequential": false, "summary": "Executes an Actor and returns information about the initiated run in response.", "tags": [ "Run Actor" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inputSchema" } } } }, "parameters": [ { "name": "token", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Enter your Apify token here" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runsResponseSchema" } } } } } } }, "/acts/jpopendata~japan-yahoo-shopping-api/run-sync": { "post": { "operationId": "run-sync-jpopendata-japan-yahoo-shopping-api", "x-openai-isConsequential": false, "summary": "Executes an Actor, waits for completion, and returns the OUTPUT from Key-value store in response.", "tags": [ "Run Actor" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inputSchema" } } } }, "parameters": [ { "name": "token", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Enter your Apify token here" } ], "responses": { "200": { "description": "OK" } } } } }, "components": { "schemas": { "inputSchema": { "type": "object", "required": [ "appId" ], "properties": { "appId": { "title": "Your Yahoo application ID (required)", "type": "string", "description": "REQUIRED. YOUR OWN Yahoo! JAPAN application ID (Client ID) — a long alphanumeric string from the Yahoo Developer Network dashboard. This Actor does NOT bundle a shared key — every request runs under your application ID so it stays within your own Yahoo Developer Network agreement, and Yahoo's per-appID rate limit applies to you. Get one for free (Yahoo! JAPAN ID needed): https://e.developer.yahoo.co.jp/register → アプリケーションの管理 → 新しいアプリケーションを開発 (server-side app) → copy the Client ID." }, "query": { "title": "Search keyword", "type": "string", "description": "Free-text product keyword (e.g. \"緑茶\", \"Nintendo Switch\"). Japanese matches best. At least ONE of query / janCode / genreCategoryId / categoryId / brandId / sellerId is required." }, "janCode": { "title": "JAN / EAN code", "type": "string", "description": "Exact 8- or 13-digit JAN/EAN barcode to look up a specific product, e.g. \"4901085081464\" (dashes/spaces are tolerated)." }, "genreCategoryId": { "title": "Genre category ID", "type": "string", "description": "Yahoo genre category ID to restrict results (numeric, e.g. \"2498\"). Use the Yahoo category-search API to discover IDs." }, "categoryId": { "title": "Category ID", "type": "string", "description": "Yahoo product category ID to restrict results (numeric)." }, "brandId": { "title": "Brand ID", "type": "string", "description": "Yahoo brand ID to restrict results to one brand (numeric)." }, "sellerId": { "title": "Store (seller) ID", "type": "string", "description": "Restrict results to a single Yahoo! Shopping store by its store/seller ID (the store slug in the URL, e.g. \"yamada-denki\")." }, "priceFrom": { "title": "Minimum price (JPY)", "minimum": 0, "type": "integer", "description": "Lower price bound in yen (inclusive, whole number, e.g. 500)." }, "priceTo": { "title": "Maximum price (JPY)", "minimum": 0, "type": "integer", "description": "Upper price bound in yen (inclusive, whole number, e.g. 3000). Must be >= priceFrom." }, "sort": { "title": "Sort order", "enum": [ "-score", "+price", "-price", "+name", "-name", "-review_count", "+review_count", "-sold", "+sold", "-affiliate_bonus", "+affiliate_bonus" ], "type": "string", "description": "Result ordering. `-score` relevance (default), `+price`/`-price` price asc/desc, `+name`/`-name`, `-review_count` most reviewed, `-sold` best-selling. Aliases such as \"price_asc\", \"cheapest\", \"most_reviewed\" are accepted via the API." }, "condition": { "title": "Item condition", "enum": [ "new", "used" ], "type": "string", "description": "Restrict to \"new\" (新品) or \"used\" (中古) items. Leave empty for both." }, "inStock": { "title": "In stock only", "type": "boolean", "description": "If true, only return items currently in stock (\"true\"/\"false\" strings are tolerated).", "default": false }, "affiliateId": { "title": "ValueCommerce affiliate ID (optional)", "type": "string", "description": "Optional. Your ValueCommerce affiliate ID (sid). When set, each record includes an affiliateUrl. Leave empty for plain product data." }, "affiliateType": { "title": "Affiliate network", "enum": [ "vc", "rakuten" ], "type": "string", "description": "Affiliate network for affiliateId. Default ValueCommerce.", "default": "vc" }, "maxItems": { "title": "Max items", "minimum": 1, "maximum": 1000, "type": "integer", "description": "Maximum number of products to output (1-1000, default 100). The upstream paginates 50 hits per request up to roughly 1000 hits per query.", "default": 100 }, "maxApiRequests": { "title": "Max upstream requests per run", "minimum": 1, "maximum": 25, "type": "integer", "description": "Hard safety cap on API requests per run (1-25, default 5; each page = up to 50 items). Politeness (1 connection, >= 2.5 s spacing per Yahoo's 30 req/min limit, exponential backoff on 429/5xx) is enforced in code.", "default": 5 }, "proxyConfiguration": { "title": "Proxy configuration", "type": "object", "description": "Apify proxy settings. Default is NO proxy (direct connection) — an official JSON API rarely needs one. The Actor backs off exponentially on 429/5xx and fails visibly on a persistent block; it never attempts rate-limit evasion.", "default": { "useApifyProxy": false } } } }, "runsResponseSchema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string" }, "actId": { "type": "string" }, "userId": { "type": "string" }, "startedAt": { "type": "string", "format": "date-time", "example": "2025-01-08T00:00:00.000Z" }, "finishedAt": { "type": "string", "format": "date-time", "example": "2025-01-08T00:00:00.000Z" }, "status": { "type": "string", "example": "READY" }, "meta": { "type": "object", "properties": { "origin": { "type": "string", "example": "API" }, "userAgent": { "type": "string" } } }, "stats": { "type": "object", "properties": { "inputBodyLen": { "type": "integer", "example": 2000 }, "rebootCount": { "type": "integer", "example": 0 }, "restartCount": { "type": "integer", "example": 0 }, "resurrectCount": { "type": "integer", "example": 0 }, "computeUnits": { "type": "integer", "example": 0 } } }, "options": { "type": "object", "properties": { "build": { "type": "string", "example": "latest" }, "timeoutSecs": { "type": "integer", "example": 300 }, "memoryMbytes": { "type": "integer", "example": 1024 }, "diskMbytes": { "type": "integer", "example": 2048 } } }, "buildId": { "type": "string" }, "defaultKeyValueStoreId": { "type": "string" }, "defaultDatasetId": { "type": "string" }, "defaultRequestQueueId": { "type": "string" }, "buildNumber": { "type": "string", "example": "1.0.0" }, "containerUrl": { "type": "string" }, "usage": { "type": "object", "properties": { "ACTOR_COMPUTE_UNITS": { "type": "integer", "example": 0 }, "DATASET_READS": { "type": "integer", "example": 0 }, "DATASET_WRITES": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_READS": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_WRITES": { "type": "integer", "example": 1 }, "KEY_VALUE_STORE_LISTS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_READS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_WRITES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_INTERNAL_GBYTES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_EXTERNAL_GBYTES": { "type": "integer", "example": 0 }, "PROXY_RESIDENTIAL_TRANSFER_GBYTES": { "type": "integer", "example": 0 }, "PROXY_SERPS": { "type": "integer", "example": 0 } } }, "usageTotalUsd": { "type": "number", "example": 0.00005 }, "usageUsd": { "type": "object", "properties": { "ACTOR_COMPUTE_UNITS": { "type": "integer", "example": 0 }, "DATASET_READS": { "type": "integer", "example": 0 }, "DATASET_WRITES": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_READS": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_WRITES": { "type": "number", "example": 0.00005 }, "KEY_VALUE_STORE_LISTS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_READS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_WRITES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_INTERNAL_GBYTES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_EXTERNAL_GBYTES": { "type": "integer", "example": 0 }, "PROXY_RESIDENTIAL_TRANSFER_GBYTES": { "type": "integer", "example": 0 }, "PROXY_SERPS": { "type": "integer", "example": 0 } } } } } } } } }}OpenAPI is a standard for designing and describing RESTful APIs, allowing developers to define API structure, endpoints, and data formats in a machine-readable way. It simplifies API development, integration, and documentation.
OpenAPI is effective when used with AI agents and GPTs by standardizing how these systems interact with various APIs, for reliable integrations and efficient communication.
By defining machine-readable API specifications, OpenAPI allows AI models like GPTs to understand and use varied data sources, improving accuracy. This accelerates development, reduces errors, and provides context-aware responses, making OpenAPI a core component for AI applications.
You can download the OpenAPI definitions for Japan Yahoo! Shopping Product Search (Official API) from the options below:
If you’d like to learn more about how OpenAPI powers GPTs, read our blog post.
You can also check out our other API clients: