@alpaca-open-api/core 0.1.0-rc.0 → 1.0.1

package/README.md

@@ -0,0 +1,64 @@
+<h1 align="center">🦙 @alpaca-open-api/core</h1>
+
+<p align="center">Typed TypeScript fetch clients + model types for the <a href="https://alpaca.markets/">Alpaca Markets</a> API (Trading, Market Data, Broker, AuthX), generated from the official OpenAPI specs with <a href="https://orval.dev/">Orval</a>.</p>
+
+<p align="center">
+<a href="https://www.npmjs.com/package/@alpaca-open-api/core"><img src="https://img.shields.io/npm/v/@alpaca-open-api/core?logo=npm&color=CB3837" alt="npm"></a>
+<a href="https://github.com/yagop/alpaca-open-api/blob/main/LICENSE"><img src="https://img.shields.io/badge/license-MIT-blue" alt="license: MIT"></a>
+</p>
+
+- ⚡ Fully typed request/response types straight from the specs.
+- 🛰️ One namespace per API: `tradingApi`, `dataApi`, `brokerApi`, `authxApi`.
+- 🔒 Every call routes through one small shared mutator that resolves host + auth per API.
+
+## Install
+
+```bash
+npm install @alpaca-open-api/core
+```
+
+## Usage
+
+Credentials and environment come from env vars (`ALPACA_API_KEY`, `ALPACA_API_SECRET`, `ALPACA_ENV`; **live by default**), read by the shared mutator.
+
+```ts
+import { tradingApi, dataApi, tradingModel } from '@alpaca-open-api/core';
+
+// Each call returns { data, status, headers }; `data` is typed from the spec.
+const { data: account } = await tradingApi.getAccount();
+console.log(account?.cash);
+
+const { data: quote } = await dataApi.stockLatestQuoteSingle('AAPL', { feed: 'iex' });
+console.log(quote?.quote?.ap);
+
+// Place an order (uses the live account unless ALPACA_ENV=paper):
+await tradingApi.postOrder({ symbol: 'AAPL', side: 'buy', qty: '1', type: 'market', time_in_force: 'day' });
+
+// Schema types are exported per API as `*Model` namespaces:
+type Account = tradingModel.Account;
+```
+
+Client namespaces: `tradingApi`, `dataApi`, `brokerApi`, `authxApi`; matching model (schema) types: `tradingModel`, `dataModel`, `brokerModel`, `authxModel`. `makeMutator` and `API_ROUTING` are also exported if you need to customize routing.
+
+## Configuration
+
+| Variable | Required | Default | Purpose |
+| --- | :---: | --- | --- |
+| `ALPACA_API_KEY` | ✅ | — | API key (live and paper keys are different) |
+| `ALPACA_API_SECRET` | ✅ | — | API secret |
+| `ALPACA_ENV` | | `live` | `paper` or `live`. Selects paper/live (trading) and sandbox/production (broker, authx). |
+
+> ⚠️ Defaults to **`live`** (real money/orders). Set `ALPACA_ENV=paper` (with your paper keys) to test safely.
+
+## Documentation
+
+Full docs, the MCP server ([`@alpaca-open-api/mcp`](https://www.npmjs.com/package/@alpaca-open-api/mcp)), and source:
+**https://github.com/yagop/alpaca-open-api**
+
+## Disclaimer
+
+Unofficial and **not affiliated with, endorsed by, or sponsored by Alpaca**. Provided "as is", without warranty of any kind. Nothing here is financial, investment, or trading advice. Trading involves substantial risk of loss — always test with paper trading (`ALPACA_ENV=paper`) first.
+
+## License
+
+[MIT](https://github.com/yagop/alpaca-open-api/blob/main/LICENSE)

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@alpaca-open-api/core",
-  "version": "0.1.0-rc.0",
+  "version": "1.0.1",
   "description": "Typed fetch clients and types for the Alpaca Markets API, generated from the official OpenAPI specifications with Orval",
   "type": "module",
   "main": "./dist/index.js",
@@ -33,11 +33,11 @@
   "license": "MIT",
   "repository": {
     "type": "git",
-    "url": "git+https://github.com/yagop/alpaca-api-ts.git",
+    "url": "git+https://github.com/yagop/alpaca-open-api.git",
     "directory": "packages/core"
   },
-  "homepage": "https://github.com/yagop/alpaca-api-ts#readme",
-  "bugs": "https://github.com/yagop/alpaca-api-ts/issues",
+  "homepage": "https://github.com/yagop/alpaca-open-api#readme",
+  "bugs": "https://github.com/yagop/alpaca-open-api/issues",
   "publishConfig": {
     "access": "public"
   },

package/dist/generated/broker/model/transferTiming.d.ts

@@ -1,20 +0,0 @@
-/**
- * Generated by orval v8.15.0 🍺
- * Do not edit manually.
- * Broker API
- * Open brokerage accounts, enable stock, options and crypto trading. Manage the ongoing user experience and brokerage customer lifecycle with the Alpaca Broker API
- * OpenAPI spec version: 1.1.1
- */
-/**
- * Only `immediate` is currently supported.
- *
- * values:
- *
- * - **immediate**
- *
- * - **next_day**
- */
-export type TransferTiming = typeof TransferTiming[keyof typeof TransferTiming];
-export declare const TransferTiming: {
-    readonly immediate: "immediate";
-};