The CryptoWeather API allows for access to all of the cryptocurrency data and market forecast services provided. There are two primary categories of routes, public and private, where public routes are accessible to the general public and do not require API authentication, and private routes, which require API authentication. ## General Overview 1. All API methods adhere to RESTful best practices as closely as possible. As such, all API calls will be made via the standard HTTP protocol using the GET/POST/PUT/DELETE request types. 2. Every request returns the status as a JSON response with the following: - success, true if it was successful - code, the http status code (also in the response header) - 200 if response is successful - 400 if bad request - 401 if authorization JWT is wrong or limit exceeded - 404 wrong route - 500 for any internal errors - status, the status of the request, default success - errors, an array of any relevant error details 3. For any requests that are not successful an error message is specified and returned as an array for the errors key in the JSON response. 4. All authentication uses JSON Web Tokens (JWT), which is set as the Authorization entry in the header, see the following for more details. - http://jwt.io - https://scotch.io/tutorials/the-anatomy-of-a-json-web-token ## Code Example The following is a code example in Python, which demonstrates using the Python Requests library for both the public and private API routes. import requests HOST = \"https://api.cryptoweather.ai/v1\" # Your API key (JWT) API_KEY = \"<YOUR API KEY>\" # Example public request, no API key required. requests.get(\"{}/public/symbols\".format(HOST)).json() # Get the current btc price using the public route requests.get(\"{}/public/price-current/{}\".format(HOST, \"btc\")).json() # Example private request, API key required. Get the btc hourly forecasts headers = {\"Authorization\": \"Bearer {}\".format(API_KEY)} requests.get(\"{}/private/forecast/{}/{}\".format(HOST, \"btc\", \"1h\"), headers=headers).json()
This API client was generated by the swagger-codegen project. By using the swagger-spec from a remote server, you can easily generate an API client.
- API version:
- Package version: 1.0.0
- Build package: io.swagger.codegen.languages.GoClientCodegen
Put the package under your project folder and add the following in import:
import "./swagger"All URIs are relative to https://api.cryptoweather.ai
| Class | Method | HTTP request | Description |
|---|---|---|---|
| PrivateApi | V1PrivateAccuracySymbolIntervalPeriodGet | Get /v1/private/accuracy/{symbol}/{interval}/{period} | Accuracy |
| PrivateApi | V1PrivateForecastAccuracySymbolIntervalPeriodGet | Get /v1/private/forecast-accuracy/{symbol}/{interval}/{period} | Forecast Accuracy |
| PrivateApi | V1PrivateForecastSymbolIntervalGet | Get /v1/private/forecast/{symbol}/{interval} | Forecast |
| PrivateApi | V1PrivateForecastTimeSymbolIntervalPeriodGet | Get /v1/private/forecast-time/{symbol}/{interval}/{period} | Forecast Time |
| PrivateApi | V1PrivateTrendSymbolGet | Get /v1/private/trend/{symbol} | Trend |
| PrivateApi | V1PrivateTrendTabularGet | Get /v1/private/trend-tabular | Trend Tabular |
| PublicApi | V1PublicPriceChangeSymbolGet | Get /v1/public/price-change/{symbol} | Price Change |
| PublicApi | V1PublicPriceCurrentSymbolGet | Get /v1/public/price-current/{symbol} | Price Current |
| PublicApi | V1PublicPriceHistorySymbolPeriodIntervalGet | Get /v1/public/price-history/{symbol}/{period}/{interval} | Price History |
| PublicApi | V1PublicSummaryGet | Get /v1/public/summary | Summary |
| PublicApi | V1PublicSymbolsGet | Get /v1/public/symbols | Symbols |
| PublicApi | V1PublicTrendSymbolGet | Get /v1/public/trend/{symbol} | Trend |
- AccuracyRoute
- DefaultResponse
- ForecastAccuracyRoute
- ForecastRoute
- ForecastTimeRoute
- PriceChangeRoute
- PriceCurrentRoute
- PriceHistoryRoute
- PrivateAccuracyResponse
- PrivateAccuracyResponseData
- PrivateForecastAccuracyResponse
- PrivateForecastAccuracyResponseData
- PrivateForecastResponse
- PrivateForecastResponseData
- PrivateForecastResponseDataForecast
- PrivateForecastTimeResponse
- PrivateForecastTimeResponseData
- PrivateTrendTabularResponse
- PrivateTrendTabularResponseData
- PrivateTrendTabularResponseDataTrendTabular
- PublicPriceChangeResponse
- PublicPriceChangeResponseData
- PublicPriceChangeResponseDataPriceChange
- PublicPriceCurrentResponse
- PublicPriceCurrentResponseData
- PublicPriceCurrentResponseDataCurrent
- PublicPriceHistoryResponse
- PublicPriceHistoryResponseData
- PublicPriceHistoryResponseDataHistory
- PublicPriceHistoryResponseDataPriceHistory
- PublicSummaryResponse
- PublicSummaryResponseColor
- PublicSummaryResponseData
- PublicSymbolsResponse
- PublicSymbolsResponseData
- PublicSymbolsResponseDataSymbols
- PublicTrendResponse
- PublicTrendResponseData
- PublicTrendResponseDataTrend
- SummaryRoute
- SymbolsRoute
- TrendRoute
- TrendTabluarRoute
- Type: OAuth
- Flow: accessCode
- Authorization URL:
- Scopes: N/A
Example
auth := context.WithValue(context.Background(), sw.ContextAccessToken, "ACCESSTOKENSTRING")
r, err := client.Service.Operation(auth, args)Or via OAuth2 module to automatically refresh tokens and perform user authentication.
import "golang.org/x/oauth2"
/* Perform OAuth2 round trip request and obtain a token */
tokenSource := oauth2cfg.TokenSource(createContext(httpClient), &token)
auth := context.WithValue(oauth2.NoContext, sw.ContextOAuth2, tokenSource)
r, err := client.Service.Operation(auth, args)