-
Notifications
You must be signed in to change notification settings - Fork 1
/
openapi.yaml
229 lines (229 loc) · 5.68 KB
/
openapi.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
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
openapi: 3.0.0
info:
title: Auto-updated pricedb for Iranian Rial (IRR) exchange rates in Iran's free market
version: 0.1.1
servers:
- description: Production Server
url: https://api.priceto.day/v1
paths:
/symbols:
get:
summary: Get list of currencies
description: Get list of currencies that are supported by the API
tags: [Symbols]
operationId: getSymbols
responses:
'200':
description: Successful operation
content:
application/json:
schema:
$ref: '#/components/schemas/Symbol'
'500':
description: Server error
/latest/{base}/{symbol}:
get:
summary: Get latest price of a symbol
description: Get latest price of a symbol
tags: [Symbols]
operationId: getLatestPrice
parameters:
- name: base
in: path
required: true
example: irr
schema:
type: string
- name: symbol
in: path
required: true
example: usd
schema:
type: string
responses:
'200':
description: successful operation
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/LatestResponse'
'404':
description: No data found for this base and symbol
'500':
description: Server error
/history/{base}/{symbol}:
get:
summary: Get the history of a symbol
description: Get the history of a symbol
tags: [Symbols]
operationId: getHistory
parameters:
- name: base
in: path
required: true
example: irr
schema:
type: string
- name: symbol
in: path
required: true
example: usd
schema:
type: string
- name: from
in: query
required: false
example: "2023-04-14T00:00:00Z"
schema:
type: string
format: date-time
- name: to
in: query
required: false
example: "2023-04-27T00:00:00Z"
schema:
type: string
format: date-time
responses:
'200':
description: successful operation
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/HistoryResponse'
'404':
description: No data found for this base and symbol
'500':
description: Server error
/chart/{base}/{symbol}:
get:
summary: Get the chart of a symbol
description: Get the chart of a symbol
tags: [Symbols]
operationId: getChart
parameters:
- name: base
in: path
required: true
example: irr
schema:
type: string
- name: symbol
in: path
required: true
example: usd
schema:
type: string
- name: from
in: query
required: false
example: "2023-04-14T00:00:00Z"
schema:
type: string
format: date-time
- name: to
in: query
required: false
example: "2023-04-27T00:00:00Z"
schema:
type: string
format: date-time
- name: title
in: query
required: false
example: "Chart Title"
schema:
type: string
- name: rounding
in: query
description: Number of digits to round from the end of the price
required: false
example: 7
schema:
type: number
- name: precision
in: query
description: Number of digits to show after the decimal point
required: false
example: 1
schema:
type: number
responses:
'200':
description: successful operation
content:
image/jpeg:
schema:
type: string
format: binary
'404':
description: No data found for this base and symbol
'500':
description: Server error
tags:
- name: Symbols
description: Operations about symbols
components:
schemas:
Symbol:
type: object
properties:
success:
type: boolean
example: true
symbols:
type: array
items:
type: string
example: ["usd", "eur", "irr"]
HistoryResponse:
type: object
properties:
success:
type: boolean
example: true
result:
type: array
items:
type: object
properties:
price:
type: integer
format: int64
example: 10
high:
type: integer
format: int64
example: 20
low:
type: integer
format: int32
example: 5
time:
type: string
format: date-time
LatestResponse:
type: object
properties:
success:
type: boolean
example: true
price:
type: integer
format: int64
example: 10
high:
type: integer
format: int64
example: 20
low:
type: integer
format: int32
example: 5
time:
type: string
format: date-time