> ## Documentation Index
> Fetch the complete documentation index at: https://docs.royaltyport.com/llms.txt
> Use this file to discover all available pages before exploring further.
# Introduction
> Access your Royaltyport data programmatically with the official Node.js SDK.
The `@royaltyport/sdk` is the official Node.js client for the Royaltyport API. It provides access to projects, contracts, catalog data, CRM records, statements, and cross-resource search with built-in pagination, error handling, and automatic retries.
The SDK is written in TypeScript and ships with full type definitions — you get autocomplete and type checking out of the box.
## Requirements
* Node.js >= 18.0.0
## Installation
```bash theme={null}
npm install @royaltyport/sdk
```
## Quick Start
```bash theme={null}
npm install @royaltyport/sdk
```
```js theme={null}
import { Royaltyport } from '@royaltyport/sdk';
const royaltyport = new Royaltyport({
apiKey: 'rp_your_token_here',
});
```
```js theme={null}
const { data: projects } = await royaltyport.projects.list();
for (const project of projects) {
console.log(project.name);
}
```
***
## Configuration
The `Royaltyport` constructor accepts a configuration object:
```js theme={null}
import { Royaltyport } from '@royaltyport/sdk';
const royaltyport = new Royaltyport({
apiKey: 'rp_your_token_here',
baseUrl: 'https://api.royaltyport.com', // optional
});
```
| Parameter | Type | Required | Default | Description |
| --------- | ---------- | -------- | ----------------------------- | --------------------------------------------------- |
| `apiKey` | `string` | Yes | — | API token (`rp_` prefix) or OAuth access token |
| `baseUrl` | `string` | No | `https://api.royaltyport.com` | Custom API base URL |
| `fetch` | `function` | No | `globalThis.fetch` | Custom fetch implementation for testing or proxying |
***
## Response Format
All methods return a response object containing the data and rate limit information:
```js theme={null}
const response = await royaltyport.projects.list();
console.log(response.data); // the requested data
console.log(response.rateLimit); // { limit: 100, remaining: 99, reset: 1711929600 }
```
| Field | Description |
| --------------------- | -------------------------------------------- |
| `data` | The response payload (type varies by method) |
| `rateLimit.limit` | Maximum requests allowed per window |
| `rateLimit.remaining` | Requests remaining in the current window |
| `rateLimit.reset` | Unix timestamp when the window resets |
***
## Automatic Retries
The SDK automatically retries requests that fail with `429` (rate limit) or `5xx` (server error) status codes, up to 3 times with exponential backoff. No configuration is needed.
***
## Available Resources
API tokens, OAuth tokens, and environment variables.
Error classes, retry behavior, and status codes.
Paginated results and iteration patterns.
List and retrieve projects.
List and retrieve artists.
List and retrieve writers.
List and retrieve recordings.
List and retrieve compositions.
List and retrieve entities.
List and retrieve relations.
List, retrieve, upload, download, and track contracts.
List, retrieve, upload, download, and track statements.
Search across all resource types in a project.