Storeebay.com.au

Ebay.com.au

2 endpoints: search and product details. Each reads one page URL per request, from your agent or the REST API, and answers in structured or raw format. Every account starts with 200 free trial credits.

Search

eBay keyword search (/sch/i.html?_nkw=keyword, optional _pgn start page) on 17 marketplaces, parsed from eBay's search pages; follows the page's own next link, max_pages 1-5, no filters. On ebay.es and ebay.be, eBay often refuses page 2.

ID: ebay.search_items
Version: 1
Price: 5 credits / page
State: Available
Typical time: About 45 s (estimate)

What it does

Reads one search results page (or up to the page limit) and returns one record per product card, in page order. Works on ebay.com.au; other hosts are rejected before anything runs.

Input

One page URL per request, shaped like https://www.ebay.com.au/sch/i.html?_nkw=lego, plus these bounded parameters.

Parameter	Type	Allowed	Default	Set in /v1/requests
`max_pages`	integer	1–5	1	`max_pages`

Price

5 credits / page. With max_pages up to 5, a request costs at most 25 credits. Failed requests are free; a page that loaded but had nothing on it still costs credits. Set max_credits to refuse anything dearer before it runs.

Output

The default, "format": "structured". Every shop answers in the same fields, mapped from the page to the product_summary@1 schema. Fields are null when the page doesn't show them, and a record that can't be mapped is read best-effort from its raw fields. Products are in products, up to 50 a page; follow next_cursor with GET /v1/requests/{id} (MCP: get_results).

Field	Type	Description
`product_id`	string or null	Opaque id. Pass it to get_product (or capability "product") to read the product again.
`title`	string	Product title as the shop shows it.
`url`	string or null	The product page on the shop.
`shop`	string or null	The shop’s hostname, without www.
`price`	object or null	amount (number), currency (ISO 4217, or null when the shop doesn’t say) and text (the shop’s own wording when it is the same amount, else null).
`original_price`	object or null	The price before a discount, in the same shape as price.
`rating`	number or null	Average rating, on the shop’s own scale.
`review_count`	integer or null	Number of reviews or ratings.
`image_url`	string or null	Main product image.
`availability`	string or null	in_stock, out_of_stock, or the shop’s own stock wording.
`sponsored`	boolean or null	true for an ad the shop marks as sponsored; null when the page doesn’t say.

Answer shape (types, not real data)

{
  "request_id": "string",
  "status": "done",
  "products": [
    {
      "product_id": "string or null",
      "title": "string",
      "url": "string or null",
      "shop": "string or null",
      "price": {
        "amount": "number",
        "currency": "string or null",
        "text": "string or null"
      },
      "original_price": {
        "amount": "number",
        "currency": "string or null",
        "text": "string or null"
      },
      "rating": "number or null",
      "review_count": "integer or null",
      "image_url": "string or null",
      "availability": "string or null",
      "sponsored": "boolean or null"
    }
  ],
  "next_cursor": "string or null",
  "meta": {
    "as_of": "date-time",
    "country": "string",
    "credits_used": "integer",
    "credits_left": "integer"
  }
}

Over the Jobs API, GET /v1/jobs/{id}/results?format=structured returns the full product_summary@1 records.

With "format": "raw", the answer keeps the structured fields and adds raw: this endpoint's own records, unchanged, one per item, in the schema below. It is the data the endpoint extracted from the page, not the page's HTML. Same price as structured.

Field	Type	Description
`item_id`	string required	Pattern ^[1-9][0-9]{8,19}$
`title`	string required	—
`url`	string (uri) required	—
`marketplace`	"ebay.com" \| "ebay.co.uk" \| "ebay.de" \| "ebay.fr" \| "ebay.it" \| "ebay.es" \| "ebay.nl" \| "ebay.at" \| "ebay.be" \| "ebay.ch" \| "ebay.ie" \| "ebay.pl" \| "ebay.ca" \| "ebay.com.au" \| "ebay.com.hk" \| "ebay.com.my" \| "ebay.com.sg" required	—
`price_text`	string or null required	—
`price`	string or null required	Pattern ^[0-9]{1,15}(\.[0-9]{1,4})?$
`price_max`	string or null required	Pattern ^[0-9]{1,15}(\.[0-9]{1,4})?$
`currency`	string or null required	Pattern ^[A-Z]{3}$
`shipping_text`	string or null required	—
`condition`	string or null required	—
`image_url`	string or null required	—
`page`	integer required	Minimum 1
`position`	integer required	Minimum 1
`source`	"search_html" required	—

One raw record (types, not real data)

{
  "item_id": "string",
  "title": "string",
  "url": "string (uri)",
  "marketplace": "ebay.com | ebay.co.uk | ebay.de | ebay.fr | ebay.it | ebay.es | ebay.nl | ebay.at | ebay.be | ebay.ch | ebay.ie | ebay.pl | ebay.ca | ebay.com.au | ebay.com.hk | ebay.com.my | ebay.com.sg",
  "price_text": "string or null",
  "price": "string or null",
  "price_max": "string or null",
  "currency": "string or null",
  "shipping_text": "string or null",
  "condition": "string or null",
  "image_url": "string or null",
  "page": "integer",
  "position": "integer",
  "source": "search_html"
}

Raw needs this endpoint: a search with format: "raw" doesn't fall back to shopping search, and answers raw_unavailable where no endpoint can run. Over the Jobs API, results are raw by default; format=both gives each raw record with its structured form.

Request

Run exactly this endpoint with capability: "endpoint"; there is no fallback, and a failed run is free. Set format to "raw" for the raw records too. For a keyword instead of a URL, search_products with this shop as site builds the search URL, tries the shop's endpoint first and then shopping search.

POST /v1/requests

curl https://api.datawebot.com/v1/requests \
  -H "Authorization: Bearer $DATAWEBOT_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"capability":"endpoint","endpoint":"ebay.search_items","url":"https://www.ebay.com.au/sch/i.html?_nkw=lego","max_pages":1,"format":"structured"}'

MCP submit_job

submit_job {
  "endpoint": "ebay.search_items",
  "url": "https://www.ebay.com.au/sch/i.html?_nkw=lego",
  "max_pages": 1,
  "format": "structured"
}

If the answer says "status": "working", read it again with GET /v1/requests/{id} (MCP: get_results) after check_after_seconds.

Product details

One eBay listing (/itm/<item number>, optional ?var=<variation ID>) on 17 marketplaces, parsed from the listing page (embedded JSON-LD first, visible blocks as fallback). Seller identity is not returned.

ID: ebay.product_details
Version: 1
Price: 1 credit / page
State: Available
Typical time: About 20 s (estimate)

What it does

Reads one product page and returns that product. Works on ebay.com.au; other hosts are rejected before anything runs.

Input

One page URL per request, shaped like https://www.ebay.com.au/itm/327414850475.

Price

1 credit / page. Failed requests are free; a page that loaded but had nothing on it still costs credits. Set max_credits to refuse anything dearer before it runs.

Output

The default, "format": "structured". Every shop answers in the same fields, mapped from the page to the product@1 schema. Fields are null when the page doesn't show them, and a record that can't be mapped is read best-effort from its raw fields. The product is in product.

Field	Type	Description
`product_id`	string or null	Opaque id. Pass it to get_product (or capability "product") to read the product again.
`title`	string	Product title as the shop shows it.
`url`	string or null	The product page on the shop.
`shop`	string or null	The shop’s hostname, without www.
`price`	object or null	amount (number), currency (ISO 4217, or null when the shop doesn’t say) and text (the shop’s own wording when it is the same amount, else null).
`original_price`	object or null	The price before a discount, in the same shape as price.
`rating`	number or null	Average rating, on the shop’s own scale.
`review_count`	integer or null	Number of reviews or ratings.
`image_url`	string or null	Main product image.
`availability`	string or null	in_stock, out_of_stock, or the shop’s own stock wording.
`sponsored`	boolean or null	true for an ad the shop marks as sponsored; null when the page doesn’t say.

product.details, when the shop's page maps to product@1:

Field	Type	Description
`brand`	string or null	Brand as the page names it.
`category_path`	array of strings	Breadcrumb categories, top first.
`description`	string or null	Plain-text description.
`feature_bullets`	array of strings	Listed features.
`price_min, price_max`	number or null	Lowest and highest variant price.
`discount_label`	string or null	Discount wording, such as "-20%".
`stock`	integer or null	Units in stock, when the page shows a number.
`sold_count, sold_count_basis`	integer or null; "total", "monthly" or null	Units sold, and whether that is a total or per month.
`identifiers`	array of {type, value}	asin, parent_asin, walmart_item_id, gtin, mpn, isbn or source_sku.
`specs_raw`	array of {name, value}	The specification table as shown.
`images, image_count`	array of {url, alt}; integer	Every product image.
`option_names`	array of strings	Option names such as Size or Colour.
`variants, variant_count`	array (up to 100); integer or null	Each variant: id, name, options, sku, final_price, price_before_discount, discount_label, available, stock, image_url.
`seller`	object or null	id, name, url and type (official or marketplace).
`rating_scale`	number or null	The top of the rating scale, such as 5.
`warnings`	array of strings	Fields the page didn’t give, such as currency_missing.

Answer shape (types, not real data)

{
  "request_id": "string",
  "status": "done",
  "product": {
    "product_id": "string or null",
    "title": "string",
    "url": "string or null",
    "shop": "string or null",
    "price": {
      "amount": "number",
      "currency": "string or null",
      "text": "string or null"
    },
    "original_price": {
      "amount": "number",
      "currency": "string or null",
      "text": "string or null"
    },
    "rating": "number or null",
    "review_count": "integer or null",
    "image_url": "string or null",
    "availability": "string or null",
    "sponsored": "boolean or null",
    "details": {
      "brand": "string or null",
      "variants": [
        "…"
      ],
      "…": "…"
    }
  },
  "meta": {
    "as_of": "date-time",
    "country": "string",
    "credits_used": "integer",
    "credits_left": "integer"
  }
}

Over the Jobs API, GET /v1/jobs/{id}/results?format=structured returns the full product@1 records.

Field	Type	Description
`item_id`	string required	Pattern ^[1-9][0-9]{8,19}$
`variation_id`	string or null required	Pattern ^[1-9][0-9]{0,19}$
`title`	string required	—
`url`	string (uri) required	—
`marketplace`	"ebay.com" \| "ebay.co.uk" \| "ebay.de" \| "ebay.fr" \| "ebay.it" \| "ebay.es" \| "ebay.nl" \| "ebay.at" \| "ebay.be" \| "ebay.ch" \| "ebay.ie" \| "ebay.pl" \| "ebay.ca" \| "ebay.com.au" \| "ebay.com.hk" \| "ebay.com.my" \| "ebay.com.sg" required	—
`price_text`	string or null required	—
`price`	string or null required	Pattern ^[0-9]{1,15}(\.[0-9]{1,4})?$
`price_max`	string or null required	Pattern ^[0-9]{1,15}(\.[0-9]{1,4})?$
`currency`	string or null required	Pattern ^[A-Z]{3}$
`condition`	string or null required	—
`availability`	"in_stock" \| "out_of_stock" \| null required	—
`shipping_text`	string or null required	—
`brand`	string or null required	—
`gtin`	string or null required	—
`mpn`	string or null required	—
`category_path`	array required	—
`item_specifics`	array required	—
`image_urls`	array required	—
`source`	"json_ld" \| "html" \| "json_ld+html" required	—

One raw record (types, not real data)

{
  "item_id": "string",
  "variation_id": "string or null",
  "title": "string",
  "url": "string (uri)",
  "marketplace": "ebay.com | ebay.co.uk | ebay.de | ebay.fr | ebay.it | ebay.es | ebay.nl | ebay.at | ebay.be | ebay.ch | ebay.ie | ebay.pl | ebay.ca | ebay.com.au | ebay.com.hk | ebay.com.my | ebay.com.sg",
  "price_text": "string or null",
  "price": "string or null",
  "price_max": "string or null",
  "currency": "string or null",
  "condition": "string or null",
  "availability": "in_stock | out_of_stock | null",
  "shipping_text": "string or null",
  "brand": "string or null",
  "gtin": "string or null",
  "mpn": "string or null",
  "category_path": "array",
  "item_specifics": "array",
  "image_urls": "array",
  "source": "json_ld | html | json_ld+html"
}

Over the Jobs API, results are raw by default; format=both gives each raw record with its structured form.

Request

Read a product page with capability: "product"; it runs this endpoint for the page's shop. Set format to "raw" for the raw records too.

POST /v1/requests

curl https://api.datawebot.com/v1/requests \
  -H "Authorization: Bearer $DATAWEBOT_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"capability":"product","url":"https://www.ebay.com.au/itm/327414850475","format":"structured"}'

MCP get_product

get_product {
  "url": "https://www.ebay.com.au/itm/327414850475",
  "format": "structured"
}

If the answer says "status": "working", read it again with GET /v1/requests/{id} (MCP: get_results) after check_after_seconds.