eBay API Capability

Search ranking

Inspect ordered search listings and their sponsored status.

Capability ID ebay.search.placements

Cost From $1.25 per 1,000 requests · 1 credit

Maximum runtime 180 seconds

# Search ranking

Inspect ordered search listings and their sponsored status.

- Platform: [eBay](https://docs.upscrape.com/docs/platforms/ebay)
- Capability ID: `ebay.search.placements`
- Cost: 1 credit per request
- Maximum runtime: 180 seconds
- Execute endpoint: `POST https://data.upscrape.com/execute`

## Request

Use the exact public capability ID in the shared execute envelope.

```bash
curl --request POST \
  --url https://data.upscrape.com/execute \
  --header "Authorization: Bearer $UPSCRAPE_API_KEY" \
  --header "Content-Type: application/json" \
  --header "Prefer: wait=30" \
  --data '{
  "input": {
    "limit": 60,
    "page": 1,
    "query": "used laptop"
  },
  "capability": "ebay.search.placements"
}'
```

## Input

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `limit` | `integer` | No | Maximum number of results to return. Allowed values: `60`, `120`, `240`. |
| `page` | `integer` | No | One-based result page to fetch. From 1 to 100. |
| `query` | `string` | Yes | Search query. |

### Example input

```json
{
  "limit": 60,
  "page": 1,
  "query": "used laptop"
}
```

## Response

Successful output is returned in `results[0].data`. Raw platform output is intentionally open-ended and may evolve with the upstream source.

### Illustrative sample output

This redacted fixture is an example, not a fixed response schema.

```json
{
  "placements": [
    {
      "item_id": "286865561827",
      "leaf_category": "177",
      "promoted": true,
      "rank": 0,
      "variant_id": "588893894930"
    },
    {
      "item_id": "286601719329",
      "leaf_category": "177",
      "promoted": true,
      "rank": 1,
      "variant_id": "588649223901"
    },
    {
      "item_id": "264987527030",
      "leaf_category": "177",
      "promoted": true,
      "rank": 2,
      "variant_id": "0"
    }
  ]
}
```
### Illustrative output fields

Derived from the sample above for orientation only. These fields are not a fixed response schema.

| Path | Observed type | Example |
| --- | --- | --- |
| `placements` | `array` | 3 items |
| `placements` | `array` | 3 items |

## Execution behavior

A `200` response completed inline. A `202` response was queued; poll `GET /jobs/{id}` until the job reaches `completed` or `failed`. Use an `Idempotency-Key` when retrying must not create a duplicate logical job.

## Related documentation

- [Authentication](https://docs.upscrape.com/docs/api/authentication)
- [Jobs and results](https://docs.upscrape.com/docs/api/jobs)
- [Errors and retries](https://docs.upscrape.com/docs/api/errors)
- [Idempotency](https://docs.upscrape.com/docs/api/idempotency)

POST /execute Shared execution endpoint

Input parameters

limit integer optional

Maximum number of results to return. Allowed values: `60`, `120`, `240`.

Example 60

Available values 60120240

page integer optional

One-based result page to fetch. From 1 to 100.

Example 1

query string required

Search query.

Example used laptop

Response

Successful output is returned in results[0].data. Raw platform output is intentionally open-ended and may evolve with the upstream source.

Illustrative sample The full redacted fixture is shown in the response panel.

Illustrative output fields

Derived from the sample above for orientation only. These observed fields are not a fixed response schema.

Path	Observed type	Example
`placements`	`array`	3 items
`placements`	`array`	3 items

Execution behavior

A 200 response completed inline. A 202 response was queued; poll GET /jobs/:id until the job reaches completed or failed.

curl --request POST \ --url https://data.upscrape.com/execute \ --header "Authorization: Bearer $UPSCRAPE_API_KEY" \ --header "Content-Type: application/json" \ --header "Prefer: wait=30" \ --data '{ "input": { "limit": 60, "page": 1, "query": "used laptop" }, "capability": "ebay.search.placements" }'

import json import os import requests payload = json.loads(r'''{ "input": { "limit": 60, "page": 1, "query": "used laptop" }, "capability": "ebay.search.placements" }''') response = requests.post( "https://data.upscrape.com/execute", headers={ "Authorization": f"Bearer {os.environ['UPSCRAPE_API_KEY']}", "Content-Type": "application/json", "Prefer": "wait=30", }, json=payload, ) response.raise_for_status() print(json.dumps(response.json(), indent=2))

{ "placements": [ { "item_id": "286865561827", "leaf_category": "177", "promoted": true, "rank": 0, "variant_id": "588893894930" }, { "item_id": "286601719329", "leaf_category": "177", "promoted": true, "rank": 1, "variant_id": "588649223901" }, { "item_id": "264987527030", "leaf_category": "177", "promoted": true, "rank": 2, "variant_id": "0" } ] }