Skip to content

Latest commit

 

History

History
76 lines (47 loc) · 2.89 KB

AddressApi.md

File metadata and controls

76 lines (47 loc) · 2.89 KB

\AddressApi

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

Method HTTP request Description
AddressGet Get /address Get your addresses.
AddressNew Post /address Creates a new saved address.

AddressGet

[]Address AddressGet(ctx, ) Get your addresses.

Required Parameters

This endpoint does not need any parameter.

Return type

[]Address

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]

AddressNew

Address AddressNew(ctx, currency, network, address, name, optional) Creates a new saved address.

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
currency string Currency of the address. Options: `XBt`, `USDt`
network string Selected network.
address string Destination Address.
name string Name of the entry, eg. 'Hardware wallet'.
optional *AddressApiAddressNewOpts optional parameters nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a AddressApiAddressNewOpts struct

Name Type Description Notes

note | optional.String| Optional annotation. | skipConfirm | optional.Bool| Skip e-mail confirmations for transfers to this address. Will require an email confirmation after creation. | [default to false] skip2FA | optional.Bool| Skip 2FA confirmations for transfers to this address. Will require an email confirmation after creation. | [default to false] memo | optional.String| Destination Memo. |

Return type

Address

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]