DOCSEARCHbyAlgolia
Submit Docs

Brokerize API Documentation

website·Indexed 32 days ago

https://developer.brokerize.com

Developer documentation for the Brokerize API, featuring endpoints for order management (CancelOrder, ChangeOrder), trading operations (PrepareTrade, GetQuote, CreateTradeChallenge), session and authentication handling (AddSession, ConfirmOAuth, EnableSessionTan), and administrative client configuration.

Tokens
59.6K
Snippets
351
Records
598
Agent score
53%

What's inside Brokerize

  1. Overview of brokerize API capabilities

    The brokerize API is a REST-based interface that provides standardized endpoints for integrating brokerage services into external applications. Key functional areas include:

    • Order Management: Creating, querying, and managing order transactions.
    • Account Services: Accessing portfolio and account information.
    • User Administration: Managing user profiles and permissions.
    • Market Data: Accessing market data and transaction histories.

  2. Overview of the brokerize/elements UI library

    The brokerize/elements library is a framework-agnostic UI component library providing ready-to-use trading interface components. It is built using standard web components, making it compatible with React, Vue, Angular, and vanilla JavaScript. The library provides pre-built UI components and supports full visual customization through a unified theme configuration system.

  3. Overview of brokerize API capabilities

    The brokerize API is a REST-based interface that provides access to brokerage services, accounts, orders, and market data. It is designed for scalable integration into external applications and supports the following core use cases:

    • Creating, querying, and managing order requests
    • Accessing portfolio and account information
    • Managing user profiles and permissions
    • Retrieving market data and transaction histories

  4. Overview of the brokerize ecosystem components

    The brokerize ecosystem provides a multi-brokerage solution consisting of several core components:

    • brokerize - Client: A JavaScript/TypeScript library for API communication, handling authentication, session management, and real-time updates via WebSockets.
    • brokerize - Elements: Framework-agnostic Web Components (compatible with React, Vue, Angular, Vanilla JS) providing pre-built UI components for trading interfaces with customizable themes.
    • brokerize - Pages: Pre-built user flows based on brokerize/elements, available as sub-domains or hosted by brokerize (e.g., tradingpartner.brokerize.com).
    • brokerize - API: A RESTful API and WebSocket streams for brokerage functions with OpenAPI documentation and multi-broker support.
    • brokerize - Trade Drafts: A tool for automating trade proposals, typically used by bots or private users for automated position management.

  5. Overview of the brokerize/elements UI library

    The brokerize/elements library provides ready-to-use trading interface components. It is designed to be framework-agnostic, meaning it works with React, Vue, Angular, or Vanilla JavaScript, and utilizes standard Web Components for integration. The library includes pre-built UI components and supports full visual customization via theme configurations.

  6. Overview of the brokerize client library

    The brokerize client is a JavaScript/TypeScript library designed to simplify the integration of the brokerize API. It abstracts low-level details such as authentication, error handling, and data validation, providing a type-safe interface for brokerage functions. Key features include automatic token and clientId management, robust error handling with retry logic, WebSocket support for real-time updates, and full TypeScript type definitions.

  7. Overview of the brokerize Ecosystem components

    The brokerize ecosystem provides a multi-brokerage solution consisting of the following core components:

    • @brokerize - Client: A JS/TS library for API communication, authentication, session management, and real-time updates via WebSockets.
    • @brokerize - Elements: Framework-agnostic Web Components (React, Vue, Angular, Vanilla JS) for trading interfaces with customizable themes.
    • brokerize - Pages: Pre-built click flows based on Elements, available as a sub-domain or hosted by brokerize.
    • brokerize - API: A RESTful API and WebSocket streams for brokerage functions with multi-broker support.
    • brokerize - Trade Drafts: A system for automated generation of trade suggestions, typically used by bots for private users.

  8. Overview of the brokerize JavaScript/TypeScript client

    The @brokerize/client-js library provides a type-safe interface for integrating the brokerize API. It abstracts low-level details such as authentication, error handling, data validation, and token management. Key features include WebSocket support for real-time updates and robust retry logic for error-resistant communication.

  9. Overview of brokerize Multi-Brokerage API

    The brokerize API provides a unified interface to implement multi-brokerage functionality across different partner brokers. It abstracts the varying feature sets and legal constraints of individual brokers to create a consistent trading experience. A demo broker is available for development and QA testing without requiring actual broker logins.

  10. Use the Demo Broker for platform testing

    The Demo Broker is a simulated broker module enabled by default for all new clients. It allows developers to demonstrate Brokerize functionality, perform automated testing of frontend integrations, and develop features without requiring a connection to a real broker or executing real transactions.

  11. Manage anonymous users with the Guest User Model

    All end users access the API as anonymous guest users. Guest users are created via the CreateGuestUser endpoint. By default, guest users are temporary (typically ~1 day), though lifetimes can be renewed during activity. To allow users to recover their data long-term without revealing their identity, brokerize uses randomly generated RecoveryPhrases which users can enter to regain account access.

  12. Manage modal dialogs using ModalService

    The ModalService interface provides a centralized mechanism to display various types of modal dialogs, including security information, confirmation prompts, custom dialogs, session TAN authentication, and toast notifications. It allows for activation, deactivation, and the ability to override default method implementations for customization.