eBay eBay Item API

Scrape an eBay item page

curl --request POST \
  --url https://api.stophy.dev/v1/ebay/item \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "itemUrl": "<string>",
  "itemId": "<string>"
}
'

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

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

import requests

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

payload = {
    "itemUrl": "<string>",
    "itemId": "<string>"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

{
  "success": true,
  "data": {
    "itemUrl": "<string>",
    "isAuction": true,
    "isEnded": true,
    "isSold": true,
    "specifics": [
      {
        "name": "<string>",
        "value": "<string>"
      }
    ],
    "categories": [
      "<string>"
    ],
    "imageUrls": [
      "<string>"
    ],
    "itemId": "<string>",
    "title": "<string>",
    "price": 1,
    "originalPrice": 1,
    "priceCurrency": "<string>",
    "condition": "<string>",
    "bids": 0,
    "endedAt": "2023-11-07T05:31:56Z",
    "soldPrice": 1,
    "soldAt": "2023-11-07T05:31:56Z",
    "isAvailable": true,
    "quantityAvailable": 0,
    "quantitySold": 0,
    "brand": "<string>",
    "model": "<string>",
    "sellerName": "<string>",
    "sellerFeedbackScore": 0,
    "sellerFeedbackPercent": 123,
    "shippingCost": 1,
    "shippingPostalCode": "<string>",
    "itemLocation": "<string>",
    "returnsAccepted": true,
    "returnDays": 0,
    "listedAt": "2023-11-07T05:31:56Z",
    "description": "<string>"
  },
  "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

item

Scrape an eBay item page

curl --request POST \
  --url https://api.stophy.dev/v1/ebay/item \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "itemUrl": "<string>",
  "itemId": "<string>"
}
'

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

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

import requests

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

payload = {
    "itemUrl": "<string>",
    "itemId": "<string>"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

{
  "success": true,
  "data": {
    "itemUrl": "<string>",
    "isAuction": true,
    "isEnded": true,
    "isSold": true,
    "specifics": [
      {
        "name": "<string>",
        "value": "<string>"
      }
    ],
    "categories": [
      "<string>"
    ],
    "imageUrls": [
      "<string>"
    ],
    "itemId": "<string>",
    "title": "<string>",
    "price": 1,
    "originalPrice": 1,
    "priceCurrency": "<string>",
    "condition": "<string>",
    "bids": 0,
    "endedAt": "2023-11-07T05:31:56Z",
    "soldPrice": 1,
    "soldAt": "2023-11-07T05:31:56Z",
    "isAvailable": true,
    "quantityAvailable": 0,
    "quantitySold": 0,
    "brand": "<string>",
    "model": "<string>",
    "sellerName": "<string>",
    "sellerFeedbackScore": 0,
    "sellerFeedbackPercent": 123,
    "shippingCost": 1,
    "shippingPostalCode": "<string>",
    "itemLocation": "<string>",
    "returnsAccepted": true,
    "returnDays": 0,
    "listedAt": "2023-11-07T05:31:56Z",
    "description": "<string>"
  },
  "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 an eBay item page. The item is identified by its URL or ID.

Request

Exactly one of itemUrl or itemId is required. A request that sets both, or none, fails with invalidRequest.

import { Stophy } from "stophy";

const stophy = new Stophy({ apiKey: process.env.STOPHY_API_KEY });
const result = await stophy.ebay.item({ itemId: "820221984535" });
console.log(result.data);

from stophy import Stophy

stophy = Stophy()  # reads STOPHY_API_KEY
result = stophy.ebay.item(item_id="820221984535")
print(result["data"])

curl -X POST https://api.stophy.dev/v1/ebay/item \
  -H "Authorization: Bearer $STOPHY_API_KEY" \
  -H "content-type: application/json" \
  -d '{"itemId":"820221984535"}'

stophy ebay item --itemId 820221984535

Response

If successful, the response body contains the standard envelope. data contains the item’s price, condition, auction status, brand, model and item specifics. The following example is a real response, truncated: each list shows one item and long strings are cut.

{
  "success": true,
  "data": {
    "itemId": "820221984535",
    "itemUrl": "https://www.ebay.com/itm/820221984535",
    "title": "Nintendo Switch OLED Splatoon 3 Edition Handheld Console Multicolor",
    "price": 5.5,
    "priceCurrency": "USD",
    "condition": "Used",
    "isAuction": true,
    "bids": 3,
    "isEnded": false,
    "isSold": false,
    "isAvailable": true,
    "brand": "Nintendo",
    "model": "Nintendo Switch (OLED Model) Splatoon 3 Edition",
    "specifics": [
      {
        "name": "Brand",
        "value": "Nintendo"
      }
    ],
    "categories": ["Electronics"],
    "sellerName": "Retro Held Games",
    "sellerFeedbackScore": 7656,
    "sellerFeedbackPercent": 99.9,
    "shippingCost": 20,
    "shippingPostalCode": "95119",
    "itemLocation": "San Diego, California, United States",
    "listedAt": "2026-10-09T22:28:48.000Z",
    "imageUrls": ["https://i.ebayimg.com/images/g/mUMAAeSwpvhqxEl6/s-l1600.jpg"],
    "description": "In excellent condition overall! Works great with no issues, includes everything in the photos.\n\nShips Next Business Day!"
  },
  "creditsUsed": 1,
  "requestId": "2fe9dbad-fc48-4890-9751-0b24b596035b"
}

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

This method is not paginated. A single request returns the complete result.

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

itemUrl

string

Link to the eBay item, like https://www.ebay.com/itm/266625967665. Send this or itemId.

itemId

string

EBay item id, like 266625967665. Send this or itemUrl.

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 Item API

Request

Response

Billing

Authorizations

Query Parameters

Body

Response

​Request

​Response

​Billing

​Pagination

Authorizations

Query Parameters

Body

Response

Request

Response

Billing

Pagination