Skip to main content

brokerize client

This JavaScript/TypeScript library is your key to easy and secure integration of the brokerize API. It handles complex tasks like authentication, error handling and data validation, so you can focus on your application. 🚀

Why brokerize client?​

The brokerize client makes API integration child's play. Instead of struggling with low-level details, you get a clean, type-safe interface for all important brokerage functions.

🔑 Main Advantages​

  • ⚡ Fast Integration – Few lines of code for complete functionality
  • 🔒 Secure Authentication – Automatic management of tokens and clientIds
  • 🛠️ Error-Resistant Communication – Robust error handling and retry logic
  • 📱 Real-Time Updates – WebSocket support for live data
  • 🏷️ Complete TypeScript Types – Better development experience and fewer bugs

The Role of clientId​

A central element when using the brokerize client is the so-called clientId. It serves as a unique identifier for your application and is a prerequisite for the authentication and authorization of all API calls. The clientId is assigned as part of the connection to brokerize and must be sent with every request. This ensures that data and functions are only accessible to authorized tenants.

Information on how to obtain a clientId can be found under Create Client ID.

Quick Start: Integration in 3 Steps​

Integrating the brokerize client is uncomplicated and takes only a few minutes:

1. Installation​

Add the package to your project:

npm install @brokerize/client-js

2. Initialization​

Configure the library with your API URL and clientId:

import { BrokerizeClient } from '@brokerize/client-js';

const client = new BrokerizeClient({
  apiUrl: 'https://api-preview.brokerize.com', // Or production URL
  clientId: 'YOUR_CLIENT_ID',
});

The clientId is passed directly during initialization. The library then automatically ensures that all requests are correctly signed and assigned.

3. Usage​

You can use the provided methods. Complete TypeScript type definitions make development easy.

client.createGuestUser().then(accounts => {
  // Further processing
});