IO.Swagger.Api.GuildApi

All URIs are relative to https://www.bitmex.com/api/v1

Method	HTTP request	Description
GuildArchive	POST /guild/archive	Archive a guild
GuildEdit	PUT /guild	Edit guild new guild
GuildGet	GET /guild	Get all guilds
GuildJoin	POST /guild/join	Request to Join a private guild or join a public guild
GuildKick	POST /guild/kick	Kick member from guild
GuildLeave	POST /guild/leave	Leave guild or cancel guild join request
GuildNew	POST /guild	Creates a new guild
GuildShareTrades	POST /guild/shareTrades	Toggle share trades for your account, which controls whether your guild members can see your orders and positions in their UI

GuildArchive

Object GuildArchive ()

Archive a guild

Example

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

namespace Example
{
    public class GuildArchiveExample
    {
        public void main()
        {
            // Configure API key authorization: apiExpires
            Configuration.Default.AddApiKey("api-expires", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.AddApiKeyPrefix("api-expires", "Bearer");
            // 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: 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 GuildApi();

            try
            {
                // Archive a guild
                Object result = apiInstance.GuildArchive();
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling GuildApi.GuildArchive: " + e.Message );
            }
        }
    }
}

Parameters

This endpoint does not need any parameter.

Return type

Object

Authorization

apiExpires, apiKey, 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]

GuildEdit

Guild GuildEdit (string name, string emoji, double? potDistributionPercent, string potDistributionType, double? potTraderId = null, string description = null, string twitter = null, string discord = null, string telegram = null, string imgUrl = null, bool? isPrivate = null)

Edit guild new guild

Example

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

namespace Example
{
    public class GuildEditExample
    {
        public void main()
        {
            // Configure API key authorization: apiExpires
            Configuration.Default.AddApiKey("api-expires", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.AddApiKeyPrefix("api-expires", "Bearer");
            // 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: 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 GuildApi();
            var name = name_example;  // string | Name of the guild, must be unique, must be at least 5 characters
            var emoji = emoji_example;  // string | Emoji name.
            var potDistributionPercent = 1.2;  // double? | How much of the pot should be distributed to the guild members, must be between 0 and 100
            var potDistributionType = potDistributionType_example;  // string | How the pot should be distributed to the guild members, must be one of the following: ROLL_OVER, TOP_3, TOP_5, TOP_10, VOLUME_PERCENTAGE, TOP_3_BY_ADV, TOP_5_BY_ADV, TOP_10_BY_ADV, TOP_3_BY_ROI, TOP_5_BY_ROI, TOP_10_BY_ROI, RANDOM
            var potTraderId = 1.2;  // double? | User ID of the guild member with order write permission for the pot (optional) 
            var description = description_example;  // string | Guild description, can be used to explain the guild to other users. (optional) 
            var twitter = twitter_example;  // string | Guild twitter handle. (optional) 
            var discord = discord_example;  // string | Guild discord link. (optional) 
            var telegram = telegram_example;  // string | Guild telegram link. (optional) 
            var imgUrl = imgUrl_example;  // string | URL for the profile image of the guild, is used by clients to add some color to the guild, if no image is provided, a default image is used (optional) 
            var isPrivate = true;  // bool? | Guild privacy status (optional) 

            try
            {
                // Edit guild new guild
                Guild result = apiInstance.GuildEdit(name, emoji, potDistributionPercent, potDistributionType, potTraderId, description, twitter, discord, telegram, imgUrl, isPrivate);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling GuildApi.GuildEdit: " + e.Message );
            }
        }
    }
}

Parameters

Name	Type	Description	Notes
name	string	Name of the guild, must be unique, must be at least 5 characters
emoji	string	Emoji name.
potDistributionPercent	double?	How much of the pot should be distributed to the guild members, must be between 0 and 100
potDistributionType	string	How the pot should be distributed to the guild members, must be one of the following: ROLL_OVER, TOP_3, TOP_5, TOP_10, VOLUME_PERCENTAGE, TOP_3_BY_ADV, TOP_5_BY_ADV, TOP_10_BY_ADV, TOP_3_BY_ROI, TOP_5_BY_ROI, TOP_10_BY_ROI, RANDOM
potTraderId	double?	User ID of the guild member with order write permission for the pot	[optional]
description	string	Guild description, can be used to explain the guild to other users.	[optional]
twitter	string	Guild twitter handle.	[optional]
discord	string	Guild discord link.	[optional]
telegram	string	Guild telegram link.	[optional]
imgUrl	string	URL for the profile image of the guild, is used by clients to add some color to the guild, if no image is provided, a default image is used	[optional]
isPrivate	bool?	Guild privacy status	[optional]

Return type

Guild

Authorization

apiExpires, apiKey, 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]

GuildGet

List GuildGet ()

Get all guilds

Example

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

namespace Example
{
    public class GuildGetExample
    {
        public void main()
        {
            var apiInstance = new GuildApi();

            try
            {
                // Get all guilds
                List&lt;XAny&gt; result = apiInstance.GuildGet();
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling GuildApi.GuildGet: " + e.Message );
            }
        }
    }
}

Parameters

This endpoint does not need any parameter.

Return type

List

Authorization

No authorization required

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]

GuildJoin

Object GuildJoin (string code)

Request to Join a private guild or join a public guild

Example

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

namespace Example
{
    public class GuildJoinExample
    {
        public void main()
        {
            // Configure API key authorization: apiExpires
            Configuration.Default.AddApiKey("api-expires", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.AddApiKeyPrefix("api-expires", "Bearer");
            // 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: 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 GuildApi();
            var code = code_example;  // string | 

            try
            {
                // Request to Join a private guild or join a public guild
                Object result = apiInstance.GuildJoin(code);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling GuildApi.GuildJoin: " + e.Message );
            }
        }
    }
}

Parameters

Name	Type	Description	Notes
code	string

Return type

Object

Authorization

apiExpires, apiKey, 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]

GuildKick

Object GuildKick (double? memberUserId)

Kick member from guild

Example

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

namespace Example
{
    public class GuildKickExample
    {
        public void main()
        {
            // Configure API key authorization: apiExpires
            Configuration.Default.AddApiKey("api-expires", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.AddApiKeyPrefix("api-expires", "Bearer");
            // 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: 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 GuildApi();
            var memberUserId = 1.2;  // double? | 

            try
            {
                // Kick member from guild
                Object result = apiInstance.GuildKick(memberUserId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling GuildApi.GuildKick: " + e.Message );
            }
        }
    }
}

Parameters

Name	Type	Description	Notes
memberUserId	double?

Return type

Object

Authorization

apiExpires, apiKey, 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]

GuildLeave

Object GuildLeave ()

Leave guild or cancel guild join request

Example

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

namespace Example
{
    public class GuildLeaveExample
    {
        public void main()
        {
            // Configure API key authorization: apiExpires
            Configuration.Default.AddApiKey("api-expires", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.AddApiKeyPrefix("api-expires", "Bearer");
            // 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: 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 GuildApi();

            try
            {
                // Leave guild or cancel guild join request
                Object result = apiInstance.GuildLeave();
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling GuildApi.GuildLeave: " + e.Message );
            }
        }
    }
}

Parameters

This endpoint does not need any parameter.

Return type

Object

Authorization

apiExpires, apiKey, 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]

GuildNew

Guild GuildNew (string name, string emoji, double? potDistributionPercent, string potDistributionType, string description = null, string twitter = null, string discord = null, string telegram = null, string imgUrl = null, bool? isPrivate = null)

Creates a new guild

Example

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

namespace Example
{
    public class GuildNewExample
    {
        public void main()
        {
            // Configure API key authorization: apiExpires
            Configuration.Default.AddApiKey("api-expires", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.AddApiKeyPrefix("api-expires", "Bearer");
            // 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: 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 GuildApi();
            var name = name_example;  // string | Name of the guild, must be unique, must be at least 5 characters
            var emoji = emoji_example;  // string | Emoji name.
            var potDistributionPercent = 1.2;  // double? | How much of the pot should be distributed to the guild members, must be between 0 and 100
            var potDistributionType = potDistributionType_example;  // string | How the pot should be distributed to the guild members, must be one of the following: ROLL_OVER, TOP_3, TOP_5, TOP_10, VOLUME_PERCENTAGE, TOP_3_BY_ADV, TOP_5_BY_ADV, TOP_10_BY_ADV, TOP_3_BY_ROI, TOP_5_BY_ROI, TOP_10_BY_ROI, RANDOM
            var description = description_example;  // string | Guild description, can be used to explain the guild to other users. (optional) 
            var twitter = twitter_example;  // string | Guild twitter handle. (optional) 
            var discord = discord_example;  // string | Guild discord link. (optional) 
            var telegram = telegram_example;  // string | Guild telegram link. (optional) 
            var imgUrl = imgUrl_example;  // string | URL for the profile image of the guild, is used by clients to add some color to the guild, if no image is provided, a default image is used (optional) 
            var isPrivate = true;  // bool? | Guild privacy status (optional) 

            try
            {
                // Creates a new guild
                Guild result = apiInstance.GuildNew(name, emoji, potDistributionPercent, potDistributionType, description, twitter, discord, telegram, imgUrl, isPrivate);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling GuildApi.GuildNew: " + e.Message );
            }
        }
    }
}

Parameters

Name	Type	Description	Notes
name	string	Name of the guild, must be unique, must be at least 5 characters
emoji	string	Emoji name.
potDistributionPercent	double?	How much of the pot should be distributed to the guild members, must be between 0 and 100
potDistributionType	string	How the pot should be distributed to the guild members, must be one of the following: ROLL_OVER, TOP_3, TOP_5, TOP_10, VOLUME_PERCENTAGE, TOP_3_BY_ADV, TOP_5_BY_ADV, TOP_10_BY_ADV, TOP_3_BY_ROI, TOP_5_BY_ROI, TOP_10_BY_ROI, RANDOM
description	string	Guild description, can be used to explain the guild to other users.	[optional]
twitter	string	Guild twitter handle.	[optional]
discord	string	Guild discord link.	[optional]
telegram	string	Guild telegram link.	[optional]
imgUrl	string	URL for the profile image of the guild, is used by clients to add some color to the guild, if no image is provided, a default image is used	[optional]
isPrivate	bool?	Guild privacy status	[optional]

Return type

Guild

Authorization

apiExpires, apiKey, 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]

GuildShareTrades

Object GuildShareTrades (bool? shareTrades)

Toggle share trades for your account, which controls whether your guild members can see your orders and positions in their UI

Example

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

namespace Example
{
    public class GuildShareTradesExample
    {
        public void main()
        {
            // Configure API key authorization: apiExpires
            Configuration.Default.AddApiKey("api-expires", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.AddApiKeyPrefix("api-expires", "Bearer");
            // 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: 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 GuildApi();
            var shareTrades = true;  // bool? | 

            try
            {
                // Toggle share trades for your account, which controls whether your guild members can see your orders and positions in their UI
                Object result = apiInstance.GuildShareTrades(shareTrades);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling GuildApi.GuildShareTrades: " + e.Message );
            }
        }
    }
}

Parameters

Name	Type	Description	Notes
shareTrades	bool?

Return type

Object

Authorization

apiExpires, apiKey, 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]

Files

GuildApi.md

Latest commit

History

GuildApi.md

File metadata and controls

IO.Swagger.Api.GuildApi

GuildArchive

Example

Parameters

Return type

Authorization

HTTP request headers

GuildEdit

Example

Parameters

Return type

Authorization

HTTP request headers

GuildGet

Example

Parameters

Return type

Authorization

HTTP request headers

GuildJoin

Example

Parameters

Return type

Authorization

HTTP request headers

GuildKick

Example

Parameters

Return type

Authorization

HTTP request headers

GuildLeave

Example

Parameters

Return type

Authorization

HTTP request headers

GuildNew

Example

Parameters

Return type

Authorization

HTTP request headers

GuildShareTrades

Example

Parameters

Return type

Authorization

HTTP request headers