Skip to content

GuildApi.md

Latest commit

 

History

History
253 lines (160 loc) · 10.2 KB

GuildApi.md

File metadata and controls

253 lines (160 loc) · 10.2 KB

\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

interface{} GuildArchive(ctx, ) Archive a guild

Required Parameters

This endpoint does not need any parameter.

Return type

interface{}

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(ctx, name, emoji, potDistributionPercent, potDistributionType, optional) Edit guild new guild

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
name string Name of the guild, must be unique, must be at least 5 characters
emoji string Emoji name.
potDistributionPercent float64 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
optional *GuildApiGuildEditOpts optional parameters nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a GuildApiGuildEditOpts struct

Name Type Description Notes

potTraderId | optional.Float64| User ID of the guild member with order write permission for the pot | description | optional.String| Guild description, can be used to explain the guild to other users. | twitter | optional.String| Guild twitter handle. | discord | optional.String| Guild discord link. | telegram | optional.String| Guild telegram link. | imgUrl | optional.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 | isPrivate | optional.Bool| Guild privacy status |

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

[]XAny GuildGet(ctx, ) Get all guilds

Required Parameters

This endpoint does not need any parameter.

Return type

[]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

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

GuildJoin

interface{} GuildJoin(ctx, code) Request to Join a private guild or join a public guild

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
code string

Return type

interface{}

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

interface{} GuildKick(ctx, memberUserId) Kick member from guild

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
memberUserId float64

Return type

interface{}

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

interface{} GuildLeave(ctx, ) Leave guild or cancel guild join request

Required Parameters

This endpoint does not need any parameter.

Return type

interface{}

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(ctx, name, emoji, potDistributionPercent, potDistributionType, optional) Creates a new guild

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
name string Name of the guild, must be unique, must be at least 5 characters
emoji string Emoji name.
potDistributionPercent float64 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
optional *GuildApiGuildNewOpts optional parameters nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a GuildApiGuildNewOpts struct

Name Type Description Notes

description | optional.String| Guild description, can be used to explain the guild to other users. | twitter | optional.String| Guild twitter handle. | discord | optional.String| Guild discord link. | telegram | optional.String| Guild telegram link. | imgUrl | optional.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 | isPrivate | optional.Bool| Guild privacy status |

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

interface{} GuildShareTrades(ctx, shareTrades) Toggle share trades for your account, which controls whether your guild members can see your orders and positions in their UI

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
shareTrades bool

Return type

interface{}

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]