tctl
(stands for Tradologics Controller), which simplifies your development workflow by allowing you to communicate with the Tradologics cloud.tctl
is yet another way of working with Tradologics - it's important to note that it does not perform anything that you cannot do by using the web console or "vanilla" API calls, as they are all merely clients for our API.tctl
you'll need to have Python 3.6 (and pip) installed on your system. Once you have both on your system, simply execute the following command in your terminal of choice:tctl config
to set up your tctl
to work in conjunction with your account by providing your account's API key and Secret key.tctl
. Once configured, you can use the Command Prompt as usual.tctl
commands are structured in the following format:tctl
:|
) means "or" – For example, the snippet: list|ls
translates into "you can use either list
or ls
", and for this additional snippet: --connection|-c
, this translates into "you can use either--connection CONNECTION_ID
or -a
CONNECTION_ID``". Simply put, the pipe character (|
) represents the "or" in a given statement.--connection|-a {CONNECTION_ID}
). Otherwise, they are just flags (i.e. --show-ids
in tctl tradehooks ls
).[]
are optional (i.e. [--start {YYYY-MM-DD}]
).--raw
to any command will display the API's response in raw JSON format. Otherwise, tabular data will be displayed.--connection|-c
connection-id--order|-o
order-id--broker|-b
broker-id--tradehook|-t
tradehook-id--strategy|-s
strategy-id--monitor|-m
monitor-id--exchange|-e
exchange-mic--version|-v
strategy's version-id--start {DATE|DATE-TIME}
- Filter results to show from this day or this date-time onwards.--end {DATE|DATE-TIME}
- Filter results to show until this day or this date-time.-- strategies {STRATEGY_ID,STRATEGY_ID,...}
- Filter results to include positions/orders/trades from these strategies only.--connections {CONNECTION_ID,CONNECTION_ID,...}
- Filter results to include positions/orders/trades from these connections only.--brokers {BROKER_ID,BROKER_ID,...}
- Filter results to include positions/orders/trades from these brokers only.--decode
- Instructs tctl
to decode the data returned (i.e. for tokens and strategy codes).--show-ids
- Shows object ids (some objects with very long ids aren't displayed by default for readability).--history
- Retrieves an asset's history and indicates whether that asset has had a past name/ticker/exchange changes (for tctl assets info --asset {ASSET}
).--delisted
- Include delisted assets in the results.--unadjusted
- Return/use unadjusted prices (back-adjusted prices are returned by default).--raw
- Display the API's response in raw JSON format. Otherwise, tabular data will be displayed.