Common

4min

Common Parameters
﻿GET  /request
The following parameters are used to configure your request to the Ebay Product Data API. They should be appended as querystring parameters to a  GET HTTP request to the  /request  endpoint.
For example, to request customer reviews for the EPID  233599133856  on  ebay.com  the request would be:
HTTP
Curl
Node.js
Python
PHP
https://api.countdownapi.com/request?api_key=demo&type=reviews&ebay_domain=ebay.com&epid=233599133856
https://api.countdownapi.com/request?api_key=demo&type=reviews&ebay_domain=ebay.com&epid=233599133856
﻿
Request-Specific Parameters
Additional parameters are available depending on the type of request being made (as-determined by the  type  parameter). For example, if you make a request with  type=search  then additional Search Parameters, specific to  search  requests, are available.
﻿
Common Parameters
The following common parameters are required for all requests to the Ebay Product Data API.
Parameter
Required
Description
api_key
required
The API key for your Countdown API account.
customer_location
optional
Determines the country that Countdown API uses when retrieving pages from Ebay. This is useful, for example, for seeing details of how a product appears on ebay.com, to a customer located in a different country. Can be used to identify cross-border shipping data and opportunities.  
For more available values of customer_location please see the Customer Locations Reference . If no value for customer_location is supplied then Countdown API defaults to making the request from the country of the Ebay page requested - i.e. "France" for requests for pages from "ebay.fr".  
Certain customer_location 's can be used in combination with the customer_zipcode parameter to further refine the location of the request.
customer_zipcode
optional
Determines the specific zip or postal code used when retrieving pages from Ebay. Note that not all values of customer_location support customer_zipcode (because Ebay don't allow zipcode granularity for all countries). For information on which customer_location values support customer_zipcode please see the Customer Locations Reference .
type
required
The type of Ebay data to retrieve. The value of the type parameter determines which additional parameters are available. For example, if you make a request with type=reviews then additional Reviews Parameters , specific to reviews requests, are available.  
Valid values for type are:
search
Request search results for a search_term or Ebay search results page url . See additional Search Parameters .
﻿
product
Request product data for an epid or Ebay product page url . See additional Product Parameters .
﻿
reviews
Request customer reviews for an epid or Ebay product page url . See additional Reviews Parameters .
﻿
seller_profile
Request seller profile information for a seller_name or Ebay seller profile page url . See additional Seller Profile Parameters .
﻿
seller_feedback
Request seller feedback information for a seller_name or Ebay seller feedback page url . See additional Seller Feedback Parameters .
include_html
optional
Determines whether raw HTML is included in the response (this can increase the size of the response). Can be set to true or false (the default).  
Note When adding requests with include_html=true to a Collection the maximum number of requests is lower (100) because including the HTML within the response makes the Collection Result Sets much larger. The limit is in place to ensure Result Set files are of a manageable size. If you have need to run a large number of requests all with include_html=true then simply split the requests across multiple 100-request Collections.
output
optional
Determines the format in which results are returned. Can be set to json (default) to get the results as structured JSON, html to get the raw html retrieved or csv to return the results in CSV format. When using csv you can also use the csv_fields parameter to specify which fields to return in the CSV.
csv_fields
optional
Determines the fields that are returned when returning in csv mode (i.e. when the output parameter is set to csv ). Should be specified as a comma seperated list of fields (in nested field, dot notation, format). For more information on the csv_fields parameter please see the CSV Fields Reference .
include_fields
optional
A comma-seperated list JSON field names to include in the JSON object the API returns. You can specify the field names in dot notation - i.e. include_fields=pagination will only include the the pagination property in the response JSON. Use include_fields if you only want to include specific fields in the API's JSON response.
exclude_fields
optional
A comma-seperated list of JSON field names to exclude from the JSON object the API returns. You can specify the field names in dot notation - i.e. exclude_fields=pagination will remove the pagination property from the response JSON. Use exclude_fields if there are specific fields you wish to exclude from the API's JSON response.
﻿
Next Steps
     Search Parameters
     Reviews Parameters
     Product Parameters
     Seller Profile Parameters
     Seller Feedback Parameters﻿

Parameter	Required	Description
api_key	required	The API key for your Countdown API account.
customer_location	optional	Determines the country that Countdown API uses when retrieving pages from Ebay. This is useful, for example, for seeing details of how a product appears on ebay.com, to a customer located in a different country. Can be used to identify cross-border shipping data and opportunities. For more available values of customer_location please see the Customer Locations Reference . If no value for customer_location is supplied then Countdown API defaults to making the request from the country of the Ebay page requested - i.e. "France" for requests for pages from "ebay.fr". Certain customer_location 's can be used in combination with the customer_zipcode parameter to further refine the location of the request.
customer_zipcode	optional	Determines the specific zip or postal code used when retrieving pages from Ebay. Note that not all values of customer_location support customer_zipcode (because Ebay don't allow zipcode granularity for all countries). For information on which customer_location values support customer_zipcode please see the Customer Locations Reference .
type	required	The type of Ebay data to retrieve. The value of the type parameter determines which additional parameters are available. For example, if you make a request with type=reviews then additional Reviews Parameters , specific to reviews requests, are available. Valid values for type are: search Request search results for a search_term or Ebay search results page url . See additional Search Parameters . product Request product data for an epid or Ebay product page url . See additional Product Parameters . reviews Request customer reviews for an epid or Ebay product page url . See additional Reviews Parameters . seller_profile Request seller profile information for a seller_name or Ebay seller profile page url . See additional Seller Profile Parameters . seller_feedback Request seller feedback information for a seller_name or Ebay seller feedback page url . See additional Seller Feedback Parameters .
include_html	optional	Determines whether raw HTML is included in the response (this can increase the size of the response). Can be set to true or false (the default). Note When adding requests with include_html=true to a Collection the maximum number of requests is lower (100) because including the HTML within the response makes the Collection Result Sets much larger. The limit is in place to ensure Result Set files are of a manageable size. If you have need to run a large number of requests all with include_html=true then simply split the requests across multiple 100-request Collections.
output	optional	Determines the format in which results are returned. Can be set to json (default) to get the results as structured JSON, html to get the raw html retrieved or csv to return the results in CSV format. When using csv you can also use the csv_fields parameter to specify which fields to return in the CSV.
csv_fields	optional	Determines the fields that are returned when returning in csv mode (i.e. when the output parameter is set to csv ). Should be specified as a comma seperated list of fields (in nested field, dot notation, format). For more information on the csv_fields parameter please see the CSV Fields Reference .
include_fields	optional	A comma-seperated list JSON field names to include in the JSON object the API returns. You can specify the field names in dot notation - i.e. include_fields=pagination will only include the the pagination property in the response JSON. Use include_fields if you only want to include specific fields in the API's JSON response.
exclude_fields	optional	A comma-seperated list of JSON field names to exclude from the JSON object the API returns. You can specify the field names in dot notation - i.e. exclude_fields=pagination will remove the pagination property from the response JSON. Use exclude_fields if there are specific fields you wish to exclude from the API's JSON response.

Updated 07 Aug 2024

Did this page help you?

Pagination