@drakkar.software/octobot-protocol 0.1.0

package/models/GenericAccount.ts

@@ -0,0 +1,52 @@
+/**
+ * OctoBot protocol types
+ * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+ *
+ * OpenAPI spec version: 1.0.0
+ * 
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+import { AccountType } from '../models/AccountType';
+import { Asset } from '../models/Asset';
+
+/**
+* GenericAccount
+*/
+export class GenericAccount {
+    /**
+    * generic
+    */
+    'account_type': AccountType;
+    'assets'?: Array<Asset>;
+
+    static readonly discriminator: string | undefined = undefined;
+
+    static readonly mapping: {[index: string]: string} | undefined = undefined;
+
+    static readonly attributeTypeMap: Array<{name: string, baseName: string, type: string, format: string}> = [
+        {
+            "name": "account_type",
+            "baseName": "account_type",
+            "type": "AccountType",
+            "format": ""
+        },
+        {
+            "name": "assets",
+            "baseName": "assets",
+            "type": "Array<Asset>",
+            "format": ""
+        }    ];
+
+    static getAttributeTypeMap() {
+        return GenericAccount.attributeTypeMap;
+    }
+
+    public constructor() {
+    }
+}
+
+

package/models/GenericProcessConfiguration.ts

@@ -0,0 +1,51 @@
+/**
+ * OctoBot protocol types
+ * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+ *
+ * OpenAPI spec version: 1.0.0
+ * 
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+import { ActionConfigurationType } from '../models/ActionConfigurationType';
+
+/**
+* GenericProcessConfiguration
+*/
+export class GenericProcessConfiguration {
+    /**
+    * generic_process
+    */
+    'configuration_type': ActionConfigurationType;
+    'profile_data': any;
+
+    static readonly discriminator: string | undefined = undefined;
+
+    static readonly mapping: {[index: string]: string} | undefined = undefined;
+
+    static readonly attributeTypeMap: Array<{name: string, baseName: string, type: string, format: string}> = [
+        {
+            "name": "configuration_type",
+            "baseName": "configuration_type",
+            "type": "ActionConfigurationType",
+            "format": ""
+        },
+        {
+            "name": "profile_data",
+            "baseName": "profile_data",
+            "type": "any",
+            "format": ""
+        }    ];
+
+    static getAttributeTypeMap() {
+        return GenericProcessConfiguration.attributeTypeMap;
+    }
+
+    public constructor() {
+    }
+}
+
+

package/models/GenericWorkflowConfiguration.ts

@@ -0,0 +1,52 @@
+/**
+ * OctoBot protocol types
+ * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+ *
+ * OpenAPI spec version: 1.0.0
+ * 
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+import { Action } from '../models/Action';
+import { ActionConfigurationType } from '../models/ActionConfigurationType';
+
+/**
+* GenericWorkflowConfiguration
+*/
+export class GenericWorkflowConfiguration {
+    /**
+    * generic_workflow
+    */
+    'configuration_type': ActionConfigurationType;
+    'actions': Array<Action>;
+
+    static readonly discriminator: string | undefined = undefined;
+
+    static readonly mapping: {[index: string]: string} | undefined = undefined;
+
+    static readonly attributeTypeMap: Array<{name: string, baseName: string, type: string, format: string}> = [
+        {
+            "name": "configuration_type",
+            "baseName": "configuration_type",
+            "type": "ActionConfigurationType",
+            "format": ""
+        },
+        {
+            "name": "actions",
+            "baseName": "actions",
+            "type": "Array<Action>",
+            "format": ""
+        }    ];
+
+    static getAttributeTypeMap() {
+        return GenericWorkflowConfiguration.attributeTypeMap;
+    }
+
+    public constructor() {
+    }
+}
+
+

package/models/GridConfiguration.ts

@@ -0,0 +1,112 @@
+/**
+ * OctoBot protocol types
+ * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+ *
+ * OpenAPI spec version: 1.0.0
+ * 
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+import { ActionConfigurationType } from '../models/ActionConfigurationType';
+
+/**
+* GridConfiguration
+*/
+export class GridConfiguration {
+    /**
+    * grid
+    */
+    'configuration_type': ActionConfigurationType;
+    'symbol': string;
+    /**
+    * Price difference between the closest buy and sell orders. Denominated in the quote currency (600 for a 600 USDT spread on BTC/USDT).
+    */
+    'spread': number;
+    /**
+    * Price difference between two orders of the same side. Denominated in the quote currency (200 for a 200 USDT spread on BTC/USDT).
+    */
+    'increment': number;
+    /**
+    * Number of initial buy orders to create. Make sure to have enough funds to create that many orders.
+    */
+    'buy_count': number;
+    /**
+    * Number of initial sell orders to create. Make sure to have enough funds to create that many orders.
+    */
+    'sell_count': number;
+    'enable_trailing_up': boolean;
+    'enable_trailing_down': boolean;
+    'order_by_order_trailing': boolean;
+
+    static readonly discriminator: string | undefined = undefined;
+
+    static readonly mapping: {[index: string]: string} | undefined = undefined;
+
+    static readonly attributeTypeMap: Array<{name: string, baseName: string, type: string, format: string}> = [
+        {
+            "name": "configuration_type",
+            "baseName": "configuration_type",
+            "type": "ActionConfigurationType",
+            "format": ""
+        },
+        {
+            "name": "symbol",
+            "baseName": "symbol",
+            "type": "string",
+            "format": ""
+        },
+        {
+            "name": "spread",
+            "baseName": "spread",
+            "type": "number",
+            "format": ""
+        },
+        {
+            "name": "increment",
+            "baseName": "increment",
+            "type": "number",
+            "format": ""
+        },
+        {
+            "name": "buy_count",
+            "baseName": "buy_count",
+            "type": "number",
+            "format": ""
+        },
+        {
+            "name": "sell_count",
+            "baseName": "sell_count",
+            "type": "number",
+            "format": ""
+        },
+        {
+            "name": "enable_trailing_up",
+            "baseName": "enable_trailing_up",
+            "type": "boolean",
+            "format": ""
+        },
+        {
+            "name": "enable_trailing_down",
+            "baseName": "enable_trailing_down",
+            "type": "boolean",
+            "format": ""
+        },
+        {
+            "name": "order_by_order_trailing",
+            "baseName": "order_by_order_trailing",
+            "type": "boolean",
+            "format": ""
+        }    ];
+
+    static getAttributeTypeMap() {
+        return GridConfiguration.attributeTypeMap;
+    }
+
+    public constructor() {
+    }
+}
+
+

package/models/IndexCoin.ts

@@ -0,0 +1,45 @@
+/**
+ * OctoBot protocol types
+ * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+ *
+ * OpenAPI spec version: 1.0.0
+ * 
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+
+/**
+* IndexCoin
+*/
+export class IndexCoin {
+    'name': string;
+    'ratio': number;
+
+    static readonly discriminator: string | undefined = undefined;
+
+    static readonly mapping: {[index: string]: string} | undefined = undefined;
+
+    static readonly attributeTypeMap: Array<{name: string, baseName: string, type: string, format: string}> = [
+        {
+            "name": "name",
+            "baseName": "name",
+            "type": "string",
+            "format": ""
+        },
+        {
+            "name": "ratio",
+            "baseName": "ratio",
+            "type": "number",
+            "format": ""
+        }    ];
+
+    static getAttributeTypeMap() {
+        return IndexCoin.attributeTypeMap;
+    }
+
+    public constructor() {
+    }
+}

package/models/IndexConfiguration.ts

@@ -0,0 +1,59 @@
+/**
+ * OctoBot protocol types
+ * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+ *
+ * OpenAPI spec version: 1.0.0
+ * 
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+import { ActionConfigurationType } from '../models/ActionConfigurationType';
+import { IndexCoin } from '../models/IndexCoin';
+
+/**
+* IndexConfiguration
+*/
+export class IndexConfiguration {
+    /**
+    * index
+    */
+    'configuration_type': ActionConfigurationType;
+    'coins': Array<IndexCoin>;
+    'rebalance_trigger_min_percent': number;
+
+    static readonly discriminator: string | undefined = undefined;
+
+    static readonly mapping: {[index: string]: string} | undefined = undefined;
+
+    static readonly attributeTypeMap: Array<{name: string, baseName: string, type: string, format: string}> = [
+        {
+            "name": "configuration_type",
+            "baseName": "configuration_type",
+            "type": "ActionConfigurationType",
+            "format": ""
+        },
+        {
+            "name": "coins",
+            "baseName": "coins",
+            "type": "Array<IndexCoin>",
+            "format": ""
+        },
+        {
+            "name": "rebalance_trigger_min_percent",
+            "baseName": "rebalance_trigger_min_percent",
+            "type": "number",
+            "format": ""
+        }    ];
+
+    static getAttributeTypeMap() {
+        return IndexConfiguration.attributeTypeMap;
+    }
+
+    public constructor() {
+    }
+}
+
+

package/models/MarketMakingConfiguration.ts

@@ -0,0 +1,52 @@
+/**
+ * OctoBot protocol types
+ * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+ *
+ * OpenAPI spec version: 1.0.0
+ * 
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+import { ActionConfigurationType } from '../models/ActionConfigurationType';
+import { MarketMakingSymbolConfiguration } from '../models/MarketMakingSymbolConfiguration';
+
+/**
+* Per-symbol market making parameters.
+*/
+export class MarketMakingConfiguration {
+    /**
+    * market_making
+    */
+    'configuration_type': ActionConfigurationType;
+    'pair_settings': Array<MarketMakingSymbolConfiguration>;
+
+    static readonly discriminator: string | undefined = undefined;
+
+    static readonly mapping: {[index: string]: string} | undefined = undefined;
+
+    static readonly attributeTypeMap: Array<{name: string, baseName: string, type: string, format: string}> = [
+        {
+            "name": "configuration_type",
+            "baseName": "configuration_type",
+            "type": "ActionConfigurationType",
+            "format": ""
+        },
+        {
+            "name": "pair_settings",
+            "baseName": "pair_settings",
+            "type": "Array<MarketMakingSymbolConfiguration>",
+            "format": ""
+        }    ];
+
+    static getAttributeTypeMap() {
+        return MarketMakingConfiguration.attributeTypeMap;
+    }
+
+    public constructor() {
+    }
+}
+
+

package/models/MarketMakingFundsDistribution.ts

@@ -0,0 +1,21 @@
+/**
+ * OctoBot protocol types
+ * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+ *
+ * OpenAPI spec version: 1.0.0
+ * 
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+
+/**
+* How allocated funds are spread across ladder levels.
+*/
+export enum MarketMakingFundsDistribution {
+    Flat = 'flat',
+    Valley = 'valley',
+    Random = 'random'
+}

package/models/MarketMakingHedgingEngine.ts

@@ -0,0 +1,86 @@
+/**
+ * OctoBot protocol types
+ * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+ *
+ * OpenAPI spec version: 1.0.0
+ * 
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+
+/**
+* Optional cross-exchange hedging configuration.
+*/
+export class MarketMakingHedgingEngine {
+    'average_price_counted_minutes'?: number;
+    'hedging_engine_type'?: MarketMakingHedgingEngineHedgingEngineTypeEnum;
+    'hedging_exchange'?: string;
+    'hedging_max_loss_threshold'?: number;
+    'hedging_profit_threshold'?: number;
+    'max_negative_percent_price_change'?: number;
+    'max_positive_percent_price_change'?: number;
+
+    static readonly discriminator: string | undefined = undefined;
+
+    static readonly mapping: {[index: string]: string} | undefined = undefined;
+
+    static readonly attributeTypeMap: Array<{name: string, baseName: string, type: string, format: string}> = [
+        {
+            "name": "average_price_counted_minutes",
+            "baseName": "average_price_counted_minutes",
+            "type": "number",
+            "format": ""
+        },
+        {
+            "name": "hedging_engine_type",
+            "baseName": "hedging_engine_type",
+            "type": "MarketMakingHedgingEngineHedgingEngineTypeEnum",
+            "format": ""
+        },
+        {
+            "name": "hedging_exchange",
+            "baseName": "hedging_exchange",
+            "type": "string",
+            "format": ""
+        },
+        {
+            "name": "hedging_max_loss_threshold",
+            "baseName": "hedging_max_loss_threshold",
+            "type": "number",
+            "format": ""
+        },
+        {
+            "name": "hedging_profit_threshold",
+            "baseName": "hedging_profit_threshold",
+            "type": "number",
+            "format": ""
+        },
+        {
+            "name": "max_negative_percent_price_change",
+            "baseName": "max_negative_percent_price_change",
+            "type": "number",
+            "format": ""
+        },
+        {
+            "name": "max_positive_percent_price_change",
+            "baseName": "max_positive_percent_price_change",
+            "type": "number",
+            "format": ""
+        }    ];
+
+    static getAttributeTypeMap() {
+        return MarketMakingHedgingEngine.attributeTypeMap;
+    }
+
+    public constructor() {
+    }
+}
+
+export enum MarketMakingHedgingEngineHedgingEngineTypeEnum {
+    Spot = 'spot',
+    PerpetualFutures = 'perpetual_futures'
+}
+

package/models/MarketMakingOrderBookDepth.ts

@@ -0,0 +1,45 @@
+/**
+ * OctoBot protocol types
+ * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+ *
+ * OpenAPI spec version: 1.0.0
+ * 
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+
+/**
+* Order book depth parameters (cumulated volume and daily volume fraction).
+*/
+export class MarketMakingOrderBookDepth {
+    'cumulated_volume_percent': number;
+    'percent_daily_trading_volume': number;
+
+    static readonly discriminator: string | undefined = undefined;
+
+    static readonly mapping: {[index: string]: string} | undefined = undefined;
+
+    static readonly attributeTypeMap: Array<{name: string, baseName: string, type: string, format: string}> = [
+        {
+            "name": "cumulated_volume_percent",
+            "baseName": "cumulated_volume_percent",
+            "type": "number",
+            "format": ""
+        },
+        {
+            "name": "percent_daily_trading_volume",
+            "baseName": "percent_daily_trading_volume",
+            "type": "number",
+            "format": ""
+        }    ];
+
+    static getAttributeTypeMap() {
+        return MarketMakingOrderBookDepth.attributeTypeMap;
+    }
+
+    public constructor() {
+    }
+}

package/models/MarketMakingOrdersDistribution.ts

@@ -0,0 +1,19 @@
+/**
+ * OctoBot protocol types
+ * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+ *
+ * OpenAPI spec version: 1.0.0
+ * 
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+
+/**
+* How order prices are spaced across the book.
+*/
+export enum MarketMakingOrdersDistribution {
+    Linear = 'linear'
+}

package/models/MarketMakingReferencePair.ts

@@ -0,0 +1,75 @@
+/**
+ * OctoBot protocol types
+ * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+ *
+ * OpenAPI spec version: 1.0.0
+ * 
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+import { TimeFrame } from '../models/TimeFrame';
+
+/**
+* Reference price source for market making (exchange pair, weighting, and optional formula).
+*/
+export class MarketMakingReferencePair {
+    /**
+    * Exchange id, or a sentinel such as local exchange price when supported by the trading mode.
+    */
+    'exchange': string;
+    'pair': string;
+    'weight'?: number;
+    /**
+    * Optional formula overriding the default latest price for this source.
+    */
+    'formula'?: string;
+    'time_frame'?: TimeFrame;
+
+    static readonly discriminator: string | undefined = undefined;
+
+    static readonly mapping: {[index: string]: string} | undefined = undefined;
+
+    static readonly attributeTypeMap: Array<{name: string, baseName: string, type: string, format: string}> = [
+        {
+            "name": "exchange",
+            "baseName": "exchange",
+            "type": "string",
+            "format": ""
+        },
+        {
+            "name": "pair",
+            "baseName": "pair",
+            "type": "string",
+            "format": ""
+        },
+        {
+            "name": "weight",
+            "baseName": "weight",
+            "type": "number",
+            "format": ""
+        },
+        {
+            "name": "formula",
+            "baseName": "formula",
+            "type": "string",
+            "format": ""
+        },
+        {
+            "name": "time_frame",
+            "baseName": "time_frame",
+            "type": "TimeFrame",
+            "format": ""
+        }    ];
+
+    static getAttributeTypeMap() {
+        return MarketMakingReferencePair.attributeTypeMap;
+    }
+
+    public constructor() {
+    }
+}
+
+