m8ty_client_brokerageorder

Brokerage order client for creating, managing, and validating security trading orders.

Before you start

Check the documentation of the m8ty_client_brokerageorder library.

Import all needed libraries

import 'package:dio/dio.dart';
import 'package:m8ty_client_brokerageorder/m8ty_client_brokerageorder.dart';

Client Setup

final client = M8tyClientBrokerageorder();
client.setOAuthToken('ApiOAuth2', oauthToken);

API Surface

BrokerageOrderApi

Method	Description
`createBrokerageOrder`	Create a new order
`fetchBrokerageOrderById`	Get a specific order
`searchBrokerageOrders`	List or search for all orders
`deleteBrokerageOrderById`	Delete a specific order
`validateBrokerageOrder`	Validates if a brokerage order can be created

SettingsApi

Method	Description
`getBrokerageSettings`	Retrieve brokerage user settings
`updateBrokerageSettings`	Update brokerage user settings

How to perform different tasks

Here some examples how the dart client can be used

Create a new brokerage order

final client = M8tyClientBrokerageorder();
client.setOAuthToken('ApiOAuth2', oauthToken);

final api = client.getBrokerageOrderApi();

try {
  final response = await api.createBrokerageOrder(
    createBrokerageOrderRequestModel: CreateBrokerageOrderRequestModel((b) {
      // set required fields
    }),
  );
  print('Order created: ${response.data}');
} on DioException catch (e) {
  throw Exception(
    'Request failed (status: ${e.response?.statusCode}): ${e.response?.data}',
  );
}

Search for all orders

final client = M8tyClientBrokerageorder();
client.setOAuthToken('ApiOAuth2', oauthToken);

final api = client.getBrokerageOrderApi();
final response = await api.searchBrokerageOrders();

Validate an order before creation

final client = M8tyClientBrokerageorder();
client.setOAuthToken('ApiOAuth2', oauthToken);

final api = client.getBrokerageOrderApi();

try {
  final response = await api.validateBrokerageOrder(
    createBrokerageOrderRequestModel: CreateBrokerageOrderRequestModel((b) {
      // set required fields
    }),
  );
  print('Valid: ${response.data}');
} on DioException catch (e) {
  throw Exception(
    'Request failed (status: ${e.response?.statusCode}): ${e.response?.data}',
  );
}

Delete an order

final client = M8tyClientBrokerageorder();
client.setOAuthToken('ApiOAuth2', oauthToken);

final api = client.getBrokerageOrderApi();
await api.deleteBrokerageOrderById(brokerageOrderId: '1234');

03 June 2026