Skip to content

Cookbook ​

Recipes for building a trading CRM and terminals on the SDK. Every recipe is a TypeScript file in docs/crm/snippets that the test run compiles against the real SDK types, so the code here is the code that works.

RecipeSideYou learn
Onboard a client end to endstaffclient → approve → account → link → first deposit
Call log and client timelinestaffcomments, calls, journal history
Deposits and withdrawalsstaffidempotent money operations, refusals
Self sign-up to approvalbothtrader registration, live application queue
Show only what staff may usestaffrights, group scope, navigator
Live pricestraderbinary price frames as exact decimals
Live dealer dashboardstaffREST snapshot + socket events + resync
Place a tradetraderrequest ids, requotes, timeouts
Run a reportstaffreport jobs, socket progress, polling fallback
Read every page of a listanypaging with an async generator

All recipes share one client:

ts
import { Staff, Trader } from "@hybrid-solutions-09/noviqa-sdk";

// CRM / back office (admin and manager terminals). Browsers use cookies; apps use { type: "jwt" }.
export const staff = new Staff({ baseUrl: "", auth: { type: "session" } });

// Trader terminal (web, desktop, mobile, API).
export const trader = new Trader({ baseUrl: "", auth: { type: "session" } });