API Reference
Trading DashboardBroker Dashboard

Create a Batch Journal Transaction (One-to-Many)

post
https://broker-api.sandbox.alpaca.markets/v1/journals/batch

You can create a batch of journal requests by using this endpoint. This is enabled on JNLC type Journals for now only.

Every single request must be valid for the entire batch operation to succeed.

In the case of a successful request, the response will contain an array of journal objects with an extra attribute error_message in the case when a specific account fails to receive a journal.

Body Params

Journals API allows you to move cash or securities from one account to another.

This model represents the fields you can specify when creating a request of many Journals out of one account to many others at once.

string
enum
required

Only supports JNLC for now

Allowed:
uuid
required

The account id that is the originator of the funds being moved. Most likely is your Sweep Firm Account

string

Journal description, gets returned in the response

entries
array of objects
required
length ≥ 1

An array of objects describing to what accounts you want to move funds into and how much to move into for each account

entries*
uuid
required

The ID of the account that you want to journal funds into

string
required

Journal amount in USD

string

Currency

string

Only valid for JNLC journals. Null for JNLS. Max 255 characters.

string

Only valid for JNLC journals. Null for JNLS.max 255 characters

string

Only valid for JNLC journals. Null for JNLS.max 255 characters

string

Only valid for JNLC journals. Null for JNLS.max 255 characters

date-time
string

Journal entry description, gets returned in the response

Headers
string

An optional idempotency key can be used to ensure that a request is processed only once.

Responses

422

Unprocessable entity. The request is being rejected because of idempotency key violation: at least one field in the request has changed from the first request.

Updated 7 months ago

Language
Credentials
Basic
base64
:
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 7 months ago