Skip to main content

  • Important: Due to EU & UK Payments regulatory requirements, an additional security verification via Digital Signatures is required for certain API calls that are made by EU/UK sellers. Please refer to Digital Signatures for APIs to learn more on the impacted APIs and the process to create signature to be included in the HTTP payload.

  • OpenAPI Specification - Version 2.0 for all of our RESTful APIs will no longer be available starting April 5, 2023. We will continue leveraging OpenAPI Specification - Version 3.0 for new features in our RESTful APIs.

We designed our latest APIs based on use cases that we have carefully vetted with buyers, sellers, and application providers.

After listening to our customers, we have revamped everything, from taking a more retail-standard approach to the functional capabilities we offer to buyers and sellers; to updating the overall architecture of our APIs; to changing basic operational details that matter to developers, such as how we think about error messages and API Call Limits (rate limiting).

Buy APIs

eBay Buy API for buying, selling, general commerce and analytics.

Sell APIs

eBay Sell API for buying, selling, general commerce and analytics.

Commerce APIs

eBay Commerce API for buying, selling, general commerce and analytics.

Developer APIs

eBay Developer API for buying, selling, general commerce and analytics.

RESTful API documentation

eBay developer documentation consists of several sets of documentation. The Using eBay RESTful APIs guide sits atop all the RESTful documentation and describes how to format requests, configure the OAuth authorization needed for each request, handle errors, and more. Refer to this guide for all the details on making RESTful requests.

Each RESTful API has a complete set of reference documentation, which includes the following documentation covered in the table below:

Document Title Description
API Overview

The Overview page for an API contains:

  • A general description of the API, with details on the resources supported by the API.
  • A list of the use cases that can be addressed with the API.
  • The list of requirements and restrictions that you need to be aware of when using the API.
Release Notes Each API has a set of Release Notes that detail each major and minor release of the API.
API Reference

API reference documentation includes the following:

    • An API Resources page that shows all resources used by the API and all methods under each resource.
    • A reference page for each method in the API. Each reference page includes the following components:
      • Introduction/purpose of the method
      • Production endpoint, including descriptions of all path and query parameters
      • Information on required or optional request headers
      • Information on required OAuth scopes and access tokens
      • Details and descriptions on all request payload fields (if applicable)
      • Details and descriptions on all response payload fields (if applicable)
      • A full list of HTTP status codes and error/warning messages that may get returned in the response
      • One or more static call samples for each method
    • Type, Field, and Enumeration index pages which show all defined types, fields, and enum values for the API. These index pages are fully clickable so users can click to see the full definitions of a type, field, or enum value.
Integration Guides The Selling and Buying Integration Guides provide conceptual and how-to information for the main tasks performed by developers with selling and buying applications.