@apiverve/balancesheet 0.0.0-stage → 1.2.3

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.
Files changed (5) hide show
  1. package/LICENSE +21 -0
  2. package/README.md +200 -2
  3. package/index.d.ts +66 -0
  4. package/index.js +209 -0
  5. package/package.json +44 -3
package/LICENSE ADDED
@@ -0,0 +1,21 @@
1
+ The MIT License (MIT)
2
+
3
+ Copyright (c) 2026 APIVerve and EvlarSoft LLC
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
@@ -1,3 +1,201 @@
1
- # Temporary Holding Version
1
+ # Balance Sheet API
2
2
 
3
- This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
3
+ Balance Sheet is a stock balance sheet API that returns the statement of financial position for a US public company by ticker - assets, liabilities and shareholders' equity - straight from SEC filings: current assets, cash, receivables, current liabilities, equity and more. Paid plans add total assets and liabilities, long-term debt, and liquidity and leverage ratios like current ratio, quick ratio and debt-to-equity.
4
+
5
+ [![npm version](https://img.shields.io/npm/v/@apiverve/balancesheet.svg)](https://www.npmjs.com/package/@apiverve/balancesheet)
6
+
7
+ This is a JavaScript wrapper for the [Balance Sheet API](https://apiverve.com/marketplace/balancesheet?utm_source=npm&utm_medium=referral&utm_content=readme)
8
+
9
+ ---
10
+
11
+ ## Installation
12
+
13
+ Using npm:
14
+ ```shell
15
+ npm install @apiverve/balancesheet
16
+ ```
17
+
18
+ Using yarn:
19
+ ```shell
20
+ yarn add @apiverve/balancesheet
21
+ ```
22
+
23
+ ---
24
+
25
+ ## Configuration
26
+
27
+ Before using the Balance Sheet API client, you have to setup your account and obtain your API Key.
28
+ You can get it by signing up at [https://apiverve.com](https://apiverve.com?utm_source=npm&utm_medium=referral&utm_content=readme)
29
+
30
+ ---
31
+
32
+ ## Quick Start
33
+
34
+ [Get started with the Quick Start Guide](https://docs.apiverve.com/quickstart?utm_source=npm&utm_medium=referral&utm_content=readme)
35
+
36
+ The Balance Sheet API documentation is found here: [https://docs.apiverve.com/ref/balancesheet](https://docs.apiverve.com/ref/balancesheet?utm_source=npm&utm_medium=referral&utm_content=readme).
37
+ You can find parameters, example responses, and status codes documented here.
38
+
39
+ ### Setup
40
+
41
+ ```javascript
42
+ const balancesheetAPI = require('@apiverve/balancesheet');
43
+ const api = new balancesheetAPI({
44
+ api_key: '[YOUR_API_KEY]'
45
+ });
46
+ ```
47
+
48
+ ---
49
+
50
+ ## Usage
51
+
52
+ ---
53
+
54
+ ### Perform Request
55
+
56
+ Using the API is simple. All you have to do is make a request. The API will return a response with the data you requested.
57
+
58
+ ```javascript
59
+ var query = {
60
+ ticker: "AAPL",
61
+ year: 0,
62
+ quarter: 0
63
+ };
64
+
65
+ api.execute(query, function (error, data) {
66
+ if (error) {
67
+ return console.error(error);
68
+ } else {
69
+ console.log(data);
70
+ }
71
+ });
72
+ ```
73
+
74
+ ---
75
+
76
+ ### Using Promises
77
+
78
+ You can also use promises to make requests. The API returns a promise that you can use to handle the response.
79
+
80
+ ```javascript
81
+ var query = {
82
+ ticker: "AAPL",
83
+ year: 0,
84
+ quarter: 0
85
+ };
86
+
87
+ api.execute(query)
88
+ .then(data => {
89
+ console.log(data);
90
+ })
91
+ .catch(error => {
92
+ console.error(error);
93
+ });
94
+ ```
95
+
96
+ ---
97
+
98
+ ### Using Async/Await
99
+
100
+ You can also use async/await to make requests. The API returns a promise that you can use to handle the response.
101
+
102
+ ```javascript
103
+ async function makeRequest() {
104
+ var query = {
105
+ ticker: "AAPL",
106
+ year: 0,
107
+ quarter: 0
108
+ };
109
+
110
+ try {
111
+ const data = await api.execute(query);
112
+ console.log(data);
113
+ } catch (error) {
114
+ console.error(error);
115
+ }
116
+ }
117
+ ```
118
+
119
+ ---
120
+
121
+ ## Example Response
122
+
123
+ ```json
124
+ {
125
+ "status": "ok",
126
+ "error": null,
127
+ "data": {
128
+ "ticker": "AAPL",
129
+ "company": "Apple Inc.",
130
+ "cik": "0000320193",
131
+ "fiscalYear": 2025,
132
+ "fiscalQuarter": 4,
133
+ "filingType": "10-K",
134
+ "filingDate": "2025-10-31",
135
+ "periodEnd": "2025-09-27",
136
+ "balance": {
137
+ "totalAssets": 359241000000,
138
+ "currentAssets": 147957000000,
139
+ "cash": 35934000000,
140
+ "receivables": 39777000000,
141
+ "inventory": 5718000000,
142
+ "propertyAndEquipment": 49834000000,
143
+ "goodwill": null,
144
+ "intangibles": null,
145
+ "totalLiabilities": 285508000000,
146
+ "currentLiabilities": 165631000000,
147
+ "accountsPayable": 69860000000,
148
+ "longTermDebt": 78328000000,
149
+ "equity": 73733000000,
150
+ "retainedEarnings": -14264000000
151
+ },
152
+ "ratios": {
153
+ "currentRatio": 0.89,
154
+ "quickRatio": 0.86,
155
+ "cashRatio": 0.22,
156
+ "workingCapital": -17674000000,
157
+ "debtToEquity": 3.87,
158
+ "debtToAssets": 0.79,
159
+ "longTermDebtToEquity": 1.06,
160
+ "equityMultiplier": 4.87
161
+ },
162
+ "formatted": {
163
+ "totalAssets": "$359.24B",
164
+ "totalLiabilities": "$285.51B",
165
+ "equity": "$73.73B",
166
+ "workingCapital": "-$17.67B"
167
+ }
168
+ }
169
+ }
170
+ ```
171
+
172
+ ---
173
+
174
+ ## Customer Support
175
+
176
+ Need any assistance? [Get in touch with Customer Support](https://apiverve.com/contact?utm_source=npm&utm_medium=referral&utm_content=readme).
177
+
178
+ ---
179
+
180
+ ## Updates
181
+
182
+ Stay up to date by following [@apiverveHQ](https://twitter.com/apiverveHQ) on Twitter.
183
+
184
+ ---
185
+
186
+ ## Legal
187
+
188
+ All usage of the APIVerve website, API, and services is subject to the [APIVerve Terms of Service](https://apiverve.com/terms?utm_source=npm&utm_medium=referral&utm_content=readme) and [Privacy Policy](https://apiverve.com/privacy?utm_source=npm&utm_medium=referral&utm_content=readme).
189
+
190
+ ---
191
+
192
+ ## License
193
+ Licensed under the MIT License (MIT)
194
+
195
+ Copyright (©) 2026 APIVerve, and EvlarSoft LLC
196
+
197
+ Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
198
+
199
+ The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
200
+
201
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
package/index.d.ts ADDED
@@ -0,0 +1,66 @@
1
+ declare module '@apiverve/balancesheet' {
2
+ export interface balancesheetOptions {
3
+ api_key: string;
4
+ secure?: boolean;
5
+ }
6
+
7
+ /**
8
+ * Describes fields the current plan does not unlock. Locked fields arrive as null
9
+ * in `data`; `locked_fields` names them, using dot paths for nested fields.
10
+ * Absent when the plan unlocks everything.
11
+ */
12
+ export interface PremiumInfo {
13
+ message: string;
14
+ upgrade_url: string;
15
+ locked_fields: string[];
16
+ }
17
+
18
+ export interface balancesheetResponse {
19
+ status: string;
20
+ error: string | null;
21
+ data: BalanceSheetData;
22
+ code?: number;
23
+ premium?: PremiumInfo;
24
+ }
25
+
26
+
27
+ interface BalanceSheetData {
28
+ ticker: null | string;
29
+ company: null | string;
30
+ cik: null | string;
31
+ fiscalYear: number | null;
32
+ fiscalQuarter: number | null;
33
+ filingType: null | string;
34
+ filingDate: Date | null;
35
+ periodEnd: Date | null;
36
+ balance: { [key: string]: number | null };
37
+ ratios: Ratios;
38
+ formatted: Formatted;
39
+ }
40
+
41
+ interface Formatted {
42
+ totalAssets: null | string;
43
+ totalLiabilities: null | string;
44
+ equity: null | string;
45
+ workingCapital: null | string;
46
+ }
47
+
48
+ interface Ratios {
49
+ currentRatio: number | null;
50
+ quickRatio: number | null;
51
+ cashRatio: number | null;
52
+ workingCapital: number | null;
53
+ debtToEquity: number | null;
54
+ debtToAssets: number | null;
55
+ longTermDebtToEquity: number | null;
56
+ equityMultiplier: number | null;
57
+ }
58
+
59
+ export default class balancesheetWrapper {
60
+ constructor(options: balancesheetOptions);
61
+
62
+ execute(callback: (error: any, data: balancesheetResponse | null) => void): Promise<balancesheetResponse>;
63
+ execute(query: Record<string, any>, callback: (error: any, data: balancesheetResponse | null) => void): Promise<balancesheetResponse>;
64
+ execute(query?: Record<string, any>): Promise<balancesheetResponse>;
65
+ }
66
+ }
package/index.js ADDED
@@ -0,0 +1,209 @@
1
+ const axios = require('axios');
2
+
3
+ class balancesheetWrapper {
4
+
5
+ constructor(options) {
6
+ if (!options || typeof options !== 'object') {
7
+ throw new Error('Options object must be provided. See documentation: https://docs.apiverve.com/ref/balancesheet');
8
+ }
9
+
10
+ const { api_key, secure = true } = options;
11
+
12
+ if (!api_key || typeof api_key !== 'string') {
13
+ throw new Error('API key must be provided as a non-empty string. Get your API key at: https://apiverve.com');
14
+ }
15
+
16
+ // Validate API key format (GUID, prefixed keys like apv_xxx, or alphanumeric)
17
+ const apiKeyPattern = /^[a-zA-Z0-9_-]+$/;
18
+ if (!apiKeyPattern.test(api_key)) {
19
+ throw new Error('Invalid API key format. API key must be alphanumeric and may contain hyphens and underscores. Get your API key at: https://apiverve.com');
20
+ }
21
+
22
+ if (typeof secure !== 'boolean') {
23
+ throw new Error('Secure parameter must be a boolean value.');
24
+ }
25
+
26
+ this.APIKey = api_key;
27
+ this.IsSecure = secure;
28
+
29
+ // secure is deprecated, all requests must be made over HTTPS
30
+ this.baseURL = 'https://api.apiverve.com/v1/balancesheet';
31
+
32
+ // Validation rules for parameters (generated from schema)
33
+ this.validationRules = {"ticker":{"type":"string","required":true,"minLength":1,"maxLength":6},"year":{"type":"integer","required":false,"min":2000,"max":2030},"quarter":{"type":"integer","required":false,"min":1,"max":4}};
34
+ }
35
+
36
+ /**
37
+ * Validate query parameters against schema rules
38
+ * @param {Object} query - The query parameters to validate
39
+ * @throws {Error} - If validation fails
40
+ */
41
+ validateParams(query) {
42
+ const errors = [];
43
+
44
+ for (const [paramName, rules] of Object.entries(this.validationRules)) {
45
+ const value = query[paramName];
46
+
47
+ // Check required
48
+ if (rules.required && (value === undefined || value === null || value === '')) {
49
+ errors.push(`Required parameter [${paramName}] is missing.`);
50
+ continue;
51
+ }
52
+
53
+ // Skip validation if value is not provided and not required
54
+ if (value === undefined || value === null) {
55
+ continue;
56
+ }
57
+
58
+ // Type validation
59
+ if (rules.type === 'integer' || rules.type === 'number') {
60
+ const numValue = Number(value);
61
+ if (isNaN(numValue)) {
62
+ errors.push(`Parameter [${paramName}] must be a valid ${rules.type}.`);
63
+ continue;
64
+ }
65
+
66
+ if (rules.type === 'integer' && !Number.isInteger(numValue)) {
67
+ errors.push(`Parameter [${paramName}] must be an integer.`);
68
+ continue;
69
+ }
70
+
71
+ // Min/max validation for numbers
72
+ if (rules.min !== undefined && numValue < rules.min) {
73
+ errors.push(`Parameter [${paramName}] must be at least ${rules.min}.`);
74
+ }
75
+ if (rules.max !== undefined && numValue > rules.max) {
76
+ errors.push(`Parameter [${paramName}] must be at most ${rules.max}.`);
77
+ }
78
+ } else if (rules.type === 'string') {
79
+ if (typeof value !== 'string') {
80
+ errors.push(`Parameter [${paramName}] must be a string.`);
81
+ continue;
82
+ }
83
+
84
+ // Length validation for strings
85
+ if (rules.minLength !== undefined && value.length < rules.minLength) {
86
+ errors.push(`Parameter [${paramName}] must be at least ${rules.minLength} characters.`);
87
+ }
88
+ if (rules.maxLength !== undefined && value.length > rules.maxLength) {
89
+ errors.push(`Parameter [${paramName}] must be at most ${rules.maxLength} characters.`);
90
+ }
91
+
92
+ // Format validation
93
+ if (rules.format) {
94
+ const formatPatterns = {
95
+ 'email': /^[^\s@]+@[^\s@]+\.[^\s@]+$/,
96
+ 'url': /^https?:\/\/.+/i,
97
+ 'ip': /^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$|^([0-9a-fA-F]{1,4}:){7}[0-9a-fA-F]{1,4}$/,
98
+ 'date': /^\d{4}-\d{2}-\d{2}$/,
99
+ 'hexColor': /^#?([0-9a-fA-F]{3}|[0-9a-fA-F]{6})$/
100
+ };
101
+
102
+ if (formatPatterns[rules.format] && !formatPatterns[rules.format].test(value)) {
103
+ errors.push(`Parameter [${paramName}] must be a valid ${rules.format}.`);
104
+ }
105
+ }
106
+ } else if (rules.type === 'boolean') {
107
+ if (typeof value !== 'boolean' && value !== 'true' && value !== 'false') {
108
+ errors.push(`Parameter [${paramName}] must be a boolean.`);
109
+ }
110
+ } else if (rules.type === 'array') {
111
+ if (!Array.isArray(value)) {
112
+ errors.push(`Parameter [${paramName}] must be an array.`);
113
+ }
114
+ }
115
+
116
+ // Enum validation
117
+ if (rules.enum && Array.isArray(rules.enum)) {
118
+ if (!rules.enum.includes(value)) {
119
+ errors.push(`Parameter [${paramName}] must be one of: ${rules.enum.join(', ')}.`);
120
+ }
121
+ }
122
+ }
123
+
124
+ if (errors.length > 0) {
125
+ throw new Error(`Validation failed: ${errors.join(' ')} See documentation: https://docs.apiverve.com/ref/balancesheet`);
126
+ }
127
+ }
128
+
129
+ async execute(query, callback) {
130
+ // Handle different argument patterns
131
+ if(arguments.length === 0) {
132
+ // execute() - no args
133
+ query = {};
134
+ callback = null;
135
+ } else if(arguments.length === 1) {
136
+ if (typeof query === 'function') {
137
+ // execute(callback)
138
+ callback = query;
139
+ query = {};
140
+ } else {
141
+ // execute(query)
142
+ callback = null;
143
+ }
144
+ } else {
145
+ // execute(query, callback)
146
+ if (!query || typeof query !== 'object') {
147
+ throw new Error('Query parameters must be provided as an object.');
148
+ }
149
+ }
150
+
151
+ // Validate parameters against schema rules
152
+ this.validateParams(query);
153
+
154
+ const method = 'GET';
155
+ const url = method === 'POST' ? this.baseURL : this.constructURL(query);
156
+
157
+ try {
158
+ const response = await axios({
159
+ method,
160
+ url,
161
+ headers: {
162
+ 'Content-Type': 'application/json',
163
+ 'x-api-key': this.APIKey,
164
+ 'auth-mode': 'npm-package'
165
+ },
166
+ data: method === 'POST' ? query : undefined
167
+ });
168
+
169
+ const data = response.data;
170
+ if (callback) callback(null, data);
171
+ return data;
172
+ } catch (error) {
173
+ let apiError;
174
+
175
+ if (error.response && error.response.data) {
176
+ apiError = error.response.data;
177
+ } else if (error.message) {
178
+ apiError = { error: error.message, status: 'error' };
179
+ } else {
180
+ apiError = { error: 'An unknown error occurred', status: 'error' };
181
+ }
182
+
183
+ if (callback) {
184
+ callback(apiError, null);
185
+ return; // Don't throw if callback is provided
186
+ }
187
+
188
+ throw apiError;
189
+ }
190
+ }
191
+
192
+ constructURL(query) {
193
+ let url = this.baseURL;
194
+
195
+ if(query && typeof query === 'object')
196
+ {
197
+ if (Object.keys(query).length > 0) {
198
+ const queryString = Object.keys(query)
199
+ .map(key => `${encodeURIComponent(key)}=${encodeURIComponent(query[key])}`)
200
+ .join('&');
201
+ url += `?${queryString}`;
202
+ }
203
+ }
204
+ return url;
205
+ }
206
+
207
+ }
208
+
209
+ module.exports = balancesheetWrapper;
package/package.json CHANGED
@@ -1,6 +1,47 @@
1
1
  {
2
2
  "name": "@apiverve/balancesheet",
3
- "version": "0.0.0-stage",
4
- "stub": true,
5
- "description": "Temporary package placeholder for staged publishing"
3
+ "version": "1.2.3",
4
+ "description": "Balance Sheet is a stock balance sheet API that returns the statement of financial position for a US public company by ticker - assets, liabilities and shareholders' equity - straight from SEC filings: current assets, cash, receivables, current liabilities, equity and more. Paid plans add total assets and liabilities, long-term debt, and liquidity and leverage ratios like current ratio, quick ratio and debt-to-equity.",
5
+ "main": "index.js",
6
+ "types": "index.d.ts",
7
+ "sideEffects": false,
8
+ "engines": {
9
+ "node": ">=18.0.0"
10
+ },
11
+ "files": [
12
+ "index.js",
13
+ "index.d.ts",
14
+ "LICENSE"
15
+ ],
16
+ "scripts": {
17
+ "test": "mocha",
18
+ "example": "node examples/basic.js"
19
+ },
20
+ "repository": {
21
+ "type": "git",
22
+ "url": "git+https://github.com/apiverve/balancesheet-api.git",
23
+ "directory": "npm"
24
+ },
25
+ "keywords": [
26
+ "balance sheet api", "stock balance sheet api", "total assets and total liabilities api", "assets and liabilities data api", "statement of financial position api"
27
+ ],
28
+ "author": {
29
+ "name": "APIVerve",
30
+ "email": "hello@apiverve.com",
31
+ "url": "https://apiverve.com"
32
+ },
33
+ "license": "MIT",
34
+ "bugs": {
35
+ "url": "https://github.com/apiverve/balancesheet-api/issues"
36
+ },
37
+ "homepage": "https://apiverve.com/marketplace/balancesheet?utm_source=npm&utm_medium=referral&utm_content=homepage",
38
+ "devDependencies": {
39
+ "mocha": "^11.0.1",
40
+ "chai": "^5.1.2",
41
+ "dotenv": "^16.4.7"
42
+ },
43
+ "dependencies": {
44
+ "axios": "1.13.2",
45
+ "form-data": "^4.0.1"
46
+ }
6
47
  }