Region: US
API Reference
Trading DashboardBroker Dashboard

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.

Idempotency: Reusing the same key with an identical request returns the
previously created journal without creating a duplicate. Reusing the same key with
a different request returns 422 Unprocessable Entity.

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 Journal

Fixture Rules

  • No Fixtures
    • anything below limit is executed immediately
    • anything above limit is pending until executed at EOD,
  • With Fixtures
    • any status = rejected will be rejected EOD
    • any status = pending will be pending forever

string

Required if entry_type = JNLC

string
string
length ≤ 1024

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

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:
uuid
required
length ≥ 1

The account_id you wish to journal from

string

Required if entry_type = JNLS

string

Required if entry_type = JNLS

uuid
required
length ≥ 1

The account_id you wish to journal to

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.

Headers
string
length ≤ 128

Optional client-generated key for safe retries and duplicate request detection.
This endpoint currently accepts keys up to 128 characters. Alpaca is moving toward
a 36-character maximum; new implementations should generate a unique UUIDv7 or
UUIDv4 value (36 characters including hyphens) for each logical operation. Do not
reuse a key across operations.

Responses

Updated 5 months ago

Did this page help you?
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 5 months ago

Did this page help you?