PrivateApi

All URIs are relative to https://api.cryptoweather.ai

Method	HTTP request	Description
v1PrivateAccuracySymbolIntervalPeriodGet	GET /v1/private/accuracy/{symbol}/{interval}/{period}	Accuracy
v1PrivateForecastAccuracySymbolIntervalPeriodGet	GET /v1/private/forecast-accuracy/{symbol}/{interval}/{period}	Forecast Accuracy
v1PrivateForecastSymbolIntervalGet	GET /v1/private/forecast/{symbol}/{interval}	Forecast
v1PrivateForecastTimeSymbolIntervalPeriodGet	GET /v1/private/forecast-time/{symbol}/{interval}/{period}	Forecast Time
v1PrivateTrendSymbolGet	GET /v1/private/trend/{symbol}	Trend
v1PrivateTrendTabularGet	GET /v1/private/trend-tabular	Trend Tabular

v1PrivateAccuracySymbolIntervalPeriodGet

PrivateAccuracyResponse v1PrivateAccuracySymbolIntervalPeriodGet(symbol, interval, period, cookie, xCsrf)

Accuracy

The accuracy response contains the following attributes. + `rmse` Root Mean Square Error + `mae` Mean Absolute error + `r2` R Squared + `ci` Confidence Interval lower and upper error bounds

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.PrivateApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure OAuth2 access token for authorization: oauth2
OAuth oauth2 = (OAuth) defaultClient.getAuthentication("oauth2");
oauth2.setAccessToken("YOUR ACCESS TOKEN");

PrivateApi apiInstance = new PrivateApi();
String symbol = "btc"; // String | The cryptocurrency symbol.
String interval = "1h"; // String | The forecast interval, 1h or 1d.
String period = "7d"; // String | The period for computing the accuracy, such as the past 7 days.
String cookie = "csrf=b1820141-1bad-4a9c-93c0-52022817ce89"; // String | e.g. csrf=b1820141-1bad-4a9c-93c0-52022817ce89
String xCsrf = "b1820141-1bad-4a9c-93c0-52022817ce89"; // String | e.g. b1820141-1bad-4a9c-93c0-52022817ce89
try {
    PrivateAccuracyResponse result = apiInstance.v1PrivateAccuracySymbolIntervalPeriodGet(symbol, interval, period, cookie, xCsrf);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling PrivateApi#v1PrivateAccuracySymbolIntervalPeriodGet");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
symbol	String	The cryptocurrency symbol.
interval	String	The forecast interval, 1h or 1d.
period	String	The period for computing the accuracy, such as the past 7 days.
cookie	String	e.g. csrf=b1820141-1bad-4a9c-93c0-52022817ce89	[optional]
xCsrf	String	e.g. b1820141-1bad-4a9c-93c0-52022817ce89	[optional]

Return type

PrivateAccuracyResponse

Authorization

oauth2

HTTP request headers

Content-Type: Not defined
Accept: application/json

v1PrivateForecastAccuracySymbolIntervalPeriodGet

PrivateForecastAccuracyResponse v1PrivateForecastAccuracySymbolIntervalPeriodGet(symbol, interval, period, cookie, xCsrf)

Forecast Accuracy

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.PrivateApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure OAuth2 access token for authorization: oauth2
OAuth oauth2 = (OAuth) defaultClient.getAuthentication("oauth2");
oauth2.setAccessToken("YOUR ACCESS TOKEN");

PrivateApi apiInstance = new PrivateApi();
String symbol = "btc"; // String | The cryptocurrency symbol.
String interval = "1h"; // String | The forecast interval, 1h or 1d.
String period = "7d"; // String | The period for computing the error bounds, typically 7d or 30d.
String cookie = "csrf=b1820141-1bad-4a9c-93c0-52022817ce89"; // String | e.g. csrf=b1820141-1bad-4a9c-93c0-52022817ce89
String xCsrf = "b1820141-1bad-4a9c-93c0-52022817ce89"; // String | e.g. b1820141-1bad-4a9c-93c0-52022817ce89
try {
    PrivateForecastAccuracyResponse result = apiInstance.v1PrivateForecastAccuracySymbolIntervalPeriodGet(symbol, interval, period, cookie, xCsrf);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling PrivateApi#v1PrivateForecastAccuracySymbolIntervalPeriodGet");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
symbol	String	The cryptocurrency symbol.
interval	String	The forecast interval, 1h or 1d.
period	String	The period for computing the error bounds, typically 7d or 30d.
cookie	String	e.g. csrf=b1820141-1bad-4a9c-93c0-52022817ce89	[optional]
xCsrf	String	e.g. b1820141-1bad-4a9c-93c0-52022817ce89	[optional]

Return type

PrivateForecastAccuracyResponse

Authorization

oauth2

HTTP request headers

Content-Type: Not defined
Accept: application/json

v1PrivateForecastSymbolIntervalGet

PrivateForecastResponse v1PrivateForecastSymbolIntervalGet(symbol, interval, cookie, xCsrf)

Forecast

The forecast response contains a sequence of forecasts at the specified intervals, with the following attributes. + `time_start` start time of the period the forecast is applicable for + `time_end` end time of the period the forecast is applicable for + `low` forecasted high during the period + `high` forecasted low during the period + `weighted_price` forecasted weighted price during the period + `change_pct` percent change in price for forecasted weighted_price relative to current price + `change_usd` dollar change in price for forecasted weighted_price relative to current price

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.PrivateApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure OAuth2 access token for authorization: oauth2
OAuth oauth2 = (OAuth) defaultClient.getAuthentication("oauth2");
oauth2.setAccessToken("YOUR ACCESS TOKEN");

PrivateApi apiInstance = new PrivateApi();
String symbol = "btc"; // String | The cryptocurrency symbol.
String interval = "1h"; // String | The forecast interval, 1h or 1d.
String cookie = "csrf=b1820141-1bad-4a9c-93c0-52022817ce89"; // String | e.g. csrf=b1820141-1bad-4a9c-93c0-52022817ce89
String xCsrf = "b1820141-1bad-4a9c-93c0-52022817ce89"; // String | e.g. b1820141-1bad-4a9c-93c0-52022817ce89
try {
    PrivateForecastResponse result = apiInstance.v1PrivateForecastSymbolIntervalGet(symbol, interval, cookie, xCsrf);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling PrivateApi#v1PrivateForecastSymbolIntervalGet");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
symbol	String	The cryptocurrency symbol.
interval	String	The forecast interval, 1h or 1d.
cookie	String	e.g. csrf=b1820141-1bad-4a9c-93c0-52022817ce89	[optional]
xCsrf	String	e.g. b1820141-1bad-4a9c-93c0-52022817ce89	[optional]

Return type

PrivateForecastResponse

Authorization

oauth2

HTTP request headers

Content-Type: Not defined
Accept: application/json

v1PrivateForecastTimeSymbolIntervalPeriodGet

PrivateForecastTimeResponse v1PrivateForecastTimeSymbolIntervalPeriodGet(symbol, interval, period, cookie, xCsrf)

Forecast Time

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.PrivateApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure OAuth2 access token for authorization: oauth2
OAuth oauth2 = (OAuth) defaultClient.getAuthentication("oauth2");
oauth2.setAccessToken("YOUR ACCESS TOKEN");

PrivateApi apiInstance = new PrivateApi();
String symbol = "btc"; // String | The cryptocurrency symbol.
String interval = "1h"; // String | The forecast interval, 1h or 1d.
String period = "7d"; // String | The period for computing the error bounds, typically 7d or 30d.
String cookie = "csrf=b1820141-1bad-4a9c-93c0-52022817ce89"; // String | e.g. csrf=b1820141-1bad-4a9c-93c0-52022817ce89
String xCsrf = "b1820141-1bad-4a9c-93c0-52022817ce89"; // String | e.g. b1820141-1bad-4a9c-93c0-52022817ce89
try {
    PrivateForecastTimeResponse result = apiInstance.v1PrivateForecastTimeSymbolIntervalPeriodGet(symbol, interval, period, cookie, xCsrf);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling PrivateApi#v1PrivateForecastTimeSymbolIntervalPeriodGet");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
symbol	String	The cryptocurrency symbol.
interval	String	The forecast interval, 1h or 1d.
period	String	The period for computing the error bounds, typically 7d or 30d.
cookie	String	e.g. csrf=b1820141-1bad-4a9c-93c0-52022817ce89	[optional]
xCsrf	String	e.g. b1820141-1bad-4a9c-93c0-52022817ce89	[optional]

Return type

PrivateForecastTimeResponse

Authorization

oauth2

HTTP request headers

Content-Type: Not defined
Accept: application/json

v1PrivateTrendSymbolGet

PublicTrendResponse v1PrivateTrendSymbolGet(symbol, cookie, xCsrf)

Trend

The trend response contains a collection of forecasts for different intervals with the following attributes. + `time_start` start time of the period the forecast is applicable for + `time_end` end time of the period the forecast is applicable for + `interval` interval in hours that the forecast is applicable for + `weighted_price` forecasted weighted price during the period + `change_pct` percent change in price for forecasted weighted_price relative to current price + `change_usd` dollar change in price for forecasted weighted_price relative to current price

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.PrivateApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure OAuth2 access token for authorization: oauth2
OAuth oauth2 = (OAuth) defaultClient.getAuthentication("oauth2");
oauth2.setAccessToken("YOUR ACCESS TOKEN");

PrivateApi apiInstance = new PrivateApi();
String symbol = "btc"; // String | The cryptocurrency symbol.
String cookie = "csrf=b1820141-1bad-4a9c-93c0-52022817ce89"; // String | e.g. csrf=b1820141-1bad-4a9c-93c0-52022817ce89
String xCsrf = "b1820141-1bad-4a9c-93c0-52022817ce89"; // String | e.g. b1820141-1bad-4a9c-93c0-52022817ce89
try {
    PublicTrendResponse result = apiInstance.v1PrivateTrendSymbolGet(symbol, cookie, xCsrf);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling PrivateApi#v1PrivateTrendSymbolGet");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
symbol	String	The cryptocurrency symbol.
cookie	String	e.g. csrf=b1820141-1bad-4a9c-93c0-52022817ce89	[optional]
xCsrf	String	e.g. b1820141-1bad-4a9c-93c0-52022817ce89	[optional]

Return type

PublicTrendResponse

Authorization

oauth2

HTTP request headers

Content-Type: Not defined
Accept: application/json

v1PrivateTrendTabularGet

PrivateTrendTabularResponse v1PrivateTrendTabularGet(cookie, xCsrf)

Trend Tabular

The trend tabular response contains a collection of forecasts for all supported cryptocurrencies at different intervals with the following attributes. + `time_start` start time of the period the forecast is applicable for + `time_end` end time of the period the forecast is applicable for + `interval` interval in hours that the forecast is applicable for + `weighted_price` forecasted weighted price during the period + `change_pct` percent change in price for forecasted weighted_price relative to current price + `change_usd` dollar change in price for forecasted weighted_price relative to current price

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.PrivateApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure OAuth2 access token for authorization: oauth2
OAuth oauth2 = (OAuth) defaultClient.getAuthentication("oauth2");
oauth2.setAccessToken("YOUR ACCESS TOKEN");

PrivateApi apiInstance = new PrivateApi();
String cookie = "csrf=b1820141-1bad-4a9c-93c0-52022817ce89"; // String | e.g. csrf=b1820141-1bad-4a9c-93c0-52022817ce89
String xCsrf = "b1820141-1bad-4a9c-93c0-52022817ce89"; // String | e.g. b1820141-1bad-4a9c-93c0-52022817ce89
try {
    PrivateTrendTabularResponse result = apiInstance.v1PrivateTrendTabularGet(cookie, xCsrf);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling PrivateApi#v1PrivateTrendTabularGet");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
cookie	String	e.g. csrf=b1820141-1bad-4a9c-93c0-52022817ce89	[optional]
xCsrf	String	e.g. b1820141-1bad-4a9c-93c0-52022817ce89	[optional]

Return type

PrivateTrendTabularResponse

Authorization

oauth2

HTTP request headers

Content-Type: Not defined
Accept: application/json

Files

PrivateApi.md

Latest commit

History

PrivateApi.md

File metadata and controls

PrivateApi

v1PrivateAccuracySymbolIntervalPeriodGet

Example

Parameters

Return type

Authorization

HTTP request headers

v1PrivateForecastAccuracySymbolIntervalPeriodGet

Example

Parameters

Return type

Authorization

HTTP request headers

v1PrivateForecastSymbolIntervalGet

Example

Parameters

Return type

Authorization

HTTP request headers

v1PrivateForecastTimeSymbolIntervalPeriodGet

Example

Parameters

Return type

Authorization

HTTP request headers

v1PrivateTrendSymbolGet

Example

Parameters

Return type

Authorization

HTTP request headers

v1PrivateTrendTabularGet

Example

Parameters

Return type

Authorization

HTTP request headers