sec-edgar-api 0.1.1 → 0.2.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/LICENSE.md +21 -0
- package/README.md +4 -4
- package/package.json +2 -2
package/LICENSE.md
ADDED
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
MIT License
|
|
2
|
+
|
|
3
|
+
Copyright (c) 2024 Andrew Evers
|
|
4
|
+
|
|
5
|
+
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
6
|
+
of this software and associated documentation files (the "Software"), to deal
|
|
7
|
+
in the Software without restriction, including without limitation the rights
|
|
8
|
+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
9
|
+
copies of the Software, and to permit persons to whom the Software is
|
|
10
|
+
furnished to do so, subject to the following conditions:
|
|
11
|
+
|
|
12
|
+
The above copyright notice and this permission notice shall be included in all
|
|
13
|
+
copies or substantial portions of the Software.
|
|
14
|
+
|
|
15
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
16
|
+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
17
|
+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
18
|
+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
19
|
+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
20
|
+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
|
21
|
+
SOFTWARE.
|
package/README.md
CHANGED
|
@@ -24,12 +24,14 @@ Reports are all returned as a uniform interface:
|
|
|
24
24
|
|
|
25
25
|
```TS
|
|
26
26
|
interface ReportTranslated {
|
|
27
|
+
cik: number
|
|
28
|
+
url: string | null
|
|
27
29
|
dateReport: string
|
|
28
30
|
dateFiled: string
|
|
29
31
|
fiscalPeriod: FiscalPeriod
|
|
30
32
|
fiscalYear: number
|
|
31
|
-
|
|
32
|
-
|
|
33
|
+
splitDate: string | null
|
|
34
|
+
splitRatio: number | null
|
|
33
35
|
|
|
34
36
|
assetTotal: number | null
|
|
35
37
|
assetCurrent: number | null
|
|
@@ -114,8 +116,6 @@ const reports = await secEdgarApi.getReports({ symbol: 'AAPL' })
|
|
|
114
116
|
|
|
115
117
|
## Resolvers
|
|
116
118
|
|
|
117
|
-
**WARNING** Still in testing. Values may not be accurate for all companies since the properties provided in the reports differ.
|
|
118
|
-
|
|
119
119
|
The main problem with the edgar API is that the property names and data provided are not uniform. You have to deal with companies omitting important data
|
|
120
120
|
in some filings, or using different property keys for the same data point.
|
|
121
121
|
|
package/package.json
CHANGED
|
@@ -1,11 +1,11 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "sec-edgar-api",
|
|
3
|
-
"version": "0.
|
|
3
|
+
"version": "0.2.1",
|
|
4
4
|
"description": "Fetch and parse SEC earnings reports and other filings. Useful for financial analysis.",
|
|
5
5
|
"main": "build/index.js",
|
|
6
6
|
"author": "Andrew Evers (https://github.com/andyevers)",
|
|
7
7
|
"homepage": "https://github.com/andyevers/sec-edgar-api#readme",
|
|
8
|
-
"license": "
|
|
8
|
+
"license": "MIT",
|
|
9
9
|
"repository": {
|
|
10
10
|
"type": "git",
|
|
11
11
|
"url": "git+https://github.com/andyevers/sec-edgar-api.git"
|