Skip to content

Latest commit

 

History

History
112 lines (80 loc) · 3.36 KB

PorlApi.md

File metadata and controls

112 lines (80 loc) · 3.36 KB

PorlApi

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

Method HTTP request Description
porlGetNonce GET /porl/nonce Get your Proof of Reserves nonce and data.
porlGetSnapshots GET /porl/snapshots Get Proof of Reserves historical snapshots

porlGetNonce

Porl porlGetNonce()

Get your Proof of Reserves nonce and data.

Proof of Reserves Nonce This endpoint will return the nonce and associated data needed to validate BitMEX reserves data. <! TODO link to docs, GitHub, etc >

Example

// Import classes:
//import io.swagger.client.ApiClient;
//import io.swagger.client.ApiException;
//import io.swagger.client.Configuration;
//import io.swagger.client.auth.*;
//import io.swagger.client.api.PorlApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure API key authorization: apiExpires
ApiKeyAuth apiExpires = (ApiKeyAuth) defaultClient.getAuthentication("apiExpires");
apiExpires.setApiKey("YOUR API KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//apiExpires.setApiKeyPrefix("Token");

// Configure API key authorization: apiKey
ApiKeyAuth apiKey = (ApiKeyAuth) defaultClient.getAuthentication("apiKey");
apiKey.setApiKey("YOUR API KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//apiKey.setApiKeyPrefix("Token");

// Configure API key authorization: apiSignature
ApiKeyAuth apiSignature = (ApiKeyAuth) defaultClient.getAuthentication("apiSignature");
apiSignature.setApiKey("YOUR API KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//apiSignature.setApiKeyPrefix("Token");

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

Parameters

This endpoint does not need any parameter.

Return type

Porl

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

porlGetSnapshots

List<XAny> porlGetSnapshots()

Get Proof of Reserves historical snapshots

Example

// Import classes:
//import io.swagger.client.ApiException;
//import io.swagger.client.api.PorlApi;


PorlApi apiInstance = new PorlApi();
try {
    List<XAny> result = apiInstance.porlGetSnapshots();
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling PorlApi#porlGetSnapshots");
    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