-
Notifications
You must be signed in to change notification settings - Fork 11
/
logos-v2.yml
370 lines (356 loc) · 10.7 KB
/
logos-v2.yml
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
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
openapi: 3.0.1
info:
title: Corporate Logos v2.0
description: The Benzinga Corporate Logo API is designed to be flexible with client
sizing requirements.
version: 2.0.0
servers:
- url: https://api.benzinga.com/api/v2/logos
paths:
/search:
get:
summary: Search logos for market securities/companies
parameters:
- name: accept
in: header
description: Specifies return format
schema:
type: string
default: application/json
enum:
- application/json
- name: search_keys
in: query
description: |
A comma (,) separated list of search identifiers. Identifiers are based on the `search_type` field. Limit 100 per request.
Example: F,AAPL
Logos can also be queried with format <EXCHANGE>:<SYMBOL>
i.e. NYSE:ARI
required: true
style: form
explode: false
schema:
maxItems: 100
type: array
items:
type: string
format: array
- name: search_keys_type
in: query
description: The type of identifier being searched. Supported types are currently
a security symbol and CIK.
schema:
type: string
default: symbol
enum:
- symbol
- cik
- cusip
- isin
- name: fields
in: query
description: |
A comma (,) separated list of returned fields.
Example: mark_light,background_light
Would return ONLY the mark_light, background_light values from the API.
required: true
style: form
explode: false
schema:
type: array
items:
type: string
format: array
enum:
- logo_light
- logo_dark
- logo_vector_light
- logo_vector_dark
- mark_light
- mark_dark
- mark_vector_light
- mark_vector_dark
- mark_composite_light
- mark_composite_dark
- name: composite_auto
in: query
description: If no image exists, generate a fill image based on the company
name and background color.
schema:
type: boolean
default: false
- name: composite_radius
in: query
description: |
Apply a radius to the composite image.
Default value is 0. Maximum value is 50 (50%) which will result in a circle.
schema:
type: integer
default: 0
- name: scale
in: query
description: |
Specified as the WIDTHxHEIGHT to scale the image down in pixels. Images will only be scaled down, never up, and fit within the bounds set. In CSS terms, the object-fit property is set to `contain`.
Scale will be applied to: logo_light, logo_dark, mark_light, mark_dark, mark_composite_light, mark_composite_dark
Example: 300x600
schema:
type: string
responses:
200:
description: Successful response
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/data'
security:
- token: []
/sync:
get:
summary: Bulk sync logos.
parameters:
- name: accept
in: header
description: Specifies return format
schema:
type: string
default: application/json
enum:
- application/json
- name: updated_since
in: query
description: Last updated unix timestamp, UTC
schema:
type: integer
format: int64
- name: fields
in: query
description: |
A comma (,) separated list of returned fields.
Example: mark_light,background_light
Would return ONLY the mark_light, background_light values from the API.
required: true
style: form
explode: false
schema:
type: array
items:
type: string
format: array
enum:
- logo_light
- logo_dark
- logo_vector_light
- logo_vector_dark
- mark_light
- mark_dark
- mark_vector_light
- mark_vector_dark
- mark_composite_light
- mark_composite_dark
- name: composite_auto
in: query
description: If no image exists, generate a fill image based on the company
name and background color.
schema:
type: boolean
default: false
- name: composite_radius
in: query
description: |
Apply a radius to the composite image.
Default value is 0. Maximum value is 50 (50%) which will result in a circle.
schema:
type: integer
default: 0
- name: scale
in: query
description: |
Specified as the WIDTHxHEIGHT to scale the image down in pixels. Images will only be scaled down, never up, and fit within the bounds set. In CSS terms, the object-fit property is set to `contain`.
Scale will be applied to: logo_light, logo_dark, mark_light, mark_dark, mark_composite_light, mark_composite_dark
Example: 300x600
schema:
type: string
- name: page
in: query
description: Page offset.
schema:
type: integer
- name: pagesize
in: query
description: Number of results returned. Default 100
schema:
type: integer
responses:
200:
description: Successful response
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/data'
security:
- token: []
components:
schemas:
ok:
type: boolean
description: Return status indicating the status of the result (OK if true,
ERROR if false)
errors:
type: object
properties:
id:
type: string
description: Reference request error ID. (You can use this for reporting
to Benzinga team.)
code:
type: string
description: The error status
value:
type: string
description: Details for the error state
description: Error result if status is NOT ok.
data:
required:
- created_at
- files
- search_key
- updated_at
type: object
properties:
id:
type: string
description: Record identifier
search_key:
type: string
description: |
The identifying search term, ex. cik or symbol value(s).
If search was not used, not value will be returned.
created_at:
type: string
description: Created timestamp, UTC
format: RFC3339/ISO8601
updated_at:
type: string
description: Last updated timestamp, UTC
format: RFC3339/ISO8601
colors:
$ref: '#/components/schemas/colors'
files:
$ref: '#/components/schemas/files'
securities:
$ref: '#/components/schemas/securities'
colors:
type: object
properties:
background_light:
type: string
description: Background color in HEX format to use in a white/light theme.
format: '#000/#abc000'
background_dark:
type: string
description: Background color in HEX format to use in a dark theme.
format: '#000/#abc000'
files:
type: object
properties:
logo_light:
type: string
description: URI of company logo for use in a white/light theme. Image file
type of PNG.
logo_dark:
type: string
description: URI of company logo for use in a dark theme. Image file type
of PNG.
logo_vector_light:
type: string
description: URI of company logo for use in a white/light theme. Vector
file type of SVG.
logo_vector_dark:
type: string
description: URI of company logo for use in a dark theme. Vector file type
of SVG.
mark_light:
type: string
description: URI of company mark for use in a white/light theme. Image file
type of PNG.
mark_dark:
type: string
description: URI of company mark for use in a dark theme. Image file type
of PNG.
mark_composite_light:
type: string
description: URI of composite image with the company mark for use in a light/white
theme.
mark_composite_dark:
type: string
description: URI of composite image with the company mark for use in a dark
theme.
mark_vector_light:
type: string
description: URI of company mark for use in a white/light theme. Vector
file type of SVG.
mark_vector_dark:
type: string
description: URI of company mark for use in a dark theme. Vector file type
of SVG.
securities:
type: array
items:
type: object
properties:
exchange:
type: string
description: Exchange on which the security is listed
symbol:
type: string
description: Ticker symbol for the security
name:
type: string
description: Name of security or company
cik:
type: string
description: CIK
cusip:
type: string
description: CUSIP
isin:
type: string
description: ISIN
description: |
A security object. Only included with sync operations.
parameters:
fields:
name: fields
in: query
description: |
A comma (,) separated list of returned fields.
Example: mark_light,background_light
Would return ONLY the mark_light, background_light values from the API.
required: true
style: form
explode: false
schema:
type: array
items:
type: string
format: array
enum:
- logo_light
- logo_dark
- logo_vector_light
- logo_vector_dark
- mark_light
- mark_dark
- mark_vector_light
- mark_vector_dark
- mark_composite_light
- mark_composite_dark
securitySchemes:
token:
type: apiKey
name: token
in: query