forked from Benzinga/doc-site-mintlify
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathsec-v1.yml
323 lines (321 loc) · 10.4 KB
/
sec-v1.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
---
openapi: 3.0.1
info:
title: SEC Filings
description: SEC filings data
version: 1.0.0
servers:
- url: https://api.benzinga.com/api/v1/sec
paths:
/insider_transactions/filings:
get:
summary: Returns insider transactions data (SEC Form 4)
parameters:
- name: date
in: query
description: Date to query for data. Shorthand for date_from and date_to if
they are the same. Defaults for latest.
schema:
type: string
format: YYYY-MM-DD
- name: date_from
in: query
description: Date to query from point in time.
schema:
type: string
format: YYYY-MM-DD
- name: date_to
in: query
description: Date to query to point in time.
schema:
type: string
format: YYYY-MM-DD
- name: fields
in: query
description: |
A comma (,) separated list of returned fields.
style: form
explode: false
schema:
type: array
items:
type: string
format: array
- name: pagesize
in: query
description: Number of results returned. Limit 1000
schema:
type: integer
default: 50
- name: page
in: query
description: Page offset.
schema:
type: integer
default: 0
- name: search_keys
in: query
description: One or more security symbols separated by a comma. Maximum 50
securities. Security identifiers must be in the format of ticker symbols,
only for US-listed equities.
schema:
type: string
format: csv
- name: search_keys_type
in: query
description: The type of identifier being searched. Supported types are currently
a security symbol, accession number and filing id.
schema:
type: string
default: symbol
enum:
- symbol
- accession_number
- id
- name: updated_since
in: query
description: |
Records last Updated Unix timestamp (UTC). This will force the sort order
to be Greater Than or Equal to the timestamp indicated.
Timestamp may also be in python format to include millisecond updates.
schema:
type: number
format: double
responses:
200:
description: success
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/insider_transactions_filings'
security:
- token: []
components:
schemas:
insider_transactions_filings:
type: object
properties:
id:
type: string
description: Benzinga-generated unique identifier for this individual insider
transaction.
accession_number:
type: string
description: Accession Number of the filling - Unique identifier assigned
automatically to an accepted submission by the SEC. This will be same
for all transaction (entries) of that filling.
company_cik:
type: string
description: Central Index Key (CIK) for the filing company.
company_name:
type: string
description: Name of the company.
company_symbol:
type: string
description: Primary (i.e. common stock ticker) symbol of the company whose
securities are getting purchased / sold.
filing_date:
type: string
description: Date of the SEC filing.
format: YYYY-MM-DD
footnotes:
type: array
items:
type: object
properties:
id:
type: string
description: Footnote ID. (i.e. 'F1')
text:
type: string
description: Footnote explainations of the responses on the form.
form_type:
type: string
description: SEC form type.
html_url:
type: string
description: URL of the original SEC Form.
owner:
type: object
properties:
insider_cik:
type: string
description: Central Index Key (CIK) of the reporting insider.
insider_name:
type: string
description: Name of the reporting insider.
insider_title:
type: string
description: Official title of the insider.
is_director:
type: boolean
description: A boolean signifying the relationship of Reporting Person(s)
to Issuer (true/false)
is_officer:
type: boolean
description: A boolean signifying the relationship of Reporting Person(s)
to Issuer (true/false)
is_other_relation:
type: boolean
description: A boolean signifying the relationship of Reporting Person(s)
to Issuer (true/false)
is_ten_percent_owner:
type: boolean
description: A boolean signifying the relationship of Reporting Person(s)
to Issuer (true/false)
raw_signature:
type: string
description: Signature of reporting person.
description: not available
transactions:
type: array
description: All derivative and non-derivative transactions associated with
the filing.
items:
type: object
properties:
is_derivative:
type: boolean
description: If the transaction is a derivative
acquired_or_disposed:
type: string
description: Code denoting whether the security was acquired (A) or
disposed (D).
conversion_exercise_price_derivative:
type: string
description: Conversion or exercise price of derivative security.
date_deemed_execution:
type: string
description: The deemed execution date (if any), had there not been
a directly identifiable date.
date_exercisable:
type: string
description: The date in which the derivative security may be exercised.
format: YYYY-MM-DD
date_expiration:
type: string
description: The expiration date of the derivative security.
format: YYYY-MM-DD
date_transaction:
type: string
description: The date of the transaction.
format: YYYY-MM-DD
post_transaction_quantity:
type: integer
description: Quantity of shares remaining after the transaction.
price_per_share:
type: string
description: Price of each individual share transacted.
format: float
security_title:
type: string
description: The name of the security transacted.
shares:
type: integer
description: The number of shares involved in the transaction.
transaction_code:
type: string
description: Code describing the transaction. (https://www.sec.gov/edgar/searchedgar/ownershipformcodes.html)
transaction_id:
type: string
description: Unique ID of the transaction.
underlying_security_title:
type: string
description: The name of the security transacted.
underlying_shares:
type: integer
description: The number of shares involved in the subject transaction.
voluntarily_reported:
type: string
description: Signifies whether the transaction is reported earlier
than required (true/false)
updated:
type: integer
description: Last updated timestamp, UTC.
parameters:
page:
name: page
in: query
description: Page offset.
schema:
type: integer
default: 0
pagesize:
name: pagesize
in: query
description: Number of results returned. Limit 1000
schema:
type: integer
default: 50
date:
name: date
in: query
description: Date to query for data. Shorthand for date_from and date_to if
they are the same. Defaults for latest.
schema:
type: string
format: YYYY-MM-DD
date_from:
name: date_from
in: query
description: Date to query from point in time.
schema:
type: string
format: YYYY-MM-DD
date_to:
name: date_to
in: query
description: Date to query to point in time.
schema:
type: string
format: YYYY-MM-DD
search_keys:
name: search_keys
in: query
description: One or more security symbols separated by a comma. Maximum 50 securities.
Security identifiers must be in the format of ticker symbols, only for US-listed
equities.
schema:
type: string
format: csv
search_keys_type:
name: search_keys_type
in: query
description: The type of identifier being searched. Supported types are currently
a security symbol, accession number and filing id.
schema:
type: string
default: symbol
enum:
- symbol
- accession_number
- id
updated_since:
name: updated_since
in: query
description: |
Records last Updated Unix timestamp (UTC). This will force the sort order
to be Greater Than or Equal to the timestamp indicated.
Timestamp may also be in python format to include millisecond updates.
schema:
type: number
format: double
fields:
name: fields
in: query
description: |
A comma (,) separated list of returned fields.
style: form
explode: false
schema:
type: array
items:
type: string
format: array
securitySchemes:
token:
type: apiKey
name: token
in: query