Skip to main content

GET/file

The getFiles method provides a list of the feed files available for download.

Details for each feed returned include the date the feed was generated, the frequency with which it is pulled, its feed type, its fileid, its format (currently only TSV is supported), the eBay marketplaces it applies to, the schema version under which it was generated, its size in bytes, and the time span it covers (in hours).

You can limit your search results by feed type, marketplace, scope, and eBay L1 category.

Restrictions

For a list of supported sites and other restrictions, see API Restrictions.

Input

Resource URI (production)

URI parameters

ParameterTypeDescription
feed_type_idstringThe unique identifier for the feed type.

Use the getFeedTypes method to identify the available feed types.

Note: Refer to Supported feed types to learn more about the feed types supported by the Feed API.

Occurrence: Optional

feed_scopestringSpecifies the frequency with which the feed file is made available (HOURLY, DAILY, WEEKLY).

Currently only DAILY is supported.

Occurrence: Optional

category_idsstringThis query parameter is used to specify one or more eBay L1 category IDs. If this filter is used, only feed files that are supported for the specified category (or categories) will be returned in the response. Each category ID value must be delimited by a comma.

Max: 20 values

Occurrence: Optional

look_backstringHow far back from the current time to limit the returned feed files. The returned feed files will be those generated between the current time and the look-back time.

Example: A value of 120 will limit the returned feed files to those generated in the past 2 hours (120 minutes). If 3 feed files have been generated in the past 2 hours, those 3 files will be returned. A feed file generated 4 hours earlier will not be returned.

Occurrence: Optional

limitstringThe number of records to show in the response.

Default: 20

Minimum: 20

Maximum: 100

Occurrence: Optional

continuation_tokenstringThe server returns this token to the web client when the responses received require multiple pages to display. The web client sends this token back to the server to get the next page of results.

Occurrence: Optional

HTTP request headers

All requests made to eBay REST operations require you to provide the Authorization HTTP header for authentication authorization.

The table below shows additional HTTP request headers that are either required, conditionally required, or strongly recommended for this method. Other standard HTTP request headers- opens rest request components page (not in this table) can also be used, but they are optional.

HeaderTypeDescription
X-EBAY-C-MARKETPLACE-IDstringThis is the ID of the eBay marketplace on which to search for feed files.

Example: X-EBAY-C-MARKETPLACE-ID: EBAY_US.

For a list of supported sites and other restrictions, see API Restrictions.

Occurrence: Required

OAuth scope

This request requires an access token created with the client credentials grant flow, using one or more scopes from the following list (please check your Application Keys page for a list of OAuth scopes available to your application):

https://api.ebay.com/oauth/api_scope/buy.item.feed

See OAuth access tokens for more information.

Request payload

This call has no payload.

Request fields

This call has no field definitions.

Output

HTTP response headers

This call has no response headers.

Response payload

Response fields

Output container/fieldTypeDescription
fileMetadataarray of FileMetadata

An array of metadata values describing the available feed files that match the input criteria.

Occurrence: Always

fileMetadata.accessAccessEnum

Indicates whether the application is permitted to access the feed file. One of ALLOWED or RESTRICTED.

Occurrence: Always

fileMetadata.dimensionsarray of Dimension

An array of dimensions supported by the corresponding feed file.

Currently the only dimension available is CATEGORY.

Example:
"dimensionKey": "CATEGORY",
"values": ["15032"]

Occurrence: Always

fileMetadata.dimensions.dimensionKeyDimensionKeyEnum

The key element for a value in the dimensions array, paired with its value(s). Currently, only CATEGORY (available L1 category) is available.

Occurrence: Always

fileMetadata.dimensions.valuesarray of string

The dimension value(s) paired with the dimensionKey in the dimensions array. Currently, the only supported dimension is CATEGORY, so the values in this array will be L1 eBay categories.”

Occurrence: Always

fileMetadata.feedDatestring

The date on which the feed was created.

Format: UTC format (yyyy-MM-ddThh:00:00.000Z).

Occurrence: Always

fileMetadata.feedScopeFeedScopeEnum

Specifies the frequency with which the feed file is made available (HOURLY, DAILY, WEEKLY).

Currently only DAILY is supported.

Occurrence: Always

fileMetadata.feedTypeIdstring

The unique identifier of the feed type.

Note: Refer to Supported feed types for additional details.

Occurrence: Always

fileMetadata.fileIdstring

The file's unique identifier. This fileid is used to select the feed file when using the downloadFile method.

Occurrence: Always

fileMetadata.formatFormatEnum

Format of the returned feed file. Currently only TSV is supported.

Occurrence: Always

fileMetadata.marketplaceIdMarketplaceIdEnum

The eBay marketplace identifier for the marketplace(s) to which the feed applies.

Example: EBAY_UK.

Occurrence: Always

fileMetadata.schemaVersionstring

Version of the API schema under which the feed was created.

Occurrence: Always

fileMetadata.sizeinteger

Size of the feed file in bytes.

Occurrence: Always

fileMetadata.spanTimeDuration

The time span between feed files that applies to the feed type (e.g., hourly, daily, weekly). This is returned in hours.

Possible Values: YEAR, MONTH, DAY, HOUR

Occurrence: Always

fileMetadata.span.unitTimeDurationUnitEnum

This enumeration value indicates the time unit used for the time period.

Occurrence: Always

fileMetadata.span.valueinteger

The number of units of time in the span.

Occurrence: Always

hrefstring

The URL to to the current set of results.

Occurrence: Always

limitinteger

The number of results that will be displayed on each page, as set by the limit URI parameter.

Default: 20

Occurrence: Always

nextstring

You can use this URL to retrieve the next page of results beyond those displayed on the page if there are more results that match the search criteria.

Occurrence: Conditional

totalinteger

The total number of matches for the search criteria.

Occurrence: Always

HTTP status codes

This call can return one of the following HTTP status codes. For an overview of the status codes, see HTTP status codes in Using eBay RESTful APIs.

StatusMeaning
200OK
400Bad Request
403Forbidden
500Internal Server Error

Error codes

For more on errors, plus the codes of other common errors, see Handling errors.

CodeDomainCategoryMeaning
13003API_FEEDREQUESTInvalid 'feed_scope'. Valid values: [HOURLY,DAILY,WEEKLY]
13006API_FEEDAPPLICATIONThere was a problem with an eBay internal system or process. Contact eBay developer support for assistance.
13014API_FEEDREQUESTInvalid or missing header X-EBAY-C-MARKETPLACE-ID.
14001API_FEEDREQUESTInvalid limit. Supported ranges 20 - 100.
14002API_FEEDREQUESTInvalid or expired continuation token.
14005API_FEEDREQUESTMaximum number of category_ids exceeded.Limit: 20.
14006API_FEEDREQUESTInvalid look back period for the feedType and feedScope.Please refer to documentation.
14008API_FEEDREQUESTInvalid or missing feed type Id.
14009API_FEEDREQUESTInsufficient permissions for the feed type for the specified marketplace. Please contact eBay Technical Support for further assistance.

Warnings

This call has no warnings.

Samples

New to making API calls? Please see Making a Call.

Note: Identifiers, such as order IDs or user IDs, and personal data in these samples might be anonymized or may no longer be active on eBay. If necessary, substitute current, relevant eBay data in your requests.

Sample 1: Create a List of Available Downloads

The getFiles method retrieves a list of feed files available for download. Files are grouped by feed type.

Input

The URI contains no filter. This call returns all available feeds.

Important: Unfiltered lists can be extremely large; it is best to filter by at least feed type.

GEThttps://api.ebay.com/buy/feed/v1/file

Output

A single file, test_feedapi_file.gzip, is available for download. It is a daily curated feed restricted to L1 category 1 in the Australian marketplace.