Skip to content

Latest commit

 

History

History
102 lines (70 loc) · 2.89 KB

README.md

File metadata and controls

102 lines (70 loc) · 2.89 KB

keepaAPI

Python module to interface to https://keepa.com/ to query for Amazon product information and history.

Requirements

Module is compatible with Python 2 and 3. keepaAPI requires:

  • numpy
  • requests

Product history can be plotted from the raw data when matplotlib is installed.

Additionally, interfacing with the keepaAPI requires an accesskey and monthly subscription from https://keepa.com/#!api

Installation

Module can be installed from PyPi using pip install keepaAPI

Source code can also be downloaded from this github repository and installed using python setup.py install or pip install .

Brief Example

from keepaAPI import Interface
accesskey = 'XXXXXXXXXXXXXXXX' # enter real access key here
api = Interface.API(accesskey)

#Single ASIN query
products = api.ProductQuery('059035342X') # returns list of product data

Detailed Example

Import interface and establish connection to server

from keepaAPI import Interface
accesskey = 'XXXXXXXXXXXXXXXX' # enter real access key here
api = Interface.API(accesskey)

Single ASIN query

products = api.ProductQuery('059035342X')

# See help(api.ProductQuery) for available options when querying the API

Multiple ASIN query from List

asins = ['0022841350', '0022841369', '0022841369', '0022841369']
products = api.ProductQuery(asins)

Multiple ASIN query from numpy array

asins = np.asarray(['0022841350', '0022841369', '0022841369', '0022841369'])
products = api.ProductQuery(asins)

Products is a list of product data with one entry per successful result from the keepa server. Each entry is a dictionary containing the same product data available from http://www.amazon.com.

# Available keys
print(products[0].keys())

# Print ASIN and title
print('ASIN is ' + products[0]['asin'])
print('Title is ' + products[0]['title'])

The raw data is contained within each product result. Raw data is stored as a dictonary with each key paired with its associated time history.

# Access new price history and associated time data
newprice = products[0]['data']['MarketplaceNew']
newpricetime = products[0]['data']['MarketplaceNew_time']

# Can be plotted with matplotlib using:
import matplotlib.pyplot as plt
plt.step(newpricetime, newprice, where='pre')

# Keys can be listed by
print(products[0]['data'].keys())

The product history can also be plotted from the module if matplotlib is installed

Plotting.PlotProduct(products[0])

History

1 August 2016: Initial commit

Credits

This python code, written by Alex Kaszynski, is based on Java code writen by Marius Johann, CEO keepa. Java source is can be found at https://github.com/keepacom/api_backend/

License

See license file. Work is credited to both Alex Kaszynski and Marius Johann.