# Broker REST API (v1)

OpenAPI file: https://bump.sh/tie-tech/hub/b2b-api/doc/broker-openapi.yaml

## Description

This is version `1.0.0` of this API documentation. Last update on Sep 1, 2026.
Broker-facing JSON REST API. All URIs are prefixed with /v1.
Notes:
  - Every state changing request (POST / PATCH / DELETE) REQUIRES Idempotency-Key header (stable across retries).


## Servers

- Production: https://api.example.com/v1 (Production)

- Sandbox: https://sandbox.api.example.com/v1 (Sandbox)


## Topics

### [Authentications](https://bump.sh/tie-tech/hub/b2b-api/doc/broker-openapi/authentication.md)


## Endpoints

### [Orders](https://bump.sh/tie-tech/hub/b2b-api/doc/broker-openapi/group/endpoint-orders.md)

- [List orders for account (filtered & paginated)](https://bump.sh/tie-tech/hub/b2b-api/doc/broker-openapi/operation/operation-listorders.md)

- [Create new order](https://bump.sh/tie-tech/hub/b2b-api/doc/broker-openapi/operation/operation-createorder.md)

- [Cancel order (by order_id or client_order_id)](https://bump.sh/tie-tech/hub/b2b-api/doc/broker-openapi/operation/operation-cancelorderkey.md)

- [Amend (modify) order](https://bump.sh/tie-tech/hub/b2b-api/doc/broker-openapi/operation/operation-amendorder.md)

- [Get order by order_id](https://bump.sh/tie-tech/hub/b2b-api/doc/broker-openapi/operation/operation-getorder.md)


### [Positions](https://bump.sh/tie-tech/hub/b2b-api/doc/broker-openapi/group/endpoint-positions.md)

- [List positions](https://bump.sh/tie-tech/hub/b2b-api/doc/broker-openapi/operation/operation-listpositions.md)

- [Manual merge YES/NO positions](https://bump.sh/tie-tech/hub/b2b-api/doc/broker-openapi/operation/operation-mergepositions.md)


### [Payouts](https://bump.sh/tie-tech/hub/b2b-api/doc/broker-openapi/group/endpoint-payouts.md)

- [List settlement payouts for account](https://bump.sh/tie-tech/hub/b2b-api/doc/broker-openapi/operation/operation-listpayouts.md)


### [Events](https://bump.sh/tie-tech/hub/b2b-api/doc/broker-openapi/group/endpoint-events.md)

- [List events](https://bump.sh/tie-tech/hub/b2b-api/doc/broker-openapi/operation/operation-listevents.md)

- [Get event by ID](https://bump.sh/tie-tech/hub/b2b-api/doc/broker-openapi/operation/operation-getevent.md)


### [Markets](https://bump.sh/tie-tech/hub/b2b-api/doc/broker-openapi/group/endpoint-markets.md)

- [List markets](https://bump.sh/tie-tech/hub/b2b-api/doc/broker-openapi/operation/operation-listmarkets.md)

- [Get market by ID](https://bump.sh/tie-tech/hub/b2b-api/doc/broker-openapi/operation/operation-getmarket.md)




[Powered by Bump.sh](https://bump.sh)