Sign in

v1

latestOpenAPI 3.0.02026-07-26166415635.8 KB
Journals

Retrieve a List Journals

Returns an array of journal objects.

get/v1/journals

Query parameters

afterstring date

By journal creation date. Format: 2020-01-01

beforestring date

By journal creation date. Format: 2020-01-01

status'pending' | 'canceled' | 'executed' | 'activity_created' | 'queued' | 'rejected' | 'deleted' | 'refused' | 'sent_to_clearing' | 'correct'

Represents the status that a Journal instance can be in.

Current Values

queued Journal in queue to be processed. Journal is not processed yet.

sent_to_clearing Journal sent to be processed by Alpaca's booking system. The journal is not processed yet.

pending Journal pending to be processed as it requires manual approval from Alpaca operations (for example due to hitting JNLC daily limits).

executed Journal executed and balances updated for both sides of the journal transaction. This is not a final status, journals can be reversed if there is an error.

activity_created Non-trade activity has been created for journal (JNLC v2-only).

rejected Journal rejected. Please try again.

canceled Journal canceled. This is a FINAL status.

refused Journal refused. Please try again.

deleted Journal deleted. This is a FINAL status.

correct Journal is corrected. Previously executed journal is cancelled and a new journal is corrected amount is created. This is a FINAL status.

See the JournalStatus model for more info

entry_type'JNLC' | 'JNLS'

JNLC or JNLS

to_accountstring uuid

The account id that received the journal

from_accountstring uuid

The account id that initiated the journal

limitinteger

The maximum number of results to return

Response

OK

Example response

[
  {
    "entry_type": "JNLS",
    "from_account": "8fjkjn-4483-4199-840f-6c5fe0b7ca24",
    "id": "h7h5g33f-ef01-4458-9a4b-9598727a406f",
    "price": "128.23",
    "qty": "2",
    "settle_date": "2020-12-24",
    "status": "executed",
    "symbol": "AAPL",
    "to_account": "3gtt65jd-6f2a-433c-8c33-17b66b8941fa"
  }
]