{ "openapi": "3.0.1", "info": { "title": "Yahoo Auctions Japan Scraper: Live and Sold Prices", "description": "Scrape Yahoo! Auctions Japan (ヤフオク) live and sold auctions by keyword, category, seller, brand or search link, no login. Get current or winning price in yen, bids, buy now price, end time, category path, condition, seller type and prefecture, plus details, sold price summaries and a monitor.", "version": "0.1", "x-build-id": "pGpQe5RzRmz7lpcnc" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/automation_craft~yahoo-auctions-japan-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-automation_craft-yahoo-auctions-japan-scraper", "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/automation_craft~yahoo-auctions-japan-scraper/runs": { "post": { "operationId": "runs-sync-automation_craft-yahoo-auctions-japan-scraper", "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/automation_craft~yahoo-auctions-japan-scraper/run-sync": { "post": { "operationId": "run-sync-automation_craft-yahoo-auctions-japan-scraper", "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", "properties": { "keywords": { "title": "Keywords", "type": "array", "description": "Search words as you would type them on Yahoo! Auctions Japan, for example ポケモンカード, ニコン F3 or セイコー. Yahoo's own search syntax works: a word with a minus in front is left out, words in brackets are any of them, words in quotes are a phrase. Up to 100 keywords of up to 100 characters each.", "items": { "type": "string" } }, "categoryIds": { "title": "Category ids", "type": "array", "description": "Yahoo! Auctions category ids, the number in a category link (https://auctions.yahoo.co.jp/category/list/2084005150/) or after auccat= in a search link. Each row's own category path is checked to hold the id. Up to 100.", "items": { "type": "string" } }, "sellers": { "title": "Sellers", "type": "array", "description": "Seller page links (https://auctions.yahoo.co.jp/seller/) or bare seller ids: the auctions of each seller, filtered by the settings below (with keywords: each keyword within each seller). Up to 100.", "items": { "type": "string" } }, "brandIds": { "title": "Brand ids", "type": "array", "description": "Yahoo! Auctions brand ids (the number after brand_id= in a search link, for example 167473 for the Pokemon Card Game). A brand includes its sub brands, as on the site. Alone, the brand is searched; beside keywords, category ids or sellers, every search is narrowed to it; beside search links, it replaces each link's brand.", "items": { "type": "string" } }, "searchUrls": { "title": "Search links", "type": "array", "description": "Search links copied from Yahoo! Auctions: a search (https://auctions.yahoo.co.jp/search/search?p=...), a closed search of sold auctions (/closedsearch/closedsearch?p=...), a category list or a seller page. Each link is one search with its words, category, brand, seller, prices, conditions, seller types, sale format, bid counts, free shipping, new listings, order and start row. A link with any other setting is refused with a free row that names it. Up to 100.", "items": { "type": "string" } }, "auctionUrls": { "title": "Auction links", "type": "array", "description": "Auction links (https://auctions.yahoo.co.jp/jp/auction/x1234567890) or auction ids: each is read from its item record and delivered with its details (billed as a Listing and a Listing detail). An auction Yahoo no longer has is a free row. Up to 1,000.", "items": { "type": "string" } }, "useJapaneseAliases": { "title": "Retry English or Chinese names in Japanese", "type": "boolean", "description": "When a search (a keyword, or the words of a pasted search link) finds no auction at all and its words are a name this Actor knows in Japanese (37 names such as pokemon card, one piece, nikon and seiko), the search is read once more with the Japanese term sellers use; the rows and the coverage row say which term found them.", "default": false }, "status": { "title": "Live or sold auctions", "enum": [ "live", "sold", "both" ], "type": "string", "description": "live: auctions and fixed price items on sale now. sold: auctions that ended with a winning bid and items sold at their price, about the last 180 days (the row price is the winning price). both: each search is read twice, live and sold.", "default": "live" }, "sort": { "title": "Sort", "enum": [ "newest", "ending_soon", "price_low", "price_high", "most_bids", "fewest_bids", "most_watched", "buy_now_low", "buy_now_high", "best_match" ], "type": "string", "description": "The order Yahoo serves the results in. newest is newest listing first on live searches and most recently ended first on sold searches. best_match repeats some rows across pages, so its walk is never called complete. Left out: newest, and a search link keeps its own order." }, "minPrice": { "title": "Minimum price (yen)", "minimum": 0, "maximum": 999999999, "type": "integer", "description": "Current price on live auctions, winning price on sold ones. Whole yen." }, "maxPrice": { "title": "Maximum price (yen)", "minimum": 0, "maximum": 999999999, "type": "integer", "description": "Current price on live auctions, winning price on sold ones. Whole yen." }, "minBuyNowPrice": { "title": "Minimum buy now price (yen)", "minimum": 0, "maximum": 999999999, "type": "integer", "description": "Live only: auctions and items with a buy now price of at least this. Whole yen." }, "maxBuyNowPrice": { "title": "Maximum buy now price (yen)", "minimum": 0, "maximum": 999999999, "type": "integer", "description": "Live only: auctions and items with a buy now price of at most this. Whole yen." }, "conditions": { "title": "Conditions", "type": "array", "description": "Only auctions in one of these conditions, as the seller graded them.", "items": { "type": "string", "enum": [ "new", "like_new", "good", "fair", "poor", "bad", "used" ], "enumTitles": [ "New, unused (未使用)", "Like new (未使用に近い)", "No noticeable scratches (目立った傷や汚れなし)", "Some scratches (やや傷や汚れあり)", "Scratches or stains (傷や汚れあり)", "Poor overall (全体的に状態が悪い)", "Used, no grade (中古)" ] } }, "sellerTypes": { "title": "Seller types", "type": "array", "description": "Only these kinds of seller. Left out: every kind, Yahoo!フリマ listings included and flagged on each row (isFleaMarketItem).", "items": { "type": "string", "enum": [ "store", "individual", "fleamarket" ], "enumTitles": [ "Stores", "Individuals (auctions)", "Yahoo!フリマ (flea market) listings" ] } }, "saleFormat": { "title": "Sale format", "enum": [ "all", "auction", "fixed_price" ], "type": "string", "description": "Auctions only, fixed price items only, or both. On sold searches, fixed price also holds auctions that ended at their buy now price, as Yahoo files them. Left out: every format, and a search link keeps its own." }, "buyNowOnly": { "title": "Only with a buy now price", "type": "boolean", "description": "Only auctions that carry a buy now price (即決). Left out: off, and a search link keeps its own; false clears it." }, "freeShippingOnly": { "title": "Only free shipping", "type": "boolean", "description": "Only auctions with free shipping (送料無料). Left out: off, and a search link keeps its own; false clears it." }, "minBids": { "title": "Minimum bids", "minimum": 1, "maximum": 100000, "type": "integer", "description": "Only auctions with at least this many bids." }, "maxBids": { "title": "Maximum bids", "minimum": 1, "maximum": 100000, "type": "integer", "description": "Only auctions with at most this many bids (1 or more: Yahoo applies no maximum of 0)." }, "prefectures": { "title": "Ships from prefectures", "type": "array", "description": "Only auctions shipped from these prefectures: codes 1 to 47 or names such as Tokyo, Osaka or 東京都.", "items": { "type": "string" } }, "excludePrefectures": { "title": "Leave out prefectures", "type": "array", "description": "Leave out auctions shipped from these prefectures (codes 1 to 47 or names).", "items": { "type": "string" } }, "endingWithinHours": { "title": "Ending within hours", "minimum": 1, "maximum": 720, "type": "integer", "description": "Live only: auctions that end within this many hours of the run." }, "endingWithinMinutes": { "title": "Ending within minutes", "minimum": 1, "maximum": 43200, "type": "integer", "description": "Live only: auctions that end within this many minutes of the run (give this or endingWithinHours)." }, "newListingsOnly": { "title": "Only new listings (24 hours)", "type": "boolean", "description": "Live only: auctions that started within the last 24 hours, as Yahoo marks them new. Left out: off, and a search link keeps its own; false clears it." }, "soldWithinDays": { "title": "Sold within days", "minimum": 1, "maximum": 365, "type": "integer", "description": "Sold only: auctions that ended within this many days before the run started (Yahoo serves about 180 days)." }, "soldFrom": { "title": "Sold from (date)", "type": "string", "description": "Sold only: auctions that ended on or after this day (Japan time), written YYYY-MM-DD, for example 2026-09-01. With \"soldTo\" a closed window between two dates." }, "soldTo": { "title": "Sold to (date)", "type": "string", "description": "Sold only: auctions that ended on or before this day (Japan time), written YYYY-MM-DD." }, "excludeKeywords": { "title": "Leave out words", "type": "array", "description": "Auctions whose title holds one of these words are left out (each word is also sent to Yahoo as a word to leave out). One word per item, up to 30.", "items": { "type": "string" } }, "onlyTitleMatches": { "title": "Only titles holding every keyword word", "type": "boolean", "description": "Only auctions whose title holds every word of the keyword (Yahoo also matches words in other fields).", "default": false }, "includeDetails": { "title": "Include auction details", "type": "boolean", "description": "Read each delivered auction's item record: description, every photo, bidder count, item specifics, shipping methods and payer, returns, early finish, automatic extension and bidder rules, seller rating counts and store licences. Billed as a Listing detail per row. Yahoo!フリマ items have no record there and come without details.", "default": false }, "includePersonalData": { "title": "Include personal data", "type": "boolean", "description": "Off: an individual or flea market seller's id, page link and nickname, and the highest bidders' names, are empty (a store is a business and always shown). On: they are delivered as Yahoo shows them logged out. You are responsible for a lawful use of personal data, GDPR included.", "default": false }, "currencies": { "title": "Convert prices to", "type": "array", "description": "Adds each price in up to 5 of these currencies at the European Central Bank's daily euro reference rate of the run (one read a run), with the rates and their date on every row. Prices in yen stay.", "items": { "type": "string", "enum": [ "USD", "EUR", "GBP", "AUD", "CAD", "CNY", "HKD", "KRW", "SGD", "CHF", "THB", "PHP", "MYR", "IDR", "INR", "NZD" ] } }, "priceSummary": { "title": "Price summary per search", "type": "boolean", "description": "One extra row per search with the count, lowest, highest, average and median price, the quartiles and ten sample auctions of what it delivered: sold comparables from a sold search. Billed as a Price summary per search that delivered a priced auction.", "default": false }, "maxItems": { "title": "Maximum rows", "minimum": 1, "maximum": 100000, "type": "integer", "description": "Auction rows the run delivers at most, over all searches and links.", "default": 100 }, "maxItemsPerSearch": { "title": "Maximum rows per search", "minimum": 1, "maximum": 100000, "type": "integer", "description": "Auction rows one search delivers at most." }, "maxPagesPerSearch": { "title": "Pages per search", "minimum": 1, "maximum": 151, "type": "integer", "description": "Result pages of 100 rows read per search at most (Yahoo serves one search 15,100 rows, 151 pages); with splitByPrice, per price band.", "default": 10 }, "startPage": { "title": "Start page", "minimum": 1, "maximum": 151, "type": "integer", "description": "The page of 100 results to start each search at (page 2 starts at row 101).", "default": 1 }, "splitByPrice": { "title": "Split big searches by price", "type": "boolean", "description": "A search that reports more than the 15,100 rows Yahoo serves one search is split into price bands, each read on its own, to reach the rest. Slower: Yahoo paces its search door.", "default": false }, "monitorName": { "title": "Monitor name", "type": "string", "description": "Give a name to deliver and bill each auction once across runs: a scheduled run delivers only auctions this monitor has not delivered before, newest first. Each results page a monitor run reads is billed as a Results page. One name per set of settings." }, "resumeFromDatasetId": { "title": "Skip auctions of a dataset", "type": "string", "description": "The id of an earlier run's dataset: the auctions in it are not delivered again in this run." }, "proxyConfiguration": { "title": "Proxy", "type": "object", "description": "Apify's datacenter proxy (the default) or Apify residential with the country JP or US. Yahoo refuses Europe and the UK. The run reads Yahoo through one address." } } }, "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 }, "PROXY_UNBLOCKER_UNITS": { "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 }, "PROXY_UNBLOCKER_UNITS": { "type": "integer", "example": 0 } } } } } } } } } }