-
Notifications
You must be signed in to change notification settings - Fork 0
/
keepa.yaml
161 lines (161 loc) · 6.86 KB
/
keepa.yaml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
openapi: 3.0.1
servers:
# Added by API Auto Mocking Plugin
- description: SwaggerHub API Auto Mocking
url: https://virtserver.swaggerhub.com/magicCashew/keepa/1.0.0
- description: The Production API which is accessible only by https.
url: https://api.keepa.com/
info:
description: The Keepa API offers numerous endpoints. Every request requires your API access key as a parameter. You can find and change your key in the keepa portal. All requests must be issued as a HTTPS GET and accept gzip encoding. If possible, use a Keep-Alive connection. Multiple requests can be made in parallel to increase throughput.
version: 1.0.0
title: Keepa API
contact:
name: Keepa
url: https://keepa.com/#!api
email: info@keepa.com
tags:
- name: product
description: Retrieve the product for the specified ASIN and domain.
- name: category
description: Retrieve categories using the node id and (optional) parent tree.
paths:
/product:
get:
tags:
- product
summary: Retrieve the product for the specified ASIN and domain.
operationId: product
description: Retrieves the product object for the specified ASIN and domain. If our last update is older than one hour it will be automatically refreshed before delivered to you to ensure you get near to real-time pricing data. You can request products via either their ASIN (preferred) or via UPC and EAN codes. You can not use both parameters, asin and code, in the same request. Keepa can not track Amazon Fresh and eBooks.
parameters:
- in: query
name: key
description: Your private API key.
required: true
schema:
type: string
- in: query
name: domain
description: Integer value for the Amazon locale you want to access. (1-com, 2-co.uk, 3-de, 4-fr, 5-co.jp, 6-ca, 7-cn, 8-it, 9-es, 10-in, 11-com.mx, 12-com.br, 13-com.au)
required: true
schema:
type: integer
enum: [ 1,2,3,4,5,6,7,8,9,10,11,12,13]
- in: query
name: asin
description: The ASIN of the product you want to request. For batch requests a comma separated list of ASINs (up to one hundred).
schema:
type: string
- in: query
name: code
description: The product code of the product you want to request. We currently allow UPC, EAN and ISBN-13 codes. For batch requests a comma separated list of codes (up to one hundred). Multiple ASINs can have the same product code, so requesting a product code can return multiple products.
schema:
type: string
responses:
'200':
description: search results matching criteria
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/product'
'400':
description: bad input parameter
/category:
get:
tags:
- category
summary: Returns Amazon category information from Keepa API.
operationId: category
description: Retrieve category objects using their node ids and (optional) their parent tree.
parameters:
- in: query
name: key
description: Your private API key.
required: true
schema:
type: string
- in: query
name: domain
description: Integer value for the Amazon locale you want to access. (1-com, 2-co.uk, 3-de, 4-fr, 5-co.jp, 6-ca, 7-cn, 8-it, 9-es, 10-in, 11-com.mx, 12-com.br, 13-com.au)
required: true
schema:
type: integer
enum: [ 1,2,3,4,5,6,7,8,9,10,11,12,13]
- in: query
name: category
description: The category node id of the category you want to request. For batch requests a comma separated list of ids (up to 10, the token cost stays the same). Alternatively you can specify the value 0, which will retrieve a list of all root categories.
required: true
schema:
type: integer
format: int32
- in: query
name: parents
description: Whether or not to include the category tree for each category. (1 = include, 0 = do not include.)
required: true
schema:
type: integer
format: int32
enum: [0,1]
responses:
'200':
description: search results matching criteria
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/category'
'400':
description: bad input parameter
components:
schemas:
product:
type: object
required:
- domainId
- asin
- code
category:
type: object
required:
- domainId
- catId
- name
- children
- parent
- highestRank
- productCount
properties:
domainId:
description: Integer value for the Amazon locale you want to access. (1-com, 2-co.uk, 3-de, 4-fr, 5-co.jp, 6-ca, 7-cn, 8-it, 9-es, 10-in, 11-com.mx, 12-com.br, 13-com.au)
type: integer
enum: [ 1,2,3,4,5,6,7,8,9,10,11,12,13]
example: 1
catId:
type: integer
description: The category node id used by Amazon. Represents the identifier of the category. Also part of the Product object’s categories and rootCategory fields. Always a positive Long value. Note - The id 9223372036854775807 (max signed long value) denotes a blank category with the name “?”. We use this in cases where a product is listed in no or non-existent categories.
example: 281052
name:
type: string
description: The name of the category.
example: Digital Cameras
children:
description: List of all sub categories. null or [] (empty array) if the category has no sub categories.
example: [3109924011,7242008011,3017941,2476680011,330405011,2476681011,3109925011]
type: array
items:
type: integer
nullable: true
parent:
type: integer
description: The parent category’s Id. Always a positive Long value. If it is 0 the category is a root category and has no parent category.
example: 502394
highestRank:
type: integer
description: The highest (root category) sales rank we have observed of a product that is listed in this category. Note- Estimate, as the value is from the Keepa product database and not retrieved from Amazon.
example: 6549
productCount:
type: integer
description: Number of products that are listed in this category. Note- Estimate, as the value is from the Keepa product database and not retrieved from Amazon.
example: 1522