Skip to main content

Technical Minimum Requirements

To ensure smooth integration with the brokerize platform, your API should meet certain technical standards. At the same time, we remain technically and functionally flexible: we can handle deviations and define individual solutions.

Core Architecture​

  • API standard: We prefer modern REST APIs with JSON communication, but we also support other protocols by agreement.
  • Connectivity: API endpoints must be reachable via the public internet (optionally secured through IP whitelisting).
  • Availability: For development and later quality assurance, a stable sandbox environment (test system) and at least one test account are required.

Security & Authentication​

Security of customer data is our top priority. brokerize never stores end users' primary login credentials (username/password).

  • OAuth2 / OpenID Connect: We recommend support for OAuth2 (e.g. Authorization Code Flow). This enables a seamless and secure user experience.
  • Alternative methods: If OAuth2 is not supported, we can also use Basic Authentication or other API-key-based approaches.
  • Token management: Support for access and refresh tokens with defined lifetimes (for OAuth2).
  • Logout: A dedicated endpoint to terminate the broker session should be available.

Core Functions​

To best meet user needs, the following capabilities should be supported:

  1. Portfolio retrieval: Query positions (holdings) and cash balances.
  2. Order management: Place buy/sell orders and retrieve current order status.
  3. Master data: Identification of securities (e.g. via ISIN or WKN).
  4. TradeTracker data: For our analysis feature "TradeTracker", specific data is needed such as timestamps (order creation createdAt, execution executedAt) and execution price. If this data is unavailable, the feature must be disabled for the integration.
Backend specifics

If your backend has technical constraints (e.g. strictly sequential processing or strict rate limits), please communicate this early. Such factors significantly influence the integration architecture.

Next Step​

If these requirements are met, you can proceed with compiling the required data and assets.