tradytics 0.1.1 → 0.1.3

package/README.md

@@ -1,5 +1,5 @@
 <p align="center">
-  <a href="https://tradytics.com/docs"><img src="https://tradytics.com/api/v2/og/sdk.png" alt="Tradytics: one API for options flow, dark pools and the market" width="100%"></a>
+  <a href="https://tradytics.com/docs"><img src="https://tradytics.com/api/v2/og/sdk.png?v=2" alt="Tradytics: one API for options flow, dark pools and the market" width="100%"></a>
 </p>
 
 # Tradytics for JavaScript
@@ -27,16 +27,13 @@ npm install tradytics
 
 ## Quickstart
 
-The API is part of Tradytics Pro. Make a key at [tradytics.com/developer/keys](https://tradytics.com/developer/keys), then:
-
-```bash
-export TRADYTICS_API_KEY="tdy_..."
-```
+The API is part of Tradytics Pro. Make a key at [tradytics.com/developer/keys](https://tradytics.com/developer/keys) and pass it in, or export it as `TRADYTICS_API_KEY`. A key you pass wins over the environment.
 
 ```js
 import Tradytics from 'tradytics'
 
-const client = new Tradytics() // reads TRADYTICS_API_KEY
+const client = new Tradytics('tdy_...') // or new Tradytics({ apiKey: 'tdy_...' })
+// or set TRADYTICS_API_KEY and call new Tradytics()
 
 const flow = await client.options.flow({ symbol: 'NVDA', min_premium: 1_000_000, opening: true })
 for (const p of flow.data) console.log(p.time, p.symbol, p.type, p.strike, p.expiry, p.premium)

package/index.d.ts

@@ -18,7 +18,8 @@ export interface ClientOptions {
 }
 
 export declare class Tradytics {
-  constructor(options?: ClientOptions)
+  /** The key you pass (a string, or `{ apiKey }`) wins; else TRADYTICS_API_KEY; else it throws `missing_key`. */
+  constructor(options?: ClientOptions | string)
   symbols: Symbols
   market: Market
   options: Options

package/index.js

@@ -7,8 +7,10 @@ import { VERSION } from './version.js'
 export const BASE_URL = 'https://tradytics.com/api/public/v1'
 export { TradyticsError, VERSION }
 
+// The key: the one passed in (new Tradytics('tdy_...') or { apiKey }), else TRADYTICS_API_KEY, else an error.
 export class Tradytics {
-  constructor({ apiKey = globalThis.process?.env?.TRADYTICS_API_KEY, baseUrl = BASE_URL, timeout = 30_000, maxRetries = 3 } = {}) {
+  constructor(options = {}) {
+    const { apiKey = globalThis.process?.env?.TRADYTICS_API_KEY, baseUrl = BASE_URL, timeout = 30_000, maxRetries = 3 } = typeof options === 'string' ? { apiKey: options } : options
     if (!apiKey) throw new TradyticsError(401, 'missing_key', 'Pass apiKey or set TRADYTICS_API_KEY. Make a key at https://tradytics.com/developer/keys.')
     this._t = new Transport({ apiKey, baseUrl, timeout, maxRetries, userAgent: `tradytics-node/${VERSION}` })
     for (const [name, Resource] of Object.entries(RESOURCES)) this[name] = new Resource(this._t)

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "tradytics",
-  "version": "0.1.1",
+  "version": "0.1.3",
   "description": "JavaScript and TypeScript client for the Tradytics API: options flow, dark pool prints, dealer exposure and market data.",
   "type": "module",
   "main": "./index.js",

package/version.js

@@ -1 +1 @@
-export const VERSION = '0.1.1'
+export const VERSION = '0.1.3'