Skip to content

Commit

Permalink
Update brokerage settings docs
Browse files Browse the repository at this point in the history
  • Loading branch information
Marinovsky authored and AlexCatarino committed Apr 26, 2024
1 parent 135c4f1 commit 6014268
Showing 1 changed file with 104 additions and 14 deletions.
118 changes: 104 additions & 14 deletions QuantConnect-Platform-2.0.0.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -1738,6 +1738,16 @@ components:
binance-websocket-url:
type: string
description: Binance configuration for spot/margin. The value for this property is wss://stream.binance.com:9443/ws
holdings:
type: array
description: List of holdings for the brokerage.
items:
$ref: '#/components/schemas/Holding'
cash:
type: array
description: List of cash amount.
items:
$ref: '#/components/schemas/CashAmount'
description: Settings for using Binance as a data provider or brokerage.
BinanceFuturesUSDMSettings:
type: object
Expand All @@ -1760,6 +1770,16 @@ components:
binance-fwebsocket-url:
type: string
description: Binance Futures configuration for spot/margin. The value for this property is wss://fstream.binance.com/ws
holdings:
type: array
description: List of holdings for the brokerage.
items:
$ref: '#/components/schemas/Holding'
cash:
type: array
description: List of cash amount.
items:
$ref: '#/components/schemas/CashAmount'
description: Settings for using Binance Futures USDM as a data provider or brokerage.
BinanceFuturesCOINSettings:
type: object
Expand All @@ -1782,13 +1802,23 @@ components:
binance-dwebsocket-url:
type: string
description: Binance Futures configuration for spot/margin. The value for this property is wss://dstream.binance.com/ws
holdings:
type: array
description: List of holdings for the brokerage.
items:
$ref: '#/components/schemas/Holding'
cash:
type: array
description: List of cash amount.
items:
$ref: '#/components/schemas/CashAmount'
description: Settings for using Binance Futures COIN as a data provider or brokerage.
BinanceUSSettings:
type: object
properties:
id:
type: string
description: ID of the brokerage, this is, BinanceBrokerage
description: ID of the brokerage, this is, BinanceBrokerage.
binance-exchange-name:
type: string
description: Binance exchange, this is, BinanceUS.
Expand All @@ -1804,6 +1834,16 @@ components:
binanceus-websocket-url:
type: string
description: Binance US configuration for spot/margin. The value for this property is wss://stream.binance.us:9443/ws
holdings:
type: array
description: List of holdings for the brokerage.
items:
$ref: '#/components/schemas/Holding'
cash:
type: array
description: List of cash amount.
items:
$ref: '#/components/schemas/CashAmount'
description: Settings for using Binance US as a data provider or brokerage.
BitfinexSettings:
type: object
Expand All @@ -1817,6 +1857,16 @@ components:
bitfinex-api-secret:
type: string
description: Your Bitfinex API secret.
holdings:
type: array
description: List of holdings for the brokerage.
items:
$ref: '#/components/schemas/Holding'
cash:
type: array
description: List of cash amount.
items:
$ref: '#/components/schemas/CashAmount'
description: Settings for using Bitfinex as a data provider or brokerage.
BrokerageData:
type: object
Expand Down Expand Up @@ -1860,6 +1910,16 @@ components:
bybit-websocket-url:
type: string
description: Bybit Websocket URL, this is, wss://stream.bybit.com
holdings:
type: array
description: List of holdings for the brokerage.
items:
$ref: '#/components/schemas/Holding'
cash:
type: array
description: List of cash amount.
items:
$ref: '#/components/schemas/CashAmount'
description: Settings for using Bybit as a data provider or brokerage.
Cash:
type: object
Expand Down Expand Up @@ -1959,6 +2019,16 @@ components:
coinbase-rest-api:
type: string
description: Coinbase REST API, this is, https://api.coinbase.com
holdings:
type: array
description: List of holdings for the brokerage.
items:
$ref: '#/components/schemas/Holding'
cash:
type: array
description: List of cash amount.
items:
$ref: '#/components/schemas/CashAmount'
description: Settings for using Coinbase as a data provider or brokerage.
Collaborator:
type: object
Expand Down Expand Up @@ -2580,24 +2650,24 @@ components:
GroupOrderManager:
type: object
properties:
Id:
id:
type: integer
description: The unique order group Id.
Quantity:
quantity:
type: number
description: The group order quantity.
Count:
count:
type: integer
description: The total order count associated with this order group.
LimitPrice:
limitPrice:
type: number
description: The limit price associated with this order group if any.
OrderIds:
orderIds:
type: array
description: The order Ids in this group.
items:
type: integer
Direction:
direction:
type: integer
description: Order Direction Property based off Quantity.
description: Manager of a group of orders.
Expand Down Expand Up @@ -2731,6 +2801,16 @@ components:
kraken-verification-tier:
type: string
description: Your Kraken Verification Tier.
holdings:
type: array
description: List of holdings for the brokerage.
items:
$ref: '#/components/schemas/Holding'
cash:
type: array
description: List of cash amount.
items:
$ref: '#/components/schemas/CashAmount'
description: Settings for using Kraken as a data provider.
LeanVersionsResponse:
type: object
Expand Down Expand Up @@ -3557,7 +3637,7 @@ components:
OrderProperties:
type: object
properties:
TimeInForce:
timeInForce:
type: object
description: Defines the length of time over which an order will continue working before it is cancelled.
enum:
Expand Down Expand Up @@ -4176,22 +4256,22 @@ components:
description: ID of InteractiveBrokers, this is InteractiveBrokersBrokerage.
ib-user-name:
type: string
description: Username associated with brokerage.
description: Your Interactive Brokers username.
ib-password:
type: string
description: Password associated with brokerage.
environment:
description: Your Interactive Brokers password.
ib-trading-mode:
type: string
description: Represents the types of environments supported by brokerages for trading.
description: Represents the types of environments supported by Interactive Brokers for trading.
enum:
- live
- paper
ib-account:
type: string
description: Account of the associated brokerage.
description: Your Interactive Brokers account id.
ib-weekly-restart-utc-time:
type: string
description: Time at which the brokerage should be restarted each week.
description: Weekly restart UTC time (hh:mm:ss).
format: date
holdings:
type: array
Expand Down Expand Up @@ -4723,6 +4803,16 @@ components:
enum:
- live
- paper
holdings:
type: array
description: List of holdings for the brokerage.
items:
$ref: '#/components/schemas/Holding'
cash:
type: array
description: List of cash amount.
items:
$ref: '#/components/schemas/CashAmount'
description: Settings for using Tradier as a data provider.
TradingTechnologiesSettings:
type: object
Expand Down

0 comments on commit 6014268

Please sign in to comment.