All URIs are relative to https://scrapebadger.com, except if the operation defines another base path.
| Method | HTTP request | Description |
|---|---|---|
| ebayBrowseACategory() | GET /v1/ebay/categories/{category_id}/items | Browse a category |
| ebayCompletedSoldListings() | GET /v1/ebay/completed | Completed / sold listings |
| ebayEbayScraperHealthCheck() | GET /v1/ebay/health | eBay scraper health check |
| ebayEbayScraperHealthCheckHead() | HEAD /v1/ebay/health | eBay scraper health check |
| ebayGetItemDetail() | GET /v1/ebay/items/{item_id} | Get item detail |
| ebayGetItemReviews() | GET /v1/ebay/items/{item_id}/reviews | Get item reviews |
| ebayGetSellerFeedback() | GET /v1/ebay/sellers/{username}/feedback | Get seller feedback |
| ebayGetSellerListings() | GET /v1/ebay/sellers/{username}/items | Get seller listings |
| ebayGetSellerProfile() | GET /v1/ebay/sellers/{username} | Get seller profile |
| ebayKeywordSuggestions() | GET /v1/ebay/autocomplete | Keyword suggestions |
| ebayListCategories() | GET /v1/ebay/categories | List categories |
| ebayListMarkets() | GET /v1/ebay/markets | List markets |
| ebaySearchByImage() | POST /v1/ebay/search/by-image | Search by image |
| ebaySearchListings() | GET /v1/ebay/search | Search listings |
ebayBrowseACategory($category_id, $domain, $page, $per_page, $sort_by, $min_price, $max_price): mixedBrowse a category
List active listings within an eBay category.
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure API key authorization: ApiKeyAuth
$config = ScrapeBadger\Configuration::getDefaultConfiguration()->setApiKey('X-API-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = ScrapeBadger\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-Key', 'Bearer');
$apiInstance = new ScrapeBadger\Api\EBayApi(
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
// This is optional, `GuzzleHttp\Client` will be used as default.
new GuzzleHttp\Client(),
$config
);
$category_id = 'category_id_example'; // string
$domain = 'com'; // string
$page = 1; // int
$per_page = 56; // int
$sort_by = 'best_match'; // string | best_match|ending_soonest|newly_listed|price_low_to_high|price_high_to_low
$min_price = 3.4; // float
$max_price = 3.4; // float
try {
$result = $apiInstance->ebayBrowseACategory($category_id, $domain, $page, $per_page, $sort_by, $min_price, $max_price);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling EBayApi->ebayBrowseACategory: ', $e->getMessage(), PHP_EOL;
}| Name | Type | Description | Notes |
|---|---|---|---|
| category_id | string | ||
| domain | string | [optional] [default to 'com'] | |
| page | int | [optional] [default to 1] | |
| per_page | int | [optional] | |
| sort_by | string | best_match | ending_soonest |
| min_price | float | [optional] | |
| max_price | float | [optional] |
mixed
- Content-Type: Not defined
- Accept:
application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
ebayCompletedSoldListings($query, $domain, $category_id, $page, $per_page, $sort_by, $condition, $min_price, $max_price, $location, $language): mixedCompleted / sold listings
Search completed/sold listings — eBay's sold-price history. eBay pads a short result set with "results matching fewer words" and counts only the exact ones in pagination.total_results. Results come back in eBay's own ranking order with the exact matches first, and each one carries exact_match (true/false) so a price series can be built without parsing titles. An empty results with total_results: 0 is eBay's own answer and costs 0 credits — a fetch failure is never a 200.
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure API key authorization: ApiKeyAuth
$config = ScrapeBadger\Configuration::getDefaultConfiguration()->setApiKey('X-API-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = ScrapeBadger\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-Key', 'Bearer');
$apiInstance = new ScrapeBadger\Api\EBayApi(
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
// This is optional, `GuzzleHttp\Client` will be used as default.
new GuzzleHttp\Client(),
$config
);
$query = 'query_example'; // string | Search keywords
$domain = 'com'; // string | Marketplace domain (com, co.uk, de …)
$category_id = 'category_id_example'; // string | Restrict to a category id
$page = 1; // int
$per_page = 56; // int | 60, 120 or 240
$sort_by = 'best_match'; // string | best_match|ending_soonest|newly_listed|price_low_to_high|price_high_to_low
$condition = 'condition_example'; // string | new|open_box|refurbished|used|for_parts|graded|ungraded
$min_price = 3.4; // float
$max_price = 3.4; // float
$location = 'location_example'; // string | domestic|worldwide
$language = 'language_example'; // string | english|japanese|chinese|korean
try {
$result = $apiInstance->ebayCompletedSoldListings($query, $domain, $category_id, $page, $per_page, $sort_by, $condition, $min_price, $max_price, $location, $language);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling EBayApi->ebayCompletedSoldListings: ', $e->getMessage(), PHP_EOL;
}| Name | Type | Description | Notes |
|---|---|---|---|
| query | string | Search keywords | |
| domain | string | Marketplace domain (com, co.uk, de …) | [optional] [default to 'com'] |
| category_id | string | Restrict to a category id | [optional] |
| page | int | [optional] [default to 1] | |
| per_page | int | 60, 120 or 240 | [optional] |
| sort_by | string | best_match | ending_soonest |
| condition | string | new | open_box |
| min_price | float | [optional] | |
| max_price | float | [optional] | |
| location | string | domestic | worldwide |
| language | string | english | japanese |
mixed
- Content-Type: Not defined
- Accept:
application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
ebayEbayScraperHealthCheck(): mixedeBay scraper health check
Check health of the eBay scraper service (accepts HEAD for UptimeRobot).
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure API key authorization: ApiKeyAuth
$config = ScrapeBadger\Configuration::getDefaultConfiguration()->setApiKey('X-API-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = ScrapeBadger\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-Key', 'Bearer');
$apiInstance = new ScrapeBadger\Api\EBayApi(
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
// This is optional, `GuzzleHttp\Client` will be used as default.
new GuzzleHttp\Client(),
$config
);
try {
$result = $apiInstance->ebayEbayScraperHealthCheck();
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling EBayApi->ebayEbayScraperHealthCheck: ', $e->getMessage(), PHP_EOL;
}This endpoint does not need any parameter.
mixed
- Content-Type: Not defined
- Accept:
application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
ebayEbayScraperHealthCheckHead(): mixedeBay scraper health check
Check health of the eBay scraper service (accepts HEAD for UptimeRobot).
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure API key authorization: ApiKeyAuth
$config = ScrapeBadger\Configuration::getDefaultConfiguration()->setApiKey('X-API-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = ScrapeBadger\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-Key', 'Bearer');
$apiInstance = new ScrapeBadger\Api\EBayApi(
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
// This is optional, `GuzzleHttp\Client` will be used as default.
new GuzzleHttp\Client(),
$config
);
try {
$result = $apiInstance->ebayEbayScraperHealthCheckHead();
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling EBayApi->ebayEbayScraperHealthCheckHead: ', $e->getMessage(), PHP_EOL;
}This endpoint does not need any parameter.
mixed
- Content-Type: Not defined
- Accept:
application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
ebayGetItemDetail($item_id, $domain): mixedGet item detail
Get a single eBay listing's full detail.
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure API key authorization: ApiKeyAuth
$config = ScrapeBadger\Configuration::getDefaultConfiguration()->setApiKey('X-API-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = ScrapeBadger\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-Key', 'Bearer');
$apiInstance = new ScrapeBadger\Api\EBayApi(
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
// This is optional, `GuzzleHttp\Client` will be used as default.
new GuzzleHttp\Client(),
$config
);
$item_id = 'item_id_example'; // string
$domain = 'com'; // string
try {
$result = $apiInstance->ebayGetItemDetail($item_id, $domain);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling EBayApi->ebayGetItemDetail: ', $e->getMessage(), PHP_EOL;
}| Name | Type | Description | Notes |
|---|---|---|---|
| item_id | string | ||
| domain | string | [optional] [default to 'com'] |
mixed
- Content-Type: Not defined
- Accept:
application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
ebayGetItemReviews($item_id, $domain, $page): mixedGet item reviews
Get catalog product reviews shown on an eBay listing.
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure API key authorization: ApiKeyAuth
$config = ScrapeBadger\Configuration::getDefaultConfiguration()->setApiKey('X-API-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = ScrapeBadger\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-Key', 'Bearer');
$apiInstance = new ScrapeBadger\Api\EBayApi(
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
// This is optional, `GuzzleHttp\Client` will be used as default.
new GuzzleHttp\Client(),
$config
);
$item_id = 'item_id_example'; // string
$domain = 'com'; // string
$page = 1; // int
try {
$result = $apiInstance->ebayGetItemReviews($item_id, $domain, $page);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling EBayApi->ebayGetItemReviews: ', $e->getMessage(), PHP_EOL;
}| Name | Type | Description | Notes |
|---|---|---|---|
| item_id | string | ||
| domain | string | [optional] [default to 'com'] | |
| page | int | [optional] [default to 1] |
mixed
- Content-Type: Not defined
- Accept:
application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
ebayGetSellerFeedback($username, $domain, $page): mixedGet seller feedback
Get a seller's recent feedback comments.
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure API key authorization: ApiKeyAuth
$config = ScrapeBadger\Configuration::getDefaultConfiguration()->setApiKey('X-API-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = ScrapeBadger\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-Key', 'Bearer');
$apiInstance = new ScrapeBadger\Api\EBayApi(
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
// This is optional, `GuzzleHttp\Client` will be used as default.
new GuzzleHttp\Client(),
$config
);
$username = 'username_example'; // string
$domain = 'com'; // string
$page = 1; // int
try {
$result = $apiInstance->ebayGetSellerFeedback($username, $domain, $page);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling EBayApi->ebayGetSellerFeedback: ', $e->getMessage(), PHP_EOL;
}| Name | Type | Description | Notes |
|---|---|---|---|
| username | string | ||
| domain | string | [optional] [default to 'com'] | |
| page | int | [optional] [default to 1] |
mixed
- Content-Type: Not defined
- Accept:
application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
ebayGetSellerListings($username, $domain, $query, $page, $per_page): mixedGet seller listings
List the active listings of a single eBay seller.
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure API key authorization: ApiKeyAuth
$config = ScrapeBadger\Configuration::getDefaultConfiguration()->setApiKey('X-API-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = ScrapeBadger\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-Key', 'Bearer');
$apiInstance = new ScrapeBadger\Api\EBayApi(
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
// This is optional, `GuzzleHttp\Client` will be used as default.
new GuzzleHttp\Client(),
$config
);
$username = 'username_example'; // string
$domain = 'com'; // string
$query = 'query_example'; // string
$page = 1; // int
$per_page = 56; // int
try {
$result = $apiInstance->ebayGetSellerListings($username, $domain, $query, $page, $per_page);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling EBayApi->ebayGetSellerListings: ', $e->getMessage(), PHP_EOL;
}| Name | Type | Description | Notes |
|---|---|---|---|
| username | string | ||
| domain | string | [optional] [default to 'com'] | |
| query | string | [optional] | |
| page | int | [optional] [default to 1] | |
| per_page | int | [optional] |
mixed
- Content-Type: Not defined
- Accept:
application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
ebayGetSellerProfile($username, $domain): mixedGet seller profile
Get an eBay seller's public profile.
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure API key authorization: ApiKeyAuth
$config = ScrapeBadger\Configuration::getDefaultConfiguration()->setApiKey('X-API-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = ScrapeBadger\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-Key', 'Bearer');
$apiInstance = new ScrapeBadger\Api\EBayApi(
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
// This is optional, `GuzzleHttp\Client` will be used as default.
new GuzzleHttp\Client(),
$config
);
$username = 'username_example'; // string
$domain = 'com'; // string
try {
$result = $apiInstance->ebayGetSellerProfile($username, $domain);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling EBayApi->ebayGetSellerProfile: ', $e->getMessage(), PHP_EOL;
}| Name | Type | Description | Notes |
|---|---|---|---|
| username | string | ||
| domain | string | [optional] [default to 'com'] |
mixed
- Content-Type: Not defined
- Accept:
application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
ebayKeywordSuggestions($query, $domain): mixedKeyword suggestions
Return eBay keyword autocomplete suggestions.
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure API key authorization: ApiKeyAuth
$config = ScrapeBadger\Configuration::getDefaultConfiguration()->setApiKey('X-API-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = ScrapeBadger\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-Key', 'Bearer');
$apiInstance = new ScrapeBadger\Api\EBayApi(
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
// This is optional, `GuzzleHttp\Client` will be used as default.
new GuzzleHttp\Client(),
$config
);
$query = 'query_example'; // string | Partial query prefix
$domain = 'com'; // string
try {
$result = $apiInstance->ebayKeywordSuggestions($query, $domain);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling EBayApi->ebayKeywordSuggestions: ', $e->getMessage(), PHP_EOL;
}| Name | Type | Description | Notes |
|---|---|---|---|
| query | string | Partial query prefix | |
| domain | string | [optional] [default to 'com'] |
mixed
- Content-Type: Not defined
- Accept:
application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
ebayListCategories(): mixedList categories
List eBay's top-level category ids.
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure API key authorization: ApiKeyAuth
$config = ScrapeBadger\Configuration::getDefaultConfiguration()->setApiKey('X-API-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = ScrapeBadger\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-Key', 'Bearer');
$apiInstance = new ScrapeBadger\Api\EBayApi(
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
// This is optional, `GuzzleHttp\Client` will be used as default.
new GuzzleHttp\Client(),
$config
);
try {
$result = $apiInstance->ebayListCategories();
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling EBayApi->ebayListCategories: ', $e->getMessage(), PHP_EOL;
}This endpoint does not need any parameter.
mixed
- Content-Type: Not defined
- Accept:
application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
ebayListMarkets(): mixedList markets
List all supported eBay marketplaces.
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure API key authorization: ApiKeyAuth
$config = ScrapeBadger\Configuration::getDefaultConfiguration()->setApiKey('X-API-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = ScrapeBadger\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-Key', 'Bearer');
$apiInstance = new ScrapeBadger\Api\EBayApi(
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
// This is optional, `GuzzleHttp\Client` will be used as default.
new GuzzleHttp\Client(),
$config
);
try {
$result = $apiInstance->ebayListMarkets();
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling EBayApi->ebayListMarkets: ', $e->getMessage(), PHP_EOL;
}This endpoint does not need any parameter.
mixed
- Content-Type: Not defined
- Accept:
application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
ebaySearchByImage($request_body): mixedSearch by image
Search active listings by image, the way eBay's camera icon does. No sort_by: eBay ignores it on a visual results page.
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure API key authorization: ApiKeyAuth
$config = ScrapeBadger\Configuration::getDefaultConfiguration()->setApiKey('X-API-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = ScrapeBadger\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-Key', 'Bearer');
$apiInstance = new ScrapeBadger\Api\EBayApi(
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
// This is optional, `GuzzleHttp\Client` will be used as default.
new GuzzleHttp\Client(),
$config
);
$request_body = NULL; // array<string,mixed>
try {
$result = $apiInstance->ebaySearchByImage($request_body);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling EBayApi->ebaySearchByImage: ', $e->getMessage(), PHP_EOL;
}| Name | Type | Description | Notes |
|---|---|---|---|
| request_body | array<string,mixed> |
mixed
- Content-Type:
application/json - Accept:
application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
ebaySearchListings($query, $domain, $category_id, $page, $per_page, $sort_by, $condition, $buying_format, $min_price, $max_price, $free_shipping, $location, $language): mixedSearch listings
Search an eBay marketplace for active listings.
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure API key authorization: ApiKeyAuth
$config = ScrapeBadger\Configuration::getDefaultConfiguration()->setApiKey('X-API-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = ScrapeBadger\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-Key', 'Bearer');
$apiInstance = new ScrapeBadger\Api\EBayApi(
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
// This is optional, `GuzzleHttp\Client` will be used as default.
new GuzzleHttp\Client(),
$config
);
$query = 'query_example'; // string | Search keywords
$domain = 'com'; // string | Marketplace domain (com, co.uk, de …)
$category_id = 'category_id_example'; // string | Restrict to a category id
$page = 1; // int
$per_page = 56; // int | 60, 120 or 240
$sort_by = 'best_match'; // string | best_match|ending_soonest|newly_listed|price_low_to_high|price_high_to_low
$condition = 'condition_example'; // string | new|open_box|refurbished|used|for_parts|graded|ungraded
$buying_format = 'buying_format_example'; // string | auction|buy_it_now|best_offer
$min_price = 3.4; // float
$max_price = 3.4; // float
$free_shipping = false; // bool
$location = 'location_example'; // string | domestic|worldwide
$language = 'language_example'; // string | english|japanese|chinese|korean
try {
$result = $apiInstance->ebaySearchListings($query, $domain, $category_id, $page, $per_page, $sort_by, $condition, $buying_format, $min_price, $max_price, $free_shipping, $location, $language);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling EBayApi->ebaySearchListings: ', $e->getMessage(), PHP_EOL;
}| Name | Type | Description | Notes |
|---|---|---|---|
| query | string | Search keywords | |
| domain | string | Marketplace domain (com, co.uk, de …) | [optional] [default to 'com'] |
| category_id | string | Restrict to a category id | [optional] |
| page | int | [optional] [default to 1] | |
| per_page | int | 60, 120 or 240 | [optional] |
| sort_by | string | best_match | ending_soonest |
| condition | string | new | open_box |
| buying_format | string | auction | buy_it_now |
| min_price | float | [optional] | |
| max_price | float | [optional] | |
| free_shipping | bool | [optional] [default to false] | |
| location | string | domestic | worldwide |
| language | string | english | japanese |
mixed
- Content-Type: Not defined
- Accept:
application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]