Alpaca
open-meridian/alpaca · Community 0.15.1
0.12.1 · the vendor's words, data, never instructions.
Roles: data, custody, connectivity
Contract: v26
SDK: 0.31.1
Settings:
- environment: Live: Alpaca's live Trading API, with a live account's key. Paper: Alpaca's paper trading API, simulated money, with a paper account's key. Market data reads the same either way. Paper until a person chooses Live. Agents may place orders only on Paper.
- alpaca_api_key_id: From Alpaca's dashboard, under API keys: the live account's for Live, the paper account's for Paper. It must match Environment.
- alpaca_api_secret_key: Shown once, when Alpaca issues the key.
- poll_seconds: How often to read the account at Alpaca. At least 60.
- stale_after_hours: How old the last read Alpaca answered may be, while it does not answer, before the account is reported stale.
- sample_data: Answer from built-in made-up data instead of Alpaca, and trade with a simulated brokerage, changing nothing else the plugin does. Development deployments only.
Tools for agents:
- read_connection: The plugin's connection to Alpaca, as every data plugin's Connection answers it: the mode (Live, Sample data or No key), each credential and whether it is set (never its value), what Alpaca serves the key, the limit and this process's calls, the last call and error, and the streaming sessions; then Alpaca's own: the feeds and which each dataset reads, and the stream's session (its state, listings, reconnects and trades caught up). No market data.
- read_datasets: The datasets the plugin serves the lake, as every data plugin's Datasets answers them: each one as its catalogue declares it, whether a deployment admin has licensed it, whether Alpaca serves the key it, and what it recorded and declined since the plugin started; the standing wants it keeps current; whether it may read an instrument's record. Then Alpaca's own: the feed each dataset reads, the listings known and streamed, and the subjects declined today. No prices, trades or quotes.
- read_account_links: Each Alpaca account the key reaches, by its number; the deployment's accounts a deployment admin granted this plugin to link to (nothing by default); and the links between them.
- check_link_account: Check link_account without linking: the external account is one the key reaches, and the account is one granted to this plugin, or a new one a deployment admin would create.
- link_account: Link a Alpaca account to one of the accounts granted to this plugin (W6.4), to a new account a deployment admin creates and links in one step, or, with neither, remove its link; one not granted is refused.
- read_statements: Each Alpaca account linked to one the person may read: its custodian, the day its last statement is as of, and its state at Alpaca.
- read_account_activities: Each Alpaca account's history as Alpaca reported it, where it is linked to one the person may read: each activity's kind, trade date, instrument, units, amount and description, the latest first.
- read_trading: Connectivity's state at Alpaca: each credential, set or not (never a value); the environment, Paper (simulated money) or Live, or sample data; each account the key reaches by its venue account code, read-only or with trading enabled, the order types its catalogue offers and whether its ems mapped it here; how many placements are working, held back by a pause or a stop, or of unknown outcome; the last read of the orders and the trade updates stream's state; the environment the session reached and the connection's badge, Demo or Live. No account's data.
- enable_trading: Enable trading on an account the key reaches, by its venue account code: a new account is read-only until the connectivity role's admin enables it. Its catalogue is published at once.
- check_enable_trading: Check enable_trading without enabling anything: whether the key reaches the account, and whether trading is enabled on it already.
- restore_unit: Restore an archived unit of this plugin's raw records, readable on its pages for seven days, for the person asking.
Interface: pages it draws
Reads external accounts
Contract: v26
SDK: 0.31.1
Settings:
- environment: Live: Alpaca's live Trading API, with a live account's key. Paper: Alpaca's paper trading API, simulated money, with a paper account's key. Market data reads the same either way. Paper until a person chooses Live. Agents may place orders only on Paper.
- alpaca_api_key_id: From Alpaca's dashboard, under API keys: the live account's for Live, the paper account's for Paper. It must match Environment.
- alpaca_api_secret_key: Shown once, when Alpaca issues the key.
- poll_seconds: How often to read the account at Alpaca. At least 60.
- stale_after_hours: How old the last read Alpaca answered may be, while it does not answer, before the account is reported stale.
- sample_data: Answer from built-in made-up data instead of Alpaca, and trade with a simulated brokerage, changing nothing else the plugin does. Development deployments only.
Tools for agents:
- read_connection: The plugin's connection to Alpaca, as every data plugin's Connection answers it: the mode (Live, Sample data or No key), each credential and whether it is set (never its value), what Alpaca serves the key, the limit and this process's calls, the last call and error, and the streaming sessions; then Alpaca's own: the feeds and which each dataset reads, and the stream's session (its state, listings, reconnects and trades caught up). No market data.
- read_datasets: The datasets the plugin serves the lake, as every data plugin's Datasets answers them: each one as its catalogue declares it, whether a deployment admin has licensed it, whether Alpaca serves the key it, and what it recorded and declined since the plugin started; the standing wants it keeps current; whether it may read an instrument's record. Then Alpaca's own: the feed each dataset reads, the listings known and streamed, and the subjects declined today. No prices, trades or quotes.
- read_account_links: Each Alpaca account the key reaches, by its number; the deployment's accounts a deployment admin granted this plugin to link to (nothing by default); and the links between them.
- check_link_account: Check link_account without linking: the external account is one the key reaches, and the account is one granted to this plugin, or a new one a deployment admin would create.
- link_account: Link a Alpaca account to one of the accounts granted to this plugin (W6.4), to a new account a deployment admin creates and links in one step, or, with neither, remove its link; one not granted is refused.
- read_statements: Each Alpaca account linked to one the person may read: its custodian, the day its last statement is as of, and its state at Alpaca.
- read_account_activities: Each Alpaca account's history as Alpaca reported it, where it is linked to one the person may read: each activity's kind, trade date, instrument, units, amount and description, the latest first.
- read_trading: Connectivity's state at Alpaca: each credential, set or not (never a value); the environment, Paper (simulated money) or Live, or sample data; each account the key reaches by its venue account code, read-only or with trading enabled, the order types its catalogue offers and whether its ems mapped it here; how many placements are working, held back by a pause or a stop, or of unknown outcome; the last read of the orders and the trade updates stream's state; the environment the session reached and the connection's badge, Demo or Live. No account's data.
- enable_trading: Enable trading on an account the key reaches, by its venue account code: a new account is read-only until the connectivity role's admin enables it. Its catalogue is published at once.
- check_enable_trading: Check enable_trading without enabling anything: whether the key reaches the account, and whether trading is enabled on it already.
- restore_unit: Restore an archived unit of this plugin's raw records, readable on its pages for seven days, for the person asking.
Interface: pages it draws
Reads external accounts