Alpaca Funding API is one of 23 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 Funding. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an AsyncAPI specification.
This API exposes
10 operations
across 7 paths,
and defines 12 schemas.
It is described by OpenAPI 3.0.0, at version 1.0.0.
Requests are made against 2 base URLs: https://broker-api.sandbox.alpaca.markets, https://broker-api.alpaca.markets.
10 operations7 paths12 schemas3 DELETE4 GET3 POST
Metadata
The identity and technical contract details declared by the specification.
Alpaca Funding API declares
1 security scheme
for authenticating requests.
It accepts HTTP basic authentication (BasicAuth).
By default, every request must be authenticated.
Paths & Operations 10
Across 7 paths, the API surfaces 10 operations — 3 DELETE, 4 GET, 3 POST. Each is listed below with its method, path, parameters, and response codes.
The contract defines 12 schemas that model the data the API accepts and returns. The most detailed are Transfer (15 properties), Bank (14 properties), ACHRelationship (10 properties), CreateBankRequest (9 properties). Each schema is shown below with its type and property counts.
Transfer
object
Transfers allow you to transfer money/balance into your end customers' account (deposits) or out (withdrawal). [Main docs here](https://alpaca.markets/docs/api…
15 properties7 required
TransferDirection
string
- INCOMING Funds incoming to user’s account (deposit). - OUTGOING Funds outgoing from user’s account (withdrawal).
TransferStatus
string
- QUEUED Transfer is in queue to be processed. - APPROVALPENDING Transfer is pending approval. - PENDING Transfer is pending processing. - SENTTOCLEARING Trans…
ACHRelationship
object
10 properties6 required
TransferType
string
NOTE: The Sandbox environment currently only supports ach - ach Transfer via ACH (US Only). - wire Transfer via wire (international).
CreateACHRelationshipRequest
object
Represents the fields used in creation of a new ACHRelationship. You can create an ACHRelationship by passing the required fields here or if you have an accoun…
6 properties4 required
Bank
object
14 properties7 required
CreateTransferRequest
object
[See main docs here](https://alpaca.markets/docs/api-references/broker-api/funding/transfers/creating-a-transfer-entity)
7 properties4 required
CreateBankRequest
object
Represents the possible fields to send when creating a new associated Bank resource for an account
9 properties4 required
TransferTiming
string
Only immediate is currently supported. values: - immediate - nextday
Error
object
2 properties2 required
TransferStatusEvent
object
Represents a change in a Transfer's status, sent over the events streaming api.
6 properties6 required
Specification
The full machine-readable OpenAPI contract behind this narrative.
