@crl-technologies/sdk/README.md

CRL White Label API - TypeScript SDK with HMAC authentication

# @crl/sdk - TypeScript SDK

Official TypeScript/JavaScript SDK for CRL White Label API.

## Installation
```bash
npm install @crl/sdk
```

## Quick Start
```typescript
import { CRLApiClient } from '@crl/sdk';

const client = new CRLApiClient({
  keyId: process.env.CRL_KEY_ID!,
  secretKey: process.env.CRL_SECRET_KEY!
});

const result = await client.calculateLong(150.0, 160.0, 155.0, 5.0, 3.0);
console.log(`P&L: ${result.pnl}`);
```

## Features

- ✅ HMAC-SHA256 authentication
- ✅ Promise-based async API
- ✅ TypeScript type definitions
- ✅ Automatic retries
- ✅ Idempotency support

## Documentation

https://github.com/ARGltd/crl-white-label-api/blob/main/docs/SDK_README.md

## Support

support@crl-technologies.com

## License

Proprietary - For authorized CRL partners only

## Best-Execution API (v1.0.1+)
```typescript
// Export execution data
const data = await client.exportBestExecution({
  startDate: '2025-10-01',
  endDate: '2025-10-27',
  format: 'json'
});

// Get venue performance
const venues = await client.getVenuePerformance('2025-10-01');

// Export compliance data
const compliance = await client.exportCompliance('2025-10-01', '2025-10-27');
```

### CL-16 Compliance
- MiFID II Article 27 ✅
- FINRA Rule 5310 ✅
- FCA COBS 11.2A ✅