Home
HomeGuidesRecipesAPI ReferenceGraphQLChangelogDiscussionsv2023.08
HomeLog In
API Reference
These docs are for v2023.08. Click to read the latest docs for v2023.12.

Create a Journal

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

A journal can be JNLC (move cash) or JNLS (move shares), dictated by entry_type. Generally, journal requests are subject to approval and starts from the pending status. The status changes are propagated through the Event API. Under certain conditions agreed for the partner, such journal transactions that meet the criteria are executed right away.

Body Params
uuid
required
length ā‰„ 1

The account_id you wish to journal to

uuid
required
length ā‰„ 1

The account_id you wish to journal from

string
enum
required

This enum represents the various kinds of Journal alpaca supports.

Current values are:

  • JNLC

    Journal Cash between accounts

  • JNLS

    Journal Securities between accounts

Allowed:
string

Required if entry_type = JNLC

string

Required if entry_type = JNLS

string

Required if entry_type = JNLS

string
length ā‰¤ 1024

Max 1024 characters. Can include fixtures for amounts that are above the transaction limit

string
length ā‰¤ 255

Max 255 characters. See more details about Travel Rule in our main documentation.

string
length ā‰¤ 255

Max 255 characters. See more details about Travel Rule in our main documentation.

string
length ā‰¤ 255

Max 255 characters. See more details about Travel Rule in our main documentation.

string
length ā‰¤ 255

Max 255 characters. See more details about Travel Rule in our main documentation.

date-time

RFC 3339 format. See more details about Travel Rule in our main documentation.

string
Responses

Updated over 2 years 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 over 2 years ago

Ā©2023. Prime Industries, Services, and Trinkets LLC. We are not responsible