eBay eBay Search API

Scrape eBay search results

curl --request POST \
  --url https://api.stophy.dev/v1/ebay/search \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "query": "nintendo switch oled"
}
'

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({query: 'nintendo switch oled'})
};

fetch('https://api.stophy.dev/v1/ebay/search', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://api.stophy.dev/v1/ebay/search"

payload = { "query": "nintendo switch oled" }
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

{
  "success": true,
  "data": {
    "results": [
      {
        "itemUrl": "<string>",
        "isPriceHidden": true,
        "isPickupOnly": true,
        "isAuction": true,
        "hasBestOffer": true,
        "itemId": "<string>",
        "title": "<string>",
        "imageUrl": "<string>",
        "price": 1,
        "priceMax": 1,
        "originalPrice": 1,
        "priceCurrency": "<string>",
        "shippingCost": 1,
        "totalPrice": 1,
        "condition": "<string>",
        "bids": 0,
        "timeLeft": "<string>",
        "itemLocation": "<string>",
        "quantitySold": 0,
        "watchers": 0,
        "sellerName": "<string>",
        "sellerFeedbackPercent": 123,
        "sellerFeedbackScore": 0
      }
    ],
    "page": 0,
    "total": 0
  },
  "creditsUsed": 123,
  "requestId": "<string>"
}

{
  "success": false,
  "error": {
    "code": "cliSessionCompleted",
    "message": "<string>",
    "retryable": true,
    "requestId": "<string>",
    "retryAfterSeconds": 123,
    "requiredCredits": 123,
    "availableCredits": 123,
    "billingUrl": "https://stophy.dev/billing"
  }
}

{
  "success": false,
  "error": {
    "code": "cliSessionCompleted",
    "message": "<string>",
    "retryable": true,
    "requestId": "<string>",
    "retryAfterSeconds": 123,
    "requiredCredits": 123,
    "availableCredits": 123,
    "billingUrl": "https://stophy.dev/billing"
  }
}

POST

ebay

Scrape eBay search results

curl --request POST \
  --url https://api.stophy.dev/v1/ebay/search \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "query": "nintendo switch oled"
}
'

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({query: 'nintendo switch oled'})
};

fetch('https://api.stophy.dev/v1/ebay/search', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://api.stophy.dev/v1/ebay/search"

payload = { "query": "nintendo switch oled" }
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

{
  "success": true,
  "data": {
    "results": [
      {
        "itemUrl": "<string>",
        "isPriceHidden": true,
        "isPickupOnly": true,
        "isAuction": true,
        "hasBestOffer": true,
        "itemId": "<string>",
        "title": "<string>",
        "imageUrl": "<string>",
        "price": 1,
        "priceMax": 1,
        "originalPrice": 1,
        "priceCurrency": "<string>",
        "shippingCost": 1,
        "totalPrice": 1,
        "condition": "<string>",
        "bids": 0,
        "timeLeft": "<string>",
        "itemLocation": "<string>",
        "quantitySold": 0,
        "watchers": 0,
        "sellerName": "<string>",
        "sellerFeedbackPercent": 123,
        "sellerFeedbackScore": 0
      }
    ],
    "page": 0,
    "total": 0
  },
  "creditsUsed": 123,
  "requestId": "<string>"
}

{
  "success": false,
  "error": {
    "code": "cliSessionCompleted",
    "message": "<string>",
    "retryable": true,
    "requestId": "<string>",
    "retryAfterSeconds": 123,
    "requiredCredits": 123,
    "availableCredits": 123,
    "billingUrl": "https://stophy.dev/billing"
  }
}

{
  "success": false,
  "error": {
    "code": "cliSessionCompleted",
    "message": "<string>",
    "retryable": true,
    "requestId": "<string>",
    "retryAfterSeconds": 123,
    "requiredCredits": 123,
    "availableCredits": 123,
    "billingUrl": "https://stophy.dev/billing"
  }
}

Scrape eBay search results.

Request

query is required.

import { Stophy } from "stophy";

const stophy = new Stophy({ apiKey: process.env.STOPHY_API_KEY });
const result = await stophy.ebay.search({ query: "nintendo switch oled" });
console.log(result.data.results);

from stophy import Stophy

stophy = Stophy()  # reads STOPHY_API_KEY
result = stophy.ebay.search(query="nintendo switch oled")
print(result["data"]["results"])

curl -X POST https://api.stophy.dev/v1/ebay/search \
  -H "Authorization: Bearer $STOPHY_API_KEY" \
  -H "content-type: application/json" \
  -d '{"query":"nintendo switch oled"}'

stophy ebay search "nintendo switch oled"

Response

If successful, the response body contains the standard envelope. data.results[] contains the items, each with its price, shipping cost, total price, condition and location. The following example is a real response, truncated: each list shows one item and long strings are cut.

{
  "success": true,
  "data": {
    "total": 6400,
    "results": [
      {
        "itemId": "326350933758",
        "itemUrl": "https://www.ebay.com/itm/326350933758",
        "title": "Nintendo Switch OLED 64GB White Joy-Con 2021 Newest - Japan Import with US plug",
        "imageUrl": "https://i.ebayimg.com/images/g/Z94AAOSwTTJnQ-Bl/s-l500.jpg",
        "price": 350.99,
        "isPriceHidden": false,
        "priceCurrency": "USD",
        "shippingCost": 0,
        "isPickupOnly": false,
        "totalPrice": 350.99,
        "condition": "Brand New",
        "isAuction": false,
        "hasBestOffer": false,
        "itemLocation": "United States",
        "quantitySold": 71,
        "sellerName": "bestsellerssince1977",
        "sellerFeedbackPercent": 99.7,
        "sellerFeedbackScore": 4800
      }
    ],
    "page": 1
  },
  "creditsUsed": 1,
  "requestId": "2fe9dbad-fc48-4890-9751-0b24b596035b"
}

Field	Type	Description
`page`	integer	The page number of this response.
`total`	integer	The total number of matching results, across all pages.

For every field, see the response schema on this page.

Optional parameters

Parameter	Type	Description
`condition`	string	Restricts results to `new` or only `used` items. Acceptable values are `new` and `used`.
`auctionsOnly`	boolean	Restricts results to auctions. With sort `endingSoonest` this lists auctions about to end; eBay eBay Item then returns what each one sold for. If unset, defaults to `false`.
`minPrice`	number	The minimum price.
`maxPrice`	number	The maximum price.
`sort`	string	`priceLow` and `priceHigh` return each page in order of `totalPrice`: price plus shipping to New York 10001. Across pages the order is `eBay`’s, so a listing can belong on the neighbouring page. Listings with no `totalPrice` come last on their page: the price is hidden (`isPriceHidden`), the variation range is outside the price filter, or it is pickup only outside the United States. Acceptable values are `bestMatch`, `priceLow`, `priceHigh` and `endingSoonest`. If unset, defaults to `bestMatch`.
`page`	integer	The page to return. Pages are numbered from 1. Must be between 1 and 100. If unset, defaults to `1`.

Billing

Each successful request consumes 1 credit, regardless of the number of items returned. Requests that fail, or that return no items, are not billed.

Pagination

Results are paginated. To retrieve the next page, increment page. An empty data.results indicates the last page. The maximum value of page is 100.

eBay eBay Item: Accepts itemUrl. Scrape an eBay item page.

Authorizations

Authorization

string

header

required

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

Query Parameters

maxTextLength

integer

Cut every text value in the response to this many characters. A value that was cut ends with …, and a page whose text was cut has isTruncated set to true. A screenshot is never cut. Leave it out to get the full text.

Required range: x >= 1

Body

application/json

query

string

required

Required string length: 1 - 300

condition

enum<string>

Available options:

new,

used

auctionsOnly

boolean

default:false

Only auctions. With sort endingSoonest this lists auctions about to end; ebay.item then returns what each one sold for.

minPrice

number

Required range: x >= 0

maxPrice

number

Required range: x >= 0

sort

enum<string>

default:bestMatch

priceLow and priceHigh return each page in order of totalPrice: price plus shipping to New York 10001. Across pages the order is eBay's, so a listing can belong on the neighbouring page. Listings with no totalPrice come last on their page: the price is hidden (isPriceHidden), the variation range is outside the price filter, or it is pickup only outside the United States.

Available options:

bestMatch,

priceLow,

priceHigh,

endingSoonest

page

integer

default:1

Page number, starting at 1.

Required range: 1 <= x <= 100

Response

The data, and the credits this call used.

success

any

required

data

object

required

Show child attributes

creditsUsed

integer

required

requestId

string

required

Using the API

Catalog

Account

Search and AI answers

Video

Social

Places and travel

Jobs

Shopping

Apps

Real estate

Ads

eBay eBay Search API

Request

Response

Optional parameters

Billing

Authorizations

Query Parameters

Body

Response

​Request

​Response

​Optional parameters

​Billing

​Pagination

​Related methods

Authorizations

Query Parameters

Body

Response

Request

Response

Optional parameters

Billing

Pagination

Related methods