friday-sdk/README.md

Official JavaScript/TypeScript SDK for the Friday API

# Friday JS/TS SDK

Official JavaScript/TypeScript SDK for the Friday API.

## Default Base URL

`FridayClient` now defaults to:

`https://api.fridaydata.com`

## Quick Start

```ts
import { FridayClient } from "friday-sdk";

const client = new FridayClient({ apiKey: "your-api-key" });

const status = await client.get_status();
const profile = await client.getProfile({
  profileUrl: "https://www.linkedin.com/in/username/",
  realtime: false,
  prompt: "Summarize the profile",
  customSchema: '{"summary":"string"}',
});
```

## Endpoint Coverage

`FridayClient` now includes methods for all current API routes:

- Core: `get_status`, `getProfile`, `analyzeCompany`, `scrape`, `crawl`, `extract`, `search`
- Reddit: `redditSearch`, `redditSubredditSearch`, `redditUserPosts`
- X/Twitter: `scrapeTwitterProfile`, `xLatest`, `xSearch`, `xNews`, `xAbout`, `xWhoami`
- LinkedIn Posts: `linkedinProfilePosts`, `linkedinCompanyPosts`
- Admin: `createApiKey`, `revokeApiKey`, `resetRateLimits`
- User/JWT: `createUserApiKey`, `getUserApiKeys`, `getSubscriptionPlans`, `regenerateUserApiKey`

## JWT Endpoints

```ts
const created = await client.createUserApiKey({
  keyType: "pro",
  jwtToken: "<supabase-jwt>",
});

const keys = await client.getUserApiKeys("<supabase-jwt>");

const regenerated = await client.regenerateUserApiKey({
  oldKey: "old_api_key",
  jwtToken: "<supabase-jwt>",
});
```