@takinprofit/alpaca-ts/README.md

Type-safe Alpaca REST API client for TypeScript and Node.js

# alpaca-ts

A type-safe Alpaca REST API client for TypeScript and Node.js.

## Features

- Complete TypeScript typings for all Alpaca REST API endpoints and models
- ESM and CommonJS support
- Automatically generated from the official Alpaca OpenAPI specification
- Zero runtime dependencies
- Full type safety and autocompletion in your IDE

## Installation

```bash
npm install @takinprofit/alpaca-ts
```

## Usage

```typescript
import { Endpoints } from '@takinprofit/alpaca-ts';

// All endpoints and their parameters are fully typed
type GetAccount = Endpoints.get_GetAccount;
type GetPositions = Endpoints.get_GetPositions;
```

## Development

This package is automatically generated from Alpaca's OpenAPI specification using the following tools:

1. Generate TypeScript types using `typed-openapi`
2. Bundle using `pkgroll`
3. Format and lint using `biome`

To regenerate the API client:

```bash
npm run generate
```

## Credits

This package wouldn't be possible without these excellent open source projects:

- [typed-openapi](https://github.com/astahmer/typed-openapi) - TypeScript code generation
- [pkgroll](https://github.com/privatenumber/pkgroll) - Zero-config package bundling
- [Biome](https://biomejs.dev) - Formatting and linting
- [TypeScript](https://www.typescriptlang.org) - Type system and compilation

## License

MIT License

Copyright (c) 2024 Takin Profit LLC

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:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

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.