Skip to main content
POST
Yahoo! Auctions items search

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
keyword
string

Search term (optional when a category is set). e.g. rolex

keyword_exclude
string

Excluded words (space-separated, needs a search term). e.g. e.g. box case

max_items
integer
default:25

Max items (up to 500)

Required range: 0 <= x <= 500
start_page
integer
default:1

Starting page

Required range: x >= 0
sort
enum<string>

Sort by. Options: newest = Newest, ending_soonest = Ending soonest, ending_latest = Ending latest, price_asc = Price: low to high, price_desc = Price: high to low, buy_now_price_asc = Buy-it-now: low to high, buy_now_price_desc = Buy-it-now: high to low, bids_desc = Most bids, bids_asc = Fewest bids, popular = Popular, featured = Featured

Available options:
newest,
ending_soonest,
ending_latest,
price_asc,
price_desc,
buy_now_price_asc,
buy_now_price_desc,
bids_desc,
bids_asc,
popular,
featured
condition
enum<string>

Condition. Options: new = New, used = Used (any), like_new = Like new, no_visible_damage = No visible damage, slight_damage = Slight damage, damaged = Damaged, poor = Poor condition

Available options:
new,
used,
like_new,
no_visible_damage,
slight_damage,
damaged,
poor
price_min
integer

Min current price (JPY)

Required range: x >= 0
price_max
integer

Max current price (JPY)

Required range: x >= 0
buy_now_price_min
integer

Min buy-it-now price (JPY)

Required range: x >= 0
buy_now_price_max
integer

Max buy-it-now price (JPY)

Required range: x >= 0
category
integer

Category ID

Required range: x >= 0
brand_id
integer

Brand ID

Required range: x >= 0
region
enum<string>

Shipped from. Options: hokkaido = Hokkaido, aomori = Aomori, iwate = Iwate, miyagi = Miyagi, akita = Akita, yamagata = Yamagata, fukushima = Fukushima, ibaraki = Ibaraki, tochigi = Tochigi, gunma = Gunma, saitama = Saitama, chiba = Chiba, tokyo = Tokyo, kanagawa = Kanagawa, yamanashi = Yamanashi, nagano = Nagano, niigata = Niigata, toyama = Toyama, ishikawa = Ishikawa, fukui = Fukui, gifu = Gifu, shizuoka = Shizuoka, aichi = Aichi, mie = Mie, shiga = Shiga, kyoto = Kyoto, osaka = Osaka, hyogo = Hyogo, nara = Nara, wakayama = Wakayama, tottori = Tottori, shimane = Shimane, okayama = Okayama, hiroshima = Hiroshima, yamaguchi = Yamaguchi, tokushima = Tokushima, kagawa = Kagawa, ehime = Ehime, kochi = Kochi, fukuoka = Fukuoka, saga = Saga, nagasaki = Nagasaki, kumamoto = Kumamoto, oita = Oita, miyazaki = Miyazaki, kagoshima = Kagoshima, okinawa = Okinawa, overseas = Overseas

Available options:
hokkaido,
aomori,
iwate,
miyagi,
akita,
yamagata,
fukushima,
ibaraki,
tochigi,
gunma,
saitama,
chiba,
tokyo,
kanagawa,
yamanashi,
nagano,
niigata,
toyama,
ishikawa,
fukui,
gifu,
shizuoka,
aichi,
mie,
shiga,
kyoto,
osaka,
hyogo,
nara,
wakayama,
tottori,
shimane,
okayama,
hiroshima,
yamaguchi,
tokushima,
kagawa,
ehime,
kochi,
fukuoka,
saga,
nagasaki,
kumamoto,
oita,
miyazaki,
kagoshima,
okinawa,
overseas
seller_type
enum<string>

Seller type. Options: store = Store, individual = Individual

Available options:
store,
individual
listing_type
enum<string>

Listing type. Options: auction = Bidding auctions, fixed_price = Fixed price

Available options:
auction,
fixed_price
marketplace
enum<string>

Marketplace. Options: yahoo_auctions = Yahoo! Auctions, yahoo_flea = Yahoo! Flea Market

Available options:
yahoo_auctions,
yahoo_flea
authenticated
boolean

Authenticity appraisal only

free_shipping
boolean

Free shipping only

has_image
boolean

With photo only

new_arrival
boolean

Newly listed only

ending_within_hour
boolean

Ending within 1 hour

konbini_pickup
boolean

Convenience-store pickup

anonymous_shipping
boolean

Anonymous shipping

Response

Run completed.

session_id
string

Session identifier for this run.

kind
string

Data source identifier for this endpoint.

category
integer
max_items
integer
start_page
integer
partial
boolean

True when the scrape stopped early and returned the records collected so far.

human
string

Markdown summary of the result, for display.

machine
object

Structured result payload.

total_points
integer

Points charged for this run.