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

// Import classes:
//import io.swagger.client.api.GuildApi;

GuildApi apiInstance = new GuildApi();
try {
    Object result = apiInstance.guildArchive();
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling GuildApi#guildArchive");
    e.printStackTrace();
}

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

guildEdit

Guild guildEdit(name, emoji, potDistributionPercent, potDistributionType, potTraderId, description, twitter, discord, telegram, imgUrl, isPrivate)

Edit guild new guild

Example

// Import classes:
//import io.swagger.client.api.GuildApi;

GuildApi apiInstance = new GuildApi();
String name = "name_example"; // String | Name of the guild, must be unique, must be at least 5 characters
String emoji = "emoji_example"; // String | Emoji name.
Double potDistributionPercent = 3.4D; // Double | How much of the pot should be distributed to the guild members, must be between 0 and 100
String 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
Double potTraderId = 3.4D; // Double | User ID of the guild member with order write permission for the pot
String description = "description_example"; // String | Guild description, can be used to explain the guild to other users.
String twitter = "twitter_example"; // String | Guild twitter handle.
String discord = "discord_example"; // String | Guild discord link.
String telegram = "telegram_example"; // String | Guild telegram link.
String 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
Boolean isPrivate = true; // Boolean | Guild privacy status
try {
    Guild result = apiInstance.guildEdit(name, emoji, potDistributionPercent, potDistributionType, potTraderId, description, twitter, discord, telegram, imgUrl, isPrivate);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling GuildApi#guildEdit");
    e.printStackTrace();
}

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	Boolean	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

guildGet

List<XAny> guildGet()

Get all guilds

Example

// Import classes:
//import io.swagger.client.api.GuildApi;

GuildApi apiInstance = new GuildApi();
try {
    List<XAny> result = apiInstance.guildGet();
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling GuildApi#guildGet");
    e.printStackTrace();
}

Parameters

This endpoint does not need any parameter.

Return type

List<XAny>

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

guildJoin

Object guildJoin(code)

Request to Join a private guild or join a public guild

Example

// Import classes:
//import io.swagger.client.api.GuildApi;

GuildApi apiInstance = new GuildApi();
String code = "code_example"; // String | 
try {
    Object result = apiInstance.guildJoin(code);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling GuildApi#guildJoin");
    e.printStackTrace();
}

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

guildKick

Object guildKick(memberUserId)

Kick member from guild

Example

// Import classes:
//import io.swagger.client.api.GuildApi;

GuildApi apiInstance = new GuildApi();
Double memberUserId = 3.4D; // Double | 
try {
    Object result = apiInstance.guildKick(memberUserId);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling GuildApi#guildKick");
    e.printStackTrace();
}

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

guildLeave

Object guildLeave()

Leave guild or cancel guild join request

Example

// Import classes:
//import io.swagger.client.api.GuildApi;

GuildApi apiInstance = new GuildApi();
try {
    Object result = apiInstance.guildLeave();
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling GuildApi#guildLeave");
    e.printStackTrace();
}

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

guildNew

Guild guildNew(name, emoji, potDistributionPercent, potDistributionType, description, twitter, discord, telegram, imgUrl, isPrivate)

Creates a new guild

Example

// Import classes:
//import io.swagger.client.api.GuildApi;

GuildApi apiInstance = new GuildApi();
String name = "name_example"; // String | Name of the guild, must be unique, must be at least 5 characters
String emoji = "emoji_example"; // String | Emoji name.
Double potDistributionPercent = 3.4D; // Double | How much of the pot should be distributed to the guild members, must be between 0 and 100
String 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
String description = "description_example"; // String | Guild description, can be used to explain the guild to other users.
String twitter = "twitter_example"; // String | Guild twitter handle.
String discord = "discord_example"; // String | Guild discord link.
String telegram = "telegram_example"; // String | Guild telegram link.
String 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
Boolean isPrivate = true; // Boolean | Guild privacy status
try {
    Guild result = apiInstance.guildNew(name, emoji, potDistributionPercent, potDistributionType, description, twitter, discord, telegram, imgUrl, isPrivate);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling GuildApi#guildNew");
    e.printStackTrace();
}

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	Boolean	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

guildShareTrades

Object guildShareTrades(shareTrades)

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

Example

// Import classes:
//import io.swagger.client.api.GuildApi;

GuildApi apiInstance = new GuildApi();
Boolean shareTrades = true; // Boolean | 
try {
    Object result = apiInstance.guildShareTrades(shareTrades);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling GuildApi#guildShareTrades");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
shareTrades	Boolean

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

Files

GuildApi.md

Latest commit

History

GuildApi.md

File metadata and controls

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