Finding API class

The Finding API enables developers to access eBay's next-generation search capabilities. The Finding API helps developers search for items using eBay's next generation Finding Platform. Buying applications can build search and browse experiences using the powerful search and search refinement capabilities offered by the Finding APIs.

Usage

from ebaysdk.finding import Connection as Finding
from ebaysdk.exception import ConnectionError

try:
    api = Finding(appid="YOUR_APPID", config_file=None)
    response = api.execute('findItemsAdvanced', {'keywords': 'Python'})
    print(response.dict())
except ConnectionError as e:
    print(e)
    print(e.response.dict())

Usage With YAML

Place a YAML file in your home or /etc/ directory and reference that filename when constructing the object. The default YAML filename is "ebay.yaml". If you use this name, it will automatically get picked up.

from ebaysdk.finding import Connection as Finding
from ebaysdk.exception import ConnectionError

try:
    api = Finding(config_file='myfile.yaml')
    response = api.execute('findItemsAdvanced', {'keywords': 'Python'})
    print(response.dict())
except ConnectionError as e:
    print(e)
    print(e.response.dict())

Sandbox Usage

from ebaysdk.finding import Connection as Finding

api = Finding(domain='svcs.sandbox.ebay.com', appid="YOUR_APPID", config_file=None)
response = api.execute('findItemsAdvanced', {'keywords': 'Python'})
print(response.dict())

Public Methods

Finding(**kwargs)

Keyword arguments to finding() constructor

domain        -- API endpoint (default: svcs.ebay.com)
config_file   -- YAML defaults (default: ebay.yaml)
debug         -- debugging enabled (default: False)
errors        -- warnings enabled (default: True)
warnings      -- warnings enabled (default: False)
uri           -- API endpoint uri (default: /services/search/FindingService/v1)
appid         -- eBay application id
siteid        -- eBay country site id (default: EBAY-US)
compatibility -- version number (default: 1.0.0)
https         -- execute of https (default: False)
proxy_host    -- proxy hostname
proxy_port    -- proxy port number
timeout       -- HTTP request timeout (default: 20)
parallel      -- ebaysdk parallel object
response_encoding -- API encoding (default: XML)
request_encoding  -- API encoding (default: XML)

execute(verb, data)

Execute the HTTP request.

response = api.execute('findItemsAdvanced', {'keywords': 'Python'})

error()

Returns a string of the HTTP call errors

if api.error():
    print("has errors: %s" % api.error())

response.reply

Return a response data object.

response.dom()

Return a DOM object (lxml dom) of the HTTP response content.

response.dict()

Return a dictionary of the HTTP response content.

response.content

Return the string content from the HTTP response call.

response_code()

Return the HTTP response code.

response_status()

Return the HTTP response status.

response_codes()

Return an array of eBay response codes.

API Use Cases

• Affiliate Tracking
• Controlling the Way Search Results are Returned
• Refining a Search with Aspect and Domain Filters
• Refining a Search with Item Filters
• Retrieving Histogram Metadata
• Searching and Browsing by Category
• Searching by Keywords
• Searching by Product

see more

More Examples

see samples