AddressApi.md

IO.Swagger.Api.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

List

AddressGet ()

Get your addresses.

Example

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

namespace Example
{
    public class AddressGetExample
    {
        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 AddressApi();

            try
            {
                // Get your addresses.
                List<Address> result = apiInstance.AddressGet();
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AddressApi.AddressGet: " + e.Message );
            }
        }
    }
}

Parameters

This endpoint does not need any parameter.

Return type

List

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 (string currency, string network, string address, string name, string note = null, bool? skipConfirm = null, bool? skip2FA = null, string memo = null)

Creates a new saved address.

Example

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

namespace Example
{
    public class AddressNewExample
    {
        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 AddressApi();
            var currency = currency_example;  // string | Currency of the address. Options: `XBt`, `USDt`
            var network = network_example;  // string | Selected network.
            var address = address_example;  // string | Destination Address.
            var name = name_example;  // string | Name of the entry, eg. 'Hardware wallet'.
            var note = note_example;  // string | Optional annotation. (optional) 
            var skipConfirm = true;  // bool? | Skip e-mail confirmations for transfers to this address. Will require an email confirmation after creation. (optional)  (default to false)
            var skip2FA = true;  // bool? | Skip 2FA confirmations for transfers to this address. Will require an email confirmation after creation. (optional)  (default to false)
            var memo = memo_example;  // string | Destination Memo. (optional) 

            try
            {
                // Creates a new saved address.
                Address result = apiInstance.AddressNew(currency, network, address, name, note, skipConfirm, skip2FA, memo);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AddressApi.AddressNew: " + e.Message );
            }
        }
    }
}

Parameters

Name	Type	Description	Notes
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'.
note	string	Optional annotation.	[optional]
skipConfirm	bool?	Skip e-mail confirmations for transfers to this address. Will require an email confirmation after creation.	[optional] [default to false]
skip2FA	bool?	Skip 2FA confirmations for transfers to this address. Will require an email confirmation after creation.	[optional] [default to false]
memo	string	Destination Memo.	[optional]

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]