Skip to content

Latest commit

 

History

History
387 lines (307 loc) · 14.9 KB

PositionApi.md

File metadata and controls

387 lines (307 loc) · 14.9 KB

IO.Swagger.Api.PositionApi

All URIs are relative to https://localhost/api/v1

Method HTTP request Description
PositionGet GET /position Get your positions.
PositionIsolateMargin POST /position/isolate Enable isolated margin or cross margin per-position.
PositionTransferIsolatedMargin POST /position/transferMargin Transfer equity in or out of a position.
PositionUpdateLeverage POST /position/leverage Choose leverage for a position.
PositionUpdateRiskLimit POST /position/riskLimit Update your risk limit.

PositionGet

List PositionGet (string filter = null, string columns = null, decimal? count = null)

Get your positions.

See <a href="http://www.onixs.biz/fix-dictionary/5.0.SP2/msgType_AP_6580.html\">the FIX Spec for explanations of these fields.

Example

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class PositionGetExample
    {
        public void main()
        {
            // Configure API key authorization: apiKey
            Configuration.Default.AddApiKey("api-key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.AddApiKeyPrefix("api-key", "Bearer");
            // Configure API key authorization: apiNonce
            Configuration.Default.AddApiKey("api-nonce", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.AddApiKeyPrefix("api-nonce", "Bearer");
            // Configure API key authorization: apiSignature
            Configuration.Default.AddApiKey("api-signature", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.AddApiKeyPrefix("api-signature", "Bearer");

            var apiInstance = new PositionApi();
            var filter = filter_example;  // string | Table filter. For example, send {\"symbol\": \"XBTUSD\"}. (optional) 
            var columns = columns_example;  // string | Which columns to fetch. For example, send [\"columnName\"]. (optional) 
            var count = 8.14;  // decimal? | Number of rows to fetch. (optional) 

            try
            {
                // Get your positions.
                List&lt;Position&gt; result = apiInstance.PositionGet(filter, columns, count);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling PositionApi.PositionGet: " + e.Message );
            }
        }
    }
}

Parameters

Name Type Description Notes
filter string Table filter. For example, send {&quot;symbol&quot;: &quot;XBTUSD&quot;}. [optional]
columns string Which columns to fetch. For example, send [&quot;columnName&quot;]. [optional]
count decimal? Number of rows to fetch. [optional]

Return type

List

Authorization

apiKey, apiNonce, apiSignature

HTTP request headers

  • Content-Type: application/json, application/x-www-form-urlencoded
  • Accept: application/json, application/xml, text/xml, application/javascript, text/javascript

[Back to top] [Back to API list] [Back to Model list] [Back to README]

PositionIsolateMargin

Position PositionIsolateMargin (string symbol, bool? enabled = null)

Enable isolated margin or cross margin per-position.

Example

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class PositionIsolateMarginExample
    {
        public void main()
        {
            // Configure API key authorization: apiKey
            Configuration.Default.AddApiKey("api-key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.AddApiKeyPrefix("api-key", "Bearer");
            // Configure API key authorization: apiNonce
            Configuration.Default.AddApiKey("api-nonce", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.AddApiKeyPrefix("api-nonce", "Bearer");
            // Configure API key authorization: apiSignature
            Configuration.Default.AddApiKey("api-signature", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.AddApiKeyPrefix("api-signature", "Bearer");

            var apiInstance = new PositionApi();
            var symbol = symbol_example;  // string | Position symbol to isolate.
            var enabled = true;  // bool? | True for isolated margin, false for cross margin. (optional)  (default to true)

            try
            {
                // Enable isolated margin or cross margin per-position.
                Position result = apiInstance.PositionIsolateMargin(symbol, enabled);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling PositionApi.PositionIsolateMargin: " + e.Message );
            }
        }
    }
}

Parameters

Name Type Description Notes
symbol string Position symbol to isolate.
enabled bool? True for isolated margin, false for cross margin. [optional] [default to true]

Return type

Position

Authorization

apiKey, apiNonce, apiSignature

HTTP request headers

  • Content-Type: application/json, application/x-www-form-urlencoded
  • Accept: application/json, application/xml, text/xml, application/javascript, text/javascript

[Back to top] [Back to API list] [Back to Model list] [Back to README]

PositionTransferIsolatedMargin

Position PositionTransferIsolatedMargin (string symbol, decimal? amount)

Transfer equity in or out of a position.

Example

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class PositionTransferIsolatedMarginExample
    {
        public void main()
        {
            // Configure API key authorization: apiKey
            Configuration.Default.AddApiKey("api-key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.AddApiKeyPrefix("api-key", "Bearer");
            // Configure API key authorization: apiNonce
            Configuration.Default.AddApiKey("api-nonce", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.AddApiKeyPrefix("api-nonce", "Bearer");
            // Configure API key authorization: apiSignature
            Configuration.Default.AddApiKey("api-signature", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.AddApiKeyPrefix("api-signature", "Bearer");

            var apiInstance = new PositionApi();
            var symbol = symbol_example;  // string | Symbol of position to isolate.
            var amount = 8.14;  // decimal? | Amount to transfer, in Satoshis. May be negative.

            try
            {
                // Transfer equity in or out of a position.
                Position result = apiInstance.PositionTransferIsolatedMargin(symbol, amount);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling PositionApi.PositionTransferIsolatedMargin: " + e.Message );
            }
        }
    }
}

Parameters

Name Type Description Notes
symbol string Symbol of position to isolate.
amount decimal? Amount to transfer, in Satoshis. May be negative.

Return type

Position

Authorization

apiKey, apiNonce, apiSignature

HTTP request headers

  • Content-Type: application/json, application/x-www-form-urlencoded
  • Accept: application/json, application/xml, text/xml, application/javascript, text/javascript

[Back to top] [Back to API list] [Back to Model list] [Back to README]

PositionUpdateLeverage

Position PositionUpdateLeverage (string symbol, double? leverage)

Choose leverage for a position.

Example

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class PositionUpdateLeverageExample
    {
        public void main()
        {
            // Configure API key authorization: apiKey
            Configuration.Default.AddApiKey("api-key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.AddApiKeyPrefix("api-key", "Bearer");
            // Configure API key authorization: apiNonce
            Configuration.Default.AddApiKey("api-nonce", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.AddApiKeyPrefix("api-nonce", "Bearer");
            // Configure API key authorization: apiSignature
            Configuration.Default.AddApiKey("api-signature", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.AddApiKeyPrefix("api-signature", "Bearer");

            var apiInstance = new PositionApi();
            var symbol = symbol_example;  // string | Symbol of position to adjust.
            var leverage = 1.2;  // double? | Leverage value. Send a number between 0.01 and 100 to enable isolated margin with a fixed leverage. Send 0 to enable cross margin.

            try
            {
                // Choose leverage for a position.
                Position result = apiInstance.PositionUpdateLeverage(symbol, leverage);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling PositionApi.PositionUpdateLeverage: " + e.Message );
            }
        }
    }
}

Parameters

Name Type Description Notes
symbol string Symbol of position to adjust.
leverage double? Leverage value. Send a number between 0.01 and 100 to enable isolated margin with a fixed leverage. Send 0 to enable cross margin.

Return type

Position

Authorization

apiKey, apiNonce, apiSignature

HTTP request headers

  • Content-Type: application/json, application/x-www-form-urlencoded
  • Accept: application/json, application/xml, text/xml, application/javascript, text/javascript

[Back to top] [Back to API list] [Back to Model list] [Back to README]

PositionUpdateRiskLimit

Position PositionUpdateRiskLimit (string symbol, decimal? riskLimit)

Update your risk limit.

Example

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class PositionUpdateRiskLimitExample
    {
        public void main()
        {
            // Configure API key authorization: apiKey
            Configuration.Default.AddApiKey("api-key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.AddApiKeyPrefix("api-key", "Bearer");
            // Configure API key authorization: apiNonce
            Configuration.Default.AddApiKey("api-nonce", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.AddApiKeyPrefix("api-nonce", "Bearer");
            // Configure API key authorization: apiSignature
            Configuration.Default.AddApiKey("api-signature", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.AddApiKeyPrefix("api-signature", "Bearer");

            var apiInstance = new PositionApi();
            var symbol = symbol_example;  // string | Symbol of position to update risk limit on.
            var riskLimit = 8.14;  // decimal? | New Risk Limit, in Satoshis.

            try
            {
                // Update your risk limit.
                Position result = apiInstance.PositionUpdateRiskLimit(symbol, riskLimit);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling PositionApi.PositionUpdateRiskLimit: " + e.Message );
            }
        }
    }
}

Parameters

Name Type Description Notes
symbol string Symbol of position to update risk limit on.
riskLimit decimal? New Risk Limit, in Satoshis.

Return type

Position

Authorization

apiKey, apiNonce, apiSignature

HTTP request headers

  • Content-Type: application/json, application/x-www-form-urlencoded
  • Accept: application/json, application/xml, text/xml, application/javascript, text/javascript

[Back to top] [Back to API list] [Back to Model list] [Back to README]