Skip to Content
BlitzPulse docs are live. Looking for Blitz Global? Visit https://blitzglobalcapital.com.
Api ReferenceBrokers API

Brokers API

Auto-generated from openapi-snapshot.json. Do not edit by hand — changes are overwritten by scripts/docs/generate_api_reference.py.

4 endpoints in this group.

POST /api/broker-accounts/manual

Create Manual Broker Account

Insert a broker_type='manual' row into broker_accounts.

The operator owns the data — there’s no broker integration. We DO NOT store the account number encrypted because the operator entered it as a label only; it’s not a credential.

Request body: application/json

Responses

CodeDescription
201Successful Response
422Validation Error

DELETE /api/broker-accounts/manual/{account_id}

Delete Manual Broker Account

Soft-delete a manual broker account by archiving its row.

Parameters

NameInTypeRequiredDescription
account_idpathintegerrequired

Responses

CodeDescription
204Successful Response
422Validation Error

PATCH /api/broker-accounts/manual/{account_id}

Patch Manual Broker Account

Update a tenant-scoped broker_type='manual' broker account.

Parameters

NameInTypeRequiredDescription
account_idpathintegerrequired

Request body: application/json

Responses

CodeDescription
200Successful Response
422Validation Error

GET /api/brokers/registry

Get User Broker Registry

Return the user-facing broker picker list.

Responses

CodeDescription
200Successful Response