Skip to content

Latest commit

 

History

History
366 lines (279 loc) · 10.3 KB

PublicApi.md

File metadata and controls

366 lines (279 loc) · 10.3 KB
Raw

IO.Swagger.Api.PublicApi

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

Method HTTP request Description
V1PublicPriceChangeSymbolGet GET /v1/public/price-change/{symbol} Price Change
V1PublicPriceCurrentSymbolGet GET /v1/public/price-current/{symbol} Price Current
V1PublicPriceHistorySymbolPeriodIntervalGet GET /v1/public/price-history/{symbol}/{period}/{interval} Price History
V1PublicSummaryGet GET /v1/public/summary Summary
V1PublicSymbolsGet GET /v1/public/symbols Symbols
V1PublicTrendSymbolGet GET /v1/public/trend/{symbol} Trend

V1PublicPriceChangeSymbolGet

PublicPriceChangeResponse V1PublicPriceChangeSymbolGet (string symbol)

Price Change

Example

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

namespace Example
{
    public class V1PublicPriceChangeSymbolGetExample
    {
        public void main()
        {
            var apiInstance = new PublicApi();
            var symbol = btc;  // string | The cryptocurrency symbol.

            try
            {
                // Price Change
                PublicPriceChangeResponse result = apiInstance.V1PublicPriceChangeSymbolGet(symbol);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling PublicApi.V1PublicPriceChangeSymbolGet: " + e.Message );
            }
        }
    }
}

Parameters

Name Type Description Notes
symbol string The cryptocurrency symbol.

Return type

PublicPriceChangeResponse

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

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

V1PublicPriceCurrentSymbolGet

PublicPriceCurrentResponse V1PublicPriceCurrentSymbolGet (string symbol)

Price Current

Example

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

namespace Example
{
    public class V1PublicPriceCurrentSymbolGetExample
    {
        public void main()
        {
            var apiInstance = new PublicApi();
            var symbol = btc;  // string | The cryptocurrency symbol, provide `all` to get every symbol.

            try
            {
                // Price Current
                PublicPriceCurrentResponse result = apiInstance.V1PublicPriceCurrentSymbolGet(symbol);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling PublicApi.V1PublicPriceCurrentSymbolGet: " + e.Message );
            }
        }
    }
}

Parameters

Name Type Description Notes
symbol string The cryptocurrency symbol, provide `all` to get every symbol.

Return type

PublicPriceCurrentResponse

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

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

V1PublicPriceHistorySymbolPeriodIntervalGet

PublicPriceHistoryResponse V1PublicPriceHistorySymbolPeriodIntervalGet (string symbol, string period, string interval)

Price History

Example

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

namespace Example
{
    public class V1PublicPriceHistorySymbolPeriodIntervalGetExample
    {
        public void main()
        {
            var apiInstance = new PublicApi();
            var symbol = btc;  // string | The cryptocurrency symbol, provide `all` to get every symbol.
            var period = 30d;  // string | The period to get data for, such as past 30 days.
            var interval = 1d;  // string | The bar interval, such as 1 day.

            try
            {
                // Price History
                PublicPriceHistoryResponse result = apiInstance.V1PublicPriceHistorySymbolPeriodIntervalGet(symbol, period, interval);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling PublicApi.V1PublicPriceHistorySymbolPeriodIntervalGet: " + e.Message );
            }
        }
    }
}

Parameters

Name Type Description Notes
symbol string The cryptocurrency symbol, provide `all` to get every symbol.
period string The period to get data for, such as past 30 days.
interval string The bar interval, such as 1 day.

Return type

PublicPriceHistoryResponse

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

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

V1PublicSummaryGet

PublicSummaryResponse V1PublicSummaryGet ()

Summary

Example

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

namespace Example
{
    public class V1PublicSummaryGetExample
    {
        public void main()
        {
            var apiInstance = new PublicApi();

            try
            {
                // Summary
                PublicSummaryResponse result = apiInstance.V1PublicSummaryGet();
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling PublicApi.V1PublicSummaryGet: " + e.Message );
            }
        }
    }
}

Parameters

This endpoint does not need any parameter.

Return type

PublicSummaryResponse

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

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

V1PublicSymbolsGet

PublicSymbolsResponse V1PublicSymbolsGet ()

Symbols

Example

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

namespace Example
{
    public class V1PublicSymbolsGetExample
    {
        public void main()
        {
            var apiInstance = new PublicApi();

            try
            {
                // Symbols
                PublicSymbolsResponse result = apiInstance.V1PublicSymbolsGet();
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling PublicApi.V1PublicSymbolsGet: " + e.Message );
            }
        }
    }
}

Parameters

This endpoint does not need any parameter.

Return type

PublicSymbolsResponse

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

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

V1PublicTrendSymbolGet

PublicTrendResponse V1PublicTrendSymbolGet (string symbol)

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

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

namespace Example
{
    public class V1PublicTrendSymbolGetExample
    {
        public void main()
        {
            var apiInstance = new PublicApi();
            var symbol = btc;  // string | The cryptocurrency symbol.

            try
            {
                // Trend
                PublicTrendResponse result = apiInstance.V1PublicTrendSymbolGet(symbol);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling PublicApi.V1PublicTrendSymbolGet: " + e.Message );
            }
        }
    }
}

Parameters

Name Type Description Notes
symbol string The cryptocurrency symbol.

Return type

PublicTrendResponse

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

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