How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Alpaca Journals API

The Journals API from Alpaca — 4 operation(s) for journals.

Alpaca Journals API is one of 17 APIs that Alpaca publishes on the APIs.io network, described by a machine-readable OpenAPI specification and an AsyncAPI event-driven specification.

Tagged areas include Journals. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an AsyncAPI specification.

This API exposes 5 operations across 4 paths, and defines 9 schemas. It is described by OpenAPI 3.2.0, at version 1.0.0.

Requests are made against 2 base URLs: https://broker-api.sandbox.alpaca.markets, https://broker-api.alpaca.markets.

5 operations 4 paths 9 schemas 1 DELETE2 GET2 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.0.0
Base URL
https://api.alpaca.markets/v2
Authentication
HTTP Basic
Terms of Service
Resource Areas
1

Authentication & Security 1

Alpaca Journals API declares 1 security scheme for authenticating requests. It accepts HTTP basic authentication (BasicAuth). By default, every request must be authenticated.

Paths & Operations 5

Across 4 paths, the API surfaces 5 operations — 1 DELETE, 2 GET, 2 POST. Each is listed below with its method, path, parameters, and response codes.

Journals 5
GET
/v1/events/journals/status
Subscribe to journal events (SSE).
subscribeToJournalStatusSSE 4 params → 200
GET
/v1/journals
Return a list of requested journals.
getAllJournals 6 params → 200
POST
/v1/journals
Create a Journal.
createJournal body → 200400403404
DELETE
/v1/journals/{journal_id}
Cancel a pending journal.
deleteJournalById 1 param → 204404422
POST
/v1/journals/batch
Create a Batch Journal Transaction (One-to-Many)
createBatchJournal body → 200

Schemas 9

The contract defines 9 schemas that model the data the API accepts and returns. The most detailed are CreateJournalRequest (12 properties), JNLC (7 properties), JournalStatusEvent (6 properties), BatchJournalRequest (4 properties). Each schema is shown below with its type and property counts.

CreateJournalRequest
object
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 Fixtur…
12 properties 3 required
JournalStatusEvent
object
Represents a change in a Journal's status, sent over the events streaming api.
6 properties 6 required
JNLS
object
Journal information specific to securities transfers. This field is required for Journals with an entrytype of jnls (securities transfers), but will be null fo…
3 properties 3 required
BatchJournalResponse
A Journal object with an extra attribute errormessage in the case when a specific account fails to receive a journal.
BatchJournalRequest
object
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 man…
4 properties 3 required
JNLC
object
Journal information specific to cash transfers. This field is required for Journals with an entrytype of jnlc (cash transfers), but will be null for those with…
7 properties 1 required
JournalEntryType
string
This enum represents the various kinds of Journal alpaca supports. Current values are: - JNLC Journal Cash between accounts - JNLS Journal Securities between a…
Journal
Represents a cash or security transfer between accounts, as specified by the entrytype parameter.
JournalStatus
string
Represents the status that a Journal instance can be in. Current Values: - pending - canceled - executed - queued - rejected - deleted

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

alpaca-journals-api-openapi.yml Raw ↑

Other APIs Alpaca publishes across the network.

Alpaca Trading API
Alpaca OAuth API
Alpaca Accounts API
Alpaca Assets API
Alpaca Calendar API
Alpaca Clock API
Alpaca Corporate Actions API
Alpaca Crypto Pricing Data API API
Alpaca Documents API
Alpaca Events API
Alpaca Funding API
Alpaca Logo API
Where this information came from

This is an independent, third-party profile of Alpaca Journals API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.