Skip to content

frequently asked questions

Find answers to commonly asked questions about the eBay Developers Program.

Click on a question to find the answer to that question.

Skip to a section:
Membership, Joining, Fees, Compatible Application Check, Getting Started, Technical, API Functionality, Solutions Directory, Affiliate Program

Developers Program Membership

  1. What is the eBay Developers Program?
    The eBay Developers Program is a program dedicated to helping 3rd parties integrate their businesses with the eBay Platform. As a member of the Developers Program, you can create custom applications that effectively and efficiently handle almost all types of business transactions on eBay.
  2. What is the Developers Program Membership?

    Developer Program Membership

    Developer Membership is designed for people who want to develop applications on the eBay Platform. These applications can be used for selling, buying, searching, managing listings and creating cool ways to do just about anything on eBay. When you join the program, you agree to specific terms and conditions contained in the API License Agreement and agree to abide by eBay Site Policies. This way applications built for eBay users follow a common standard. It is free to join the eBay Developers Program.

  3. Can you help me estimate my API call volume?
    Typically, we find that seller management tools use approximately three or four API calls for every item listed (over the duration of the item listing). Merchants using the API for their own selling typically use one to two API calls per item listing. These numbers are given as examples and actual usage may vary.
  4. What is included with eBay Developers Program Membership?
    The eBay Developers Program provides a full suite of technical resources on our website. It contains:
    • Technical documentation, sample code, our Software Development Kits (SDKs)
    • Tools and starter guides for building and vetting your application
    • Community resources such as online forums, newsletters, and training events
    • Access to our fee-based Live Help service
  5. How do I get aggregated data on closed auctions?
    You cannot use the API to search closed listings. You need to join the eBay Market Data Program to access historical transaction data on eBay.
  6. What is the significance of "Developer - pre-Compatible Application Check"?
    This title refers to an individual who has joined the eBay Developers Program and has not gone through the process of Compatible Application Check for his or her application.
  7. What is the significance of "Developer - Compatible Application Check"?
    This title refers to an individual who has joined the eBay Developers Program and has completed Compatible Application Check for his or her application(s).

Joining the Developers Program

  1. I'm ready to join the Developers Program, how do I begin the process?
    Just Join!
  2. Is it possible for non-US based entities to take part in the Developers Program?
    Yes. Any company interacting with the US, French, German or UK Sites, may join using the online clickthru API license. If you wish to interact with one of the other sites, your membership may be coordinated through the local eBay office. Please post a message in our International Development Forum if you want to list on other eBay sites.
  3. What do I do to get started in the program?

    Follow the steps in the Quick Start.

  4. Do you have a list of Developers Program members that I can contract to build my application?
    Check out our Solutions Directory for a list of companies. Besides a variety of pre-written solutions that may solve your problem, be sure to check out the "Custom Software Development Services" and "Integration Adapters" categories if you require custom work.
  5. I joined at the Individual or one of the Commercial Tier membership levels; what are my membership benefits now?
    On November 14, 2005 eBay announced changes to the membership tiers and benefits. All members are simply considered Developers now. Please see the Benefits and Fees Chart for details. However, If you joined at a Commercial Membership, your default number of Solutions Directory listings have been carried over to the new model
  6. Can I build a tool that enables sellers to embed video in their View Item pages?
    According to eBay policy, sellers may only embed video from approved third parties. We are not currently considering new applications for approval.

Developers Program Fees

  1. How can I distribute a desktop application without my customers exceeding my 5,000 calls per day limit?
    After you retrieve your rate limited production keys for your application, you are allowed to make 5,000 Production API calls per day. This is enough for most personal use; however, if you want to redistribute your program to many users, please go through the Compatible Application Check process. After you sucessfully complete this review, your keys will be modified to limit API calls on a per user basis, so your users will not run into the 5,000 call cap.
  2. What are the fees and when do I have to pay them?

    As of November 14, 2005, we no longer charge membership fees. However, other services such as Developer Technical Support, Certified Provider Program, Market Data Program and 3rd Party Checkout have fees associated with them. Please refer to Member Benefits and Feesfor a summary of services available.

  3. I received an invoice. Where do I send my payment?

    Even though we have made many services in the eBay Developers Program free as of Nov 14, 2005, some developers will still receive invoices for 3rd Party Checkout annual fee.

    Payment Options are as follows:

    Check or Money Order can be sent to:

    eBay API Accounting
    eBay, Inc.
    P.O. Box 5819
    San Jose, CA 95150

    You can also pay with PayPal or via Electronic Funds Transfer.

    PayPal Payment

    If you do not have a PayPal account, sign up now.

    • Log in to your PayPal account and click the 'Send Money' tab.
    • Recipient's Email = eBayAPI-Invoice@ebay.com
    • Amount = amount on your invoice
    • Currency = currency indicated on your invoice
    • Type = Service
    • Subject = your INVOICE NUMBER

    IMPORTANT: your INVOICE NUMBER in the Subject ensures your account will be appropriately credited with your payment

    Pay with Electronic Funds Transfer (EFT)

    Use the following account information:
    eBay API Accounting eBay, Inc. P.O. Box 5819 San Jose, CA 95150
    Tel: 408-376-7400 / Fax: 408-376-7401
    Taxpayer ID: 77-0430924
    SWIFT code: WFBIUS6S
    Bank name: Wells Fargo Bank
    Bank location: 101 N. Philips Ave., Sioux Falls, SD 57104-0000
    Bank account name: eBay Inc.
    Bank account number / IBAN: 4375-655628
    Routing/ABA number: 121000248

    Originators, please add "API Payment" and any other specific description or details so that we are able to identify the wire. The additional information will be available to us on our notice of accounting credit.

  4. Am I charged for eBay fees when making API calls in the Sandbox, the testing environment?
    API calls are free and have avery high rate limit in the Sandbox. Additionally, you are not charged any eBay fees, including listing fees and final value fees when testing your work flows in the Sandbox.
  5. What is the cost to take my application live?
    Nothing. It is free to use eBay Web Services in the Sandbox and in Production.
  6. What do I get billed for and why?

    Currenly we only bill or send invoices for the 3rd Party Checkout annual fee

    If you want to know where to send in your payment, please go to FAQ , Where Do I Send Payment?

    If you have questions about your invoice, please send an email to API-Billing@ebay.com

  7. How can I monitor my monthly API Call Usage?

    Developers can use the API Usage Report or the GetApiAccessRules (API call) to find out their usage.

    The daily API call limit is for one calendar day (PST). For example, if a developer joins the eBay Developers Program and retrieves their production keys to get 5,000 API calls (excluding AddItem and RelistItem) in the middle of a day, this developer will still get 5,000 API calls for remainder of that day based on Pacific Standard Time.

Compatible Application Check

  1. What is Compatible Application Check?

    Compatible Application Check is a process in which you submit to eBay a form describing your application and its usage of eBay Web services. This form is then reviewed by eBay's Developer Technical Support engineers. After the process is complete, your application may be granted a higher call limit than the standard 5,000 calls per day (excluding AddItem and RelistItem). The Compatible Application Check process exists to ensure the highest standards for API-enabled applications, including:

    • Compliance with API License Agreement. All API applications must adhere to certain restrictions with regard to the usage, look and feel of the application.
    • Efficient use of the API calls. Unlike desktop operating systems, the API environment is shared with other applications and to some extent, eBay's users as well. As such, we need to ensure no application acts in a manner that is detrimental to eBay.

    Compatible Application Check is not used to qualify the functionality of your application. Instead, Compatible Application Check is focused solely on the parts of the application that call the API and/or displays eBay content.

  2. How long does it usually take to complete Compatible Application Check?

    Typically, the Compatible Application Check process takes between 5-7 business days. Additional time may be required for complex or lengthy applications.

    Read more about Compatible Application Check here.
  3. What are the Compatible Application Check requirements?
    Read all about the requirements on the Compatible Application Check homepage.
  4. How do I make calls against live eBay data?
    There is no monetary cost to taking your application live; however, you will need follow a few steps to gain access to the production environment. Checkout the Quick Start Guide for these steps. Additionally, go to the href="/support/certification/">Compatible Applcation Check for the Prerequisites for Going Live and Best Practices before you develop your application.
  5. What are my API call limits? Can they be altered?

    You have essentially unlimited calls available to you in the Sandbox.

    In Production, you are given a limit of 5,000 API calls per day once you retrieve your production keys. This is an application limit and does not vary based on the number of users you have. We believe this amount of calls is sufficient for most individuals using a single application.

    However, we recognize that many developers will either need a higher API call limit and/or want to distribute their applications, or otherwise share them with many eBay users. These people should go through our Compatible Application Check process.

    After successfully completing this free-of-charge Check, your application will be rate-limited on an application basis or a per-user basis depending on your customer base and distribution format. Application-based call limits mean that your application will have a maximum API call cap on a daily and monthly basis. The user-based call limits mean that each user of your application gets their own pool of API calls. One person's usage does not affect another's, so as many people can use your program as you'd like. When you go through Compatible Application Check your call limits will be determined and communicated to you by the Developer Technical Support staff.

    Learn more about Compatible Application Check .

Getting Started

  1. I'm having difficulties getting the token. What did I do wrong?

    You are probably trying to create a token for the Sandbox, our testing environment. To be able to do that you will need a Sandbox user ID (like your real eBay ID but for the Sandbox). You can sign up here or use the Sandbox User Registration Tool. The flow is the same as on the production site. If you use that ID you will be able to create your token.

    You may want to check out the Quick Start Guide .

  2. Where can I find sample code?
    Sample code is available in our Community Codebase. If you want to contribute new samples, you can do so through the code samples project.
  3. Can I suggest FAQ's?
    Sure. We are happy to create new FAQ's with helpful answers. The best way to start is to post your solution to Forums on this site. We Forums on a consistent basis and will post helpful answers to FAQs.
  4. Contact Market Data
    The contact information as well as all the questions you should answer in your email are written on the following page http://developer.ebay.com/programs/marketdata/contact/.
  5. Which User ID Do I Use Where?

    Developers Program User ID: Get one now.

    eBay User ID: Get one now.

    Sandbox User ID: Get one now. You may want to create multiple Sandbox User IDs if you are if you are testing for buyers and sellers.

  6. Are you having problems accessing Developer Live Help support?

    Are you having problems accessing Developer Live Help support?

    Except for certain holidays and outage periods, Developer Live Help is available during the business hours of 9 a.m. to 5 p.m. Pacific Time, Monday through Friday. To find out the current Live Help schedule:

    1. Go to Developer Support.
    2. Select your name from the drop-down menu and enter Live Chat.
    3. Live Chat hours are published on the Live Help tab.

    No email addresses appear in the drop-down list for support access or Can not find valid contact for your account.

    Our support system requires uniqueness for email addresses. If you do not see any email addresses in the drop-down menu, the primary email address for your company most likely already exists in our system. You may have previously registered for a developer account using the same email address. You have two options:

    Use a new email address:

    1. Edit Membership Info for your current Developers Program account and set the email address in your contact info to the new value you would like to use.
    2. Now go back to Developer Live Help support and see if your email address appears in the drop-down.

    Use a previously used email address:

    1. Edit Membership Info for your old Developers Program account and change the email address in your contact info to a different value.
    2. Edit Membership Info for your current Developers Program account and set the primary email address in your contact info to the value you would like to use.
    3. Now go back to Developer Live Help support and see if your email address appears in the drop down.

    I see other email addresses, but my specific email address does not appear in the drop-down list for support access.

    Make sure that a contact exists for you in your company account with the email address you would like to use. Our support system requires uniqueness for email addresses. Therefore, if you have previously registered for an eBay Developers Program account using the same email address, please do not use the same address again. If you would like to use the same address, follow the steps above entitled "No email addresses appear in the drop-down list for support access" to remedy the situation.

    To create a new contact:

    1. Edit Membership Info for your Developers Program account and click on "Add New Contact."
    2. Now go back to Developer Live Help support and see if your email address appears in the drop-down.

    To update an existing contact:

    1. Edit Membership Info for your Developers Program account and click on your contact record.
    2. Check the email address and set to the value you would like to use. (The email address must not be previously used)
    3. Now go back to Developer Live Help support and see if your email address appears in the drop-down.

    I am still having problems

    If you are still having problems, please email developer-support@ebay.com with details including your company name, contact name, and email address and we will work with you to remedy the situation.

  7. What are API Rate Limits and why do we have them?

    What is an API call limit?

    eBay sets the number of API calls an application or eBay user can make. Once the API call limit is reached, all subsequent API calls are blocked and will result in an error.

    Why does eBay have API Call Limits?

    eBay sets API call rate limits for various reasons; however, the primary reason are:

    • To protect our systems so the platform is available to all users 24/7 365 days a year.
    • To encourage efficient use of API calls.

    Want more details?

    There are two events which set your production API call limits:

    • When a developer completes Self Certification and retrieves production keys, the keys are set to a maximum of 5,000 API calls per day in the production environment.
    • When a developer completes Compatible Application Check, the rate limit for the production keys is increased significantly.

    Depending on the type of application you are certifying, you may be rate limited by application or by User ID.

    For web-based applications, an application based rate limit may be most appropriate. In this case, you may receive up to 1,500,000 API calls per day

    For applications that are client based (i.e. given to users and run on the desktop) or have large distributions, it is likely that a User ID base rate limit will drive the optimal efficiency. In this case, every eBay User ID can make up to 20,000 calls per day. Note: this limit actually applies on a per-User ID basis, not on a per application basis. So, a person will be able to make up to 20,000 calls in aggregate from all the applications they are using that are User ID limited.

    The type of rate limit assigned to an application is determined based on application type during Compatible Application Check.

    All API calls that exceed the assigned application or User ID call limits will be blocked. Note: eBay may increase or decrease the number of API calls you may make at eBay's sole discretion. Will generally occur to ensure platform stability.

Technical

  1. Is there a development and/or test environment included with membership in the Developers Program?
    Yes. We offer a development Sandbox, a duplicate of eBay that uses test data so Developer Program members can build and test new applications. It behaves like the eBay API production servers but does not in any way impact the production data or community.See the for What features are supported in the Sandbox? and Unsupported features list for the Sandbox
  2. Will the API allow me to push data to my application based on predetermined events?
    The API does not push data to an application. It is a pull-only interface. However, the Developers Program also offers Platform Notifications. Platform Notifications make an HTTP or SMTP request to a URL that you specify when certain events, such as an auction ending or a buyer leaving feedback, occur.
  3. What kind of technical support does eBay provide?

    eBay offers a suite of free resources including Developer Forums, technical documentation, SDKs for Windows and Java, and more. In addition, Developer Technical Support (DTS) is available on a fee-basis for all members.

    Developer Technical Support is offered at $75 per hour. A Jumpstart package can be purchased for $250 for 4 hours of support.

  4. Where can I find more information about Auth&Auth?

    Here is a good link.

    If you have any further questions, please follow up in our member Forums where we offer a special Tech Soup board for members to discuss issues like Auth & Auth.

  5. What is eBay Web Services?

    The eBay Web Services Application Programming Interface (API) is the means through which third-party developers can create applications to conduct business with the eBay Platform.

    Our API is a set of functions called through the HTTP transport protocol. Information is sent and received using a standard XML data format. A member of the Developers Program designs an application at their local site that uses the API. This local application can be in any programming language capable of issuing data requests via the Internet. eBay users run the local application to conduct auctions, leave feedback, manage their eBay stores, etc.

    The local application calls the API functions to send information to and request information from the eBay Platform. In sending and getting this information, the end-user is able to conduct business in essentially the same way as through the eBay interface.

  6. Is an API call a request for a single piece of data or can a single call retrieve multiple pieces of information?

    There are three different types of API function calls, they are:

    1. A single API call can return a single piece of data, such as the eBay Official Time.
    2. A single API call can return set of data associated with an object, such as the User object. This type of call could obtain multiple pieces of information about a single user, such as eBay User ID, email address and payment address.
    3. A single API call can return a set of data associated with a collection of objects. This type of call could obtain information about multiple auctions and all the data associated with each auction.
  7. Will the API work in conjunction with my third party payment processor?

    A certain level of integration between the eBay platform and your application for "checkout" can be achieved. The API can be used to retrieve transaction information and then provide that information to pre-populate your checkout or payment processing service. Your users would simply need to be directed to the appropriate checkout or payment services via email at the end of auction.

    We also offer an "integrated checkout" solution known as "Third Party Checkout" where your payment service would display to the user at the end of auction. This is only available to developers who pay an additional fee.

  8. Are there any regular eBay functions not available through the API?

    Some features exist on the eBay.com website that are not available through the API. Your users must perform these functions directly on the eBay site instead of through your application:

    • Creating an eBay User ID
    • Final value fee refunds
    • Non-paying bidder processing; however, we do provide API support for Unpaid Item (UPI)disputes.
  9. Does access to the API include access to Half.com data?

    Yes. For more details, see the "Working with Half.com Listings" section of our XML API documentation.

  10. Why would I use an SDK?

    There are four main reasons to use an eBay SDK:

    1. Simplify the development process by supplying "out-of-the-box" functionality for features and processes that otherwise you would have to build.
    2. Enhance existing applications with additional functionality such as payment processing, fulfillment and inventory management.
    3. Integrate with the latest eBay features and services through regularly updated components and free upgrades.
    4. Cut time to market for new applications by using components developed and tested by eBay.

    We have two SDKs: one for Windows and another for Java. Both are free to all members of the Developers Program. Developers on other platforms can use our SOAP or XML API directly.

  11. How do I get support?
    Our support hub is http://developer.ebay.com/support. There you'll find documentation, access to Forums, the Knowledgebase, our developer tools, as well as Live Help.
  12. Website problems
    If you encounter any problems with the site, feel free to contact us at .
  13. Forum login issues
    To sign-in to Forums, make sure to use your eBay user ID and password.

API Functionality

  1. What is the eBay API

    Normally, users buy and sell items using the eBay online interface, interacting with eBay directly. But with the eBay API, you communicate directly with the eBay database in XML format. By using the API, your application can provide a custom interface, functionality and specialized operations not otherwise afforded by the eBay interface.

    Using the API, you can create programs that:

    • Submit items for listing on eBay
    • Get the current list of eBay categories
    • View information about items listed on eBay
    • Get high bidder information for items you are selling
    • Retrieve lists of items a particular user is currently selling through eBay
    • Retrieve lists of items a particular user has bid on
    • Display eBay listings on other sites
    • Leave feedback about other users at the conclusion of a commerce transaction

    Because the API is not dependent on the eBay user interface, it allows you to create stable, custom functionality and interfaces that best meet your business needs.

    For instance, you can:

    • Automate the process of listing and monitoring auctions. There is no need to parse eBay pages that change frequently, breaking applications. A seller has access to more tools they can use to sell better and faster.
    • Extract user information from eBay and automate the end auction management process and delivery to eBay sellers and buyers.

    After joining the Developers Program, you will have access to the Developer Zone, a password-protected Web site for members only. The Developer Zone is the primary source for technical documentation and specifications, DTD files that define the XML input and output for the API, tools for creating and certifying your application and a full suite of additional technical resources.

Solutions Directory

  1. What is the Solutions Directory?
    The new eBay Solutions Directory is a one-stop online shop for eBay tools and services developed by eBay and eBay developers. It's a valuable marketing tool for those offering solutions, and an even more valuable resource for those who are looking for software solutions and services.
  2. Why should I list my solutions in the eBay Solution Directory
    The Solutions Directory is an excellent opportunity to give the eBay trading community information about your products and services, and enable them to make a purchasing decision that meets their specific business needs. There’s simply no better place to go to find all eBay solutions in one place, so the Directory is a very important tool for eBay developers and customers who need their tools.
  3. How will people hear about the eBay Solutions Directory?
    The eBay Solutions Directory is found on the homepage navigation of eBay.com, as well as in featured links throughout the site. We also conduct a number of different promotions to eBay sellers, including workshops, newsletter articles, public relations, appearances on eBay Radio, blurbs in community emails, and promotions at events.
  4. How does the eBay Solutions Directory work?

    The eBay community will be able to search and browse the eBay Solutions Directory in a number of ways to find the right solution for their needs. They’ll be able to:

    • Find solutions by features and functionality
    • Search and browse for solutions that support specific eBay categories
    • Compare multiple solutions by price

    Each listing will include a searchable individual page describing special features and availability of your solutions.

  5. How do I get a listing in the eBay Solutions Directory?
    Every member of the eBay Developers Program receives one free listing in the eBay Solutions Directory after their application has been approved through the Compatible Application Check process and they have received their production keys. To list your solution, go to My Account on the eBay Developers Program website, sign-in to the Developer Zone and click on "My Account." Once you have completed Compatible Application check and have production keys, you will see a Solutions Directory option in the right hand colunm on the My Account Page. From there, click on "Listings" and you can get started listing your solution.

Affiliate Program

  1. What is the Affiliate Developer Program and how does it relate to the Developers Program?

    Being part of the Affiliate Developer Program means you, being an eBay affiliate , now have access to one of the world’s most powerful web services platform. You are now able to scale your business by communicating directly with eBay e-commerce platform, and utilize live data to capture shopping activities for eBay with greater efficiency. Your commission growth is depending on your ability to drive eBay activity efficiently.

    Joining the eBay Developers Program gives you access to eBay Web Services.

  2. How do I join the Affiliate Developers Program?
    There are no special steps or extra qualifications for Affiliates. By agreeing to the online API License and selecting Affiliate activity = yes during the join flow, you become a member of the eBay Developers Program - with the intention of building an application to maximize your eBay Affiliate income.
  3. What if I am already a member of the eBay Developers Program and decide to build an application to maximize my Affiliate income?
    Existing Developers Program members can simply build the application desired. However, you will want to make sure you are a member of the eBay Affiliates Program in order to get the income generated from your application.
  4. How am I compensated for Affiliate traffic?
    You will be compensated via the eBay Affiliate Program pricing schedule
  5. How will you know the traffic is from me?
    You have the option to include your affiliate tracking information in the 'AffiliateTrackingDetails' element when you make an API call, such that URLs returned to you will have affiliate tracking built in. Sample explanation: affiliate tracking for GetSearchResults API . Or you may "manually" prepend affiliate tracking structure to any URL pointing to a page on an eBay site. Example affiliate tracking for Commission Junction users: http://rover.ebay.com/rover/1/711-6294-2978-0/1?AID=10381315&PID=YOUR_PID&loc=The_URL_Pointing_To_eBay_Page
  6. What if I need help with this program?
    After you join the program, you will have a full range of self-help resources including technical documentation, developer forums, and sample code. You will also have access to Developer Technical Support (DTS), a team dedicated to answering questions relating to the API. You can access all resources from the Support section of the Developer Zone website after you join. For questions about our programs, terms, and guidelines, please email our Affiliate API team.

announcements

eBay API Platform Turns 8!