coinmarketcap_client 1.0.1 → 1.0.2
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/README.md +20 -9
- data/docs/{Info.md → CryptocurrencyInfo.md} +2 -2
- data/docs/{InfoUrls.md → CryptocurrencyInfoUrls.md} +1 -1
- data/docs/{MarketData.md → CryptocurrencyListings.md} +1 -1
- data/docs/{Map.md → CryptocurrencyMap.md} +1 -1
- data/docs/DefaultApi.md +146 -22
- data/docs/GlobalMetricsHistoricalQuote.md +10 -0
- data/docs/GlobalMetricsQuote.md +10 -0
- data/docs/GlobalMetricsQuotesHistorical.md +10 -0
- data/docs/GlobalMetricsQuotesLatest.md +14 -0
- data/docs/InlineResponse200.md +1 -1
- data/docs/InlineResponse2001.md +1 -1
- data/docs/InlineResponse2002.md +1 -1
- data/docs/InlineResponse2003.md +1 -1
- data/docs/InlineResponse2004.md +1 -1
- data/docs/InlineResponse2004Data.md +8 -0
- data/docs/InlineResponse2005.md +1 -1
- data/docs/InlineResponse2006.md +9 -0
- data/docs/InlineResponse2007.md +9 -0
- data/docs/InlineResponse2008.md +9 -0
- data/docs/InlineResponse2009.md +9 -0
- data/docs/Quote.md +1 -1
- data/lib/coinmarketcap_client.rb +13 -4
- data/lib/coinmarketcap_client/api/default_api.rb +150 -26
- data/lib/coinmarketcap_client/models/{info.rb → cryptocurrency_info.rb} +2 -2
- data/lib/coinmarketcap_client/models/{info_urls.rb → cryptocurrency_info_urls.rb} +1 -1
- data/lib/coinmarketcap_client/models/{market_data.rb → cryptocurrency_listings.rb} +1 -1
- data/lib/coinmarketcap_client/models/{map.rb → cryptocurrency_map.rb} +1 -1
- data/lib/coinmarketcap_client/models/global_metrics_historical_quote.rb +202 -0
- data/lib/coinmarketcap_client/models/global_metrics_quote.rb +202 -0
- data/lib/{coinmarketcap_api/models/inline_response_200_3.rb → coinmarketcap_client/models/global_metrics_quotes_historical.rb} +30 -11
- data/lib/{coinmarketcap_api/models/map.rb → coinmarketcap_client/models/global_metrics_quotes_latest.rb} +49 -55
- data/lib/coinmarketcap_client/models/inline_response_200.rb +1 -1
- data/lib/coinmarketcap_client/models/inline_response_200_1.rb +1 -1
- data/lib/coinmarketcap_client/models/inline_response_200_2.rb +1 -1
- data/lib/coinmarketcap_client/models/inline_response_200_3.rb +2 -4
- data/lib/coinmarketcap_client/models/inline_response_200_4.rb +2 -4
- data/lib/{coinmarketcap_api/models/inline_response_200_1.rb → coinmarketcap_client/models/inline_response_200_4_data.rb} +11 -11
- data/lib/coinmarketcap_client/models/inline_response_200_5.rb +1 -1
- data/lib/{coinmarketcap_api/models/inline_response_200_2.rb → coinmarketcap_client/models/inline_response_200_6.rb} +5 -5
- data/lib/{coinmarketcap_api/models/inline_response_200.rb → coinmarketcap_client/models/inline_response_200_7.rb} +4 -4
- data/lib/{coinmarketcap_api/models/inline_response_default_1.rb → coinmarketcap_client/models/inline_response_200_8.rb} +13 -4
- data/lib/{coinmarketcap_api/models/inline_response_default.rb → coinmarketcap_client/models/inline_response_200_9.rb} +13 -4
- data/lib/coinmarketcap_client/models/quote.rb +1 -1
- data/lib/coinmarketcap_client/version.rb +1 -1
- data/spec/api/default_api_spec.rb +71 -6
- data/spec/api_client_spec.rb +29 -29
- data/spec/configuration_spec.rb +3 -3
- data/spec/models/{info_spec.rb → cryptocurrency_info_spec.rb} +6 -6
- data/spec/models/{info_urls_spec.rb → cryptocurrency_info_urls_spec.rb} +6 -6
- data/spec/models/{market_data_spec.rb → cryptocurrency_listings_spec.rb} +6 -6
- data/spec/models/{map_spec.rb → cryptocurrency_map_spec.rb} +6 -6
- data/spec/models/global_metrics_historical_quote_spec.rb +53 -0
- data/spec/models/global_metrics_quote_spec.rb +53 -0
- data/spec/models/global_metrics_quotes_historical_spec.rb +53 -0
- data/spec/models/global_metrics_quotes_latest_spec.rb +77 -0
- data/spec/models/inline_response_200_1_spec.rb +9 -3
- data/spec/models/inline_response_200_2_spec.rb +3 -3
- data/spec/models/inline_response_200_3_spec.rb +9 -3
- data/spec/models/inline_response_200_4_data_spec.rb +41 -0
- data/spec/models/inline_response_200_4_spec.rb +3 -3
- data/spec/models/inline_response_200_5_spec.rb +3 -3
- data/spec/models/inline_response_200_6_spec.rb +47 -0
- data/spec/models/inline_response_200_7_spec.rb +47 -0
- data/spec/models/inline_response_200_8_spec.rb +47 -0
- data/spec/models/inline_response_200_9_spec.rb +47 -0
- data/spec/models/inline_response_200_spec.rb +3 -3
- data/spec/models/inline_response_default_1_spec.rb +3 -3
- data/spec/models/inline_response_default_spec.rb +3 -3
- data/spec/models/platform_spec.rb +3 -3
- data/spec/models/quote_spec.rb +3 -3
- data/spec/models/status_spec.rb +3 -3
- data/spec/spec_helper.rb +1 -1
- metadata +54 -34
- data/lib/coinmarketcap_api.rb +0 -50
- data/lib/coinmarketcap_api/api/default_api.rb +0 -145
- data/lib/coinmarketcap_api/api_client.rb +0 -389
- data/lib/coinmarketcap_api/api_error.rb +0 -38
- data/lib/coinmarketcap_api/configuration.rb +0 -209
- data/lib/coinmarketcap_api/models/info.rb +0 -276
- data/lib/coinmarketcap_api/models/info_urls.rb +0 -263
- data/lib/coinmarketcap_api/models/status.rb +0 -219
- data/lib/coinmarketcap_api/version.rb +0 -15
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 773f5328e3c19aa1d7d8fc0b50df2aab5b3a3d3b78ad09ce2969a9887fbdb69e
|
4
|
+
data.tar.gz: 7367f63465c72abb09ba50538c383f0fac22e2786cd9d366533c34061563313d
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 87a518fe90419ebd5fc0fc56eda55a779771e50407e0ef62fe032072307faa303bd48be5c095b3bac91f8a24249486cf9e6f94ca9207635c4bce46b715ccf88e
|
7
|
+
data.tar.gz: bc80c975c441c7845f109b71471239e5d80cf9754c202421baa2e99b8ecf0a2c6d404b401e6755c27007f8a3ca73d44f2b6d20705a5783fc56f76bd03ef20ecb
|
data/README.md
CHANGED
@@ -7,7 +7,7 @@ Define coinmarketcap's api in swagger 2.0 openapi standard
|
|
7
7
|
This SDK is automatically generated by the [Swagger Codegen](https://github.com/swagger-api/swagger-codegen) project:
|
8
8
|
|
9
9
|
- API version: 1.0.0
|
10
|
-
- Package version: 1.0.
|
10
|
+
- Package version: 1.0.2
|
11
11
|
- Build package: io.swagger.codegen.languages.RubyClientCodegen
|
12
12
|
|
13
13
|
## Installation
|
@@ -23,15 +23,15 @@ gem build coinmarketcap_client.gemspec
|
|
23
23
|
Then either install the gem locally:
|
24
24
|
|
25
25
|
```shell
|
26
|
-
gem install ./coinmarketcap_client-1.0.
|
26
|
+
gem install ./coinmarketcap_client-1.0.2.gem
|
27
27
|
```
|
28
|
-
(for development, run `gem install --dev ./coinmarketcap_client-1.0.
|
28
|
+
(for development, run `gem install --dev ./coinmarketcap_client-1.0.2.gem` to install the development dependencies)
|
29
29
|
|
30
30
|
or publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/).
|
31
31
|
|
32
32
|
Finally add this to the Gemfile:
|
33
33
|
|
34
|
-
gem 'coinmarketcap_client', '~> 1.0.
|
34
|
+
gem 'coinmarketcap_client', '~> 1.0.2'
|
35
35
|
|
36
36
|
### Install from Git
|
37
37
|
|
@@ -65,7 +65,7 @@ end
|
|
65
65
|
api_instance = CoinmarketcapClient::DefaultApi.new
|
66
66
|
|
67
67
|
opts = {
|
68
|
-
id: 'id_example', # String | One or more comma-separated CoinMarketCap cryptocurrency IDs. Example
|
68
|
+
id: 'id_example', # String | One or more comma-separated CoinMarketCap cryptocurrency IDs. Example \"1,2\"
|
69
69
|
symbol: 'symbol_example' # String | Alternatively pass one or more comma-separated cryptocurrency symbols. Example: \"BTC,ETH\". At least one \"id\" or \"symbol\" is required.
|
70
70
|
}
|
71
71
|
|
@@ -89,22 +89,33 @@ Class | Method | HTTP request | Description
|
|
89
89
|
*CoinmarketcapClient::DefaultApi* | [**cryptocurrency_listings_historical_get**](docs/DefaultApi.md#cryptocurrency_listings_historical_get) | **GET** /cryptocurrency/listings/historical | List all cryptocurrencies (historical)
|
90
90
|
*CoinmarketcapClient::DefaultApi* | [**cryptocurrency_listings_latest_get**](docs/DefaultApi.md#cryptocurrency_listings_latest_get) | **GET** /cryptocurrency/listings/latest | List all cryptocurrencies (latest)
|
91
91
|
*CoinmarketcapClient::DefaultApi* | [**cryptocurrency_map_get**](docs/DefaultApi.md#cryptocurrency_map_get) | **GET** /cryptocurrency/map | Get CoinMarketCap ID map
|
92
|
+
*CoinmarketcapClient::DefaultApi* | [**global_metrics_quotes_historical_get**](docs/DefaultApi.md#global_metrics_quotes_historical_get) | **GET** /global-metrics/quotes/historical | List all cryptocurrencies (latest)
|
93
|
+
*CoinmarketcapClient::DefaultApi* | [**global_metrics_quotes_latest_get**](docs/DefaultApi.md#global_metrics_quotes_latest_get) | **GET** /global-metrics/quotes/latest | Get aggregate market metrics (latest)
|
92
94
|
|
93
95
|
|
94
96
|
## Documentation for Models
|
95
97
|
|
96
|
-
- [CoinmarketcapClient::
|
97
|
-
- [CoinmarketcapClient::
|
98
|
+
- [CoinmarketcapClient::CryptocurrencyInfo](docs/CryptocurrencyInfo.md)
|
99
|
+
- [CoinmarketcapClient::CryptocurrencyInfoUrls](docs/CryptocurrencyInfoUrls.md)
|
100
|
+
- [CoinmarketcapClient::CryptocurrencyListings](docs/CryptocurrencyListings.md)
|
101
|
+
- [CoinmarketcapClient::CryptocurrencyMap](docs/CryptocurrencyMap.md)
|
102
|
+
- [CoinmarketcapClient::GlobalMetricsHistoricalQuote](docs/GlobalMetricsHistoricalQuote.md)
|
103
|
+
- [CoinmarketcapClient::GlobalMetricsQuote](docs/GlobalMetricsQuote.md)
|
104
|
+
- [CoinmarketcapClient::GlobalMetricsQuotesHistorical](docs/GlobalMetricsQuotesHistorical.md)
|
105
|
+
- [CoinmarketcapClient::GlobalMetricsQuotesLatest](docs/GlobalMetricsQuotesLatest.md)
|
98
106
|
- [CoinmarketcapClient::InlineResponse200](docs/InlineResponse200.md)
|
99
107
|
- [CoinmarketcapClient::InlineResponse2001](docs/InlineResponse2001.md)
|
100
108
|
- [CoinmarketcapClient::InlineResponse2002](docs/InlineResponse2002.md)
|
101
109
|
- [CoinmarketcapClient::InlineResponse2003](docs/InlineResponse2003.md)
|
102
110
|
- [CoinmarketcapClient::InlineResponse2004](docs/InlineResponse2004.md)
|
111
|
+
- [CoinmarketcapClient::InlineResponse2004Data](docs/InlineResponse2004Data.md)
|
103
112
|
- [CoinmarketcapClient::InlineResponse2005](docs/InlineResponse2005.md)
|
113
|
+
- [CoinmarketcapClient::InlineResponse2006](docs/InlineResponse2006.md)
|
114
|
+
- [CoinmarketcapClient::InlineResponse2007](docs/InlineResponse2007.md)
|
115
|
+
- [CoinmarketcapClient::InlineResponse2008](docs/InlineResponse2008.md)
|
116
|
+
- [CoinmarketcapClient::InlineResponse2009](docs/InlineResponse2009.md)
|
104
117
|
- [CoinmarketcapClient::InlineResponseDefault](docs/InlineResponseDefault.md)
|
105
118
|
- [CoinmarketcapClient::InlineResponseDefault1](docs/InlineResponseDefault1.md)
|
106
|
-
- [CoinmarketcapClient::Map](docs/Map.md)
|
107
|
-
- [CoinmarketcapClient::MarketData](docs/MarketData.md)
|
108
119
|
- [CoinmarketcapClient::Platform](docs/Platform.md)
|
109
120
|
- [CoinmarketcapClient::Quote](docs/Quote.md)
|
110
121
|
- [CoinmarketcapClient::Status](docs/Status.md)
|
@@ -1,4 +1,4 @@
|
|
1
|
-
# CoinmarketcapClient::
|
1
|
+
# CoinmarketcapClient::CryptocurrencyInfo
|
2
2
|
|
3
3
|
## Properties
|
4
4
|
Name | Type | Description | Notes
|
@@ -13,6 +13,6 @@ Name | Type | Description | Notes
|
|
13
13
|
**description** | **String** | | [optional]
|
14
14
|
**date_added** | **DateTime** | | [optional]
|
15
15
|
**platform** | [**Platform**](Platform.md) | | [optional]
|
16
|
-
**urls** | [**
|
16
|
+
**urls** | [**CryptocurrencyInfoUrls**](CryptocurrencyInfoUrls.md) | | [optional]
|
17
17
|
|
18
18
|
|
data/docs/DefaultApi.md
CHANGED
@@ -8,10 +8,12 @@ Method | HTTP request | Description
|
|
8
8
|
[**cryptocurrency_listings_historical_get**](DefaultApi.md#cryptocurrency_listings_historical_get) | **GET** /cryptocurrency/listings/historical | List all cryptocurrencies (historical)
|
9
9
|
[**cryptocurrency_listings_latest_get**](DefaultApi.md#cryptocurrency_listings_latest_get) | **GET** /cryptocurrency/listings/latest | List all cryptocurrencies (latest)
|
10
10
|
[**cryptocurrency_map_get**](DefaultApi.md#cryptocurrency_map_get) | **GET** /cryptocurrency/map | Get CoinMarketCap ID map
|
11
|
+
[**global_metrics_quotes_historical_get**](DefaultApi.md#global_metrics_quotes_historical_get) | **GET** /global-metrics/quotes/historical | List all cryptocurrencies (latest)
|
12
|
+
[**global_metrics_quotes_latest_get**](DefaultApi.md#global_metrics_quotes_latest_get) | **GET** /global-metrics/quotes/latest | Get aggregate market metrics (latest)
|
11
13
|
|
12
14
|
|
13
15
|
# **cryptocurrency_info_get**
|
14
|
-
>
|
16
|
+
> InlineResponse2006 cryptocurrency_info_get(opts)
|
15
17
|
|
16
18
|
Get metadata
|
17
19
|
|
@@ -32,7 +34,7 @@ end
|
|
32
34
|
api_instance = CoinmarketcapClient::DefaultApi.new
|
33
35
|
|
34
36
|
opts = {
|
35
|
-
id: 'id_example', # String | One or more comma-separated CoinMarketCap cryptocurrency IDs. Example
|
37
|
+
id: 'id_example', # String | One or more comma-separated CoinMarketCap cryptocurrency IDs. Example \"1,2\"
|
36
38
|
symbol: 'symbol_example' # String | Alternatively pass one or more comma-separated cryptocurrency symbols. Example: \"BTC,ETH\". At least one \"id\" or \"symbol\" is required.
|
37
39
|
}
|
38
40
|
|
@@ -49,12 +51,12 @@ end
|
|
49
51
|
|
50
52
|
Name | Type | Description | Notes
|
51
53
|
------------- | ------------- | ------------- | -------------
|
52
|
-
**id** | **String**| One or more comma-separated CoinMarketCap cryptocurrency IDs. Example
|
54
|
+
**id** | **String**| One or more comma-separated CoinMarketCap cryptocurrency IDs. Example \"1,2\" | [optional]
|
53
55
|
**symbol** | **String**| Alternatively pass one or more comma-separated cryptocurrency symbols. Example: \"BTC,ETH\". At least one \"id\" or \"symbol\" is required. | [optional]
|
54
56
|
|
55
57
|
### Return type
|
56
58
|
|
57
|
-
[**
|
59
|
+
[**InlineResponse2006**](InlineResponse2006.md)
|
58
60
|
|
59
61
|
### Authorization
|
60
62
|
|
@@ -68,7 +70,7 @@ Name | Type | Description | Notes
|
|
68
70
|
|
69
71
|
|
70
72
|
# **cryptocurrency_listings_historical_get**
|
71
|
-
>
|
73
|
+
> InlineResponse2007 cryptocurrency_listings_historical_get(opts)
|
72
74
|
|
73
75
|
List all cryptocurrencies (historical)
|
74
76
|
|
@@ -93,9 +95,9 @@ opts = {
|
|
93
95
|
start: 1, # Integer | Optionally offset the start (1-based index) of the paginated list of items to return.
|
94
96
|
limit: 100, # Integer | Optionally specify the number of results to return. Use this parameter and the \"start\" parameter to determine your own pagination size.
|
95
97
|
convert: 'USD', # String | Optionally calculate market quotes in up to 120 currencies at once by passing a comma-separated list of cryptocurrency or fiat currency symbols. Each additional convert option beyond the first requires an additional call credit. A list of supported fiat options can be found here. Each conversion is returned in its own \"quote\" object.
|
96
|
-
sort: 'market_cap', # String | Valid values
|
97
|
-
sort_dir: 'sort_dir_example', # String | Valid values
|
98
|
-
cryptocurrency_type: 'cryptocurrency_type_example' # String | Valid values
|
98
|
+
sort: 'market_cap', # String | Valid values `name` `symbol` `date_added` `market_cap` `price` `circulating_supply` `total_supply` `max_supply` `num_market_pairs` `volume_24h` `percent_change_1h` `percent_change_24h` `percent_change_7d` What field to sort the list of cryptocurrencies by.
|
99
|
+
sort_dir: 'sort_dir_example', # String | Valid values `asc` `desc`. The direction in which to order cryptocurrencies against the specified sort.
|
100
|
+
cryptocurrency_type: 'cryptocurrency_type_example' # String | Valid values `all` `coins` `tokens` The type of cryptocurrency to include.
|
99
101
|
}
|
100
102
|
|
101
103
|
begin
|
@@ -115,13 +117,13 @@ Name | Type | Description | Notes
|
|
115
117
|
**start** | **Integer**| Optionally offset the start (1-based index) of the paginated list of items to return. | [optional] [default to 1]
|
116
118
|
**limit** | **Integer**| Optionally specify the number of results to return. Use this parameter and the \"start\" parameter to determine your own pagination size. | [optional] [default to 100]
|
117
119
|
**convert** | **String**| Optionally calculate market quotes in up to 120 currencies at once by passing a comma-separated list of cryptocurrency or fiat currency symbols. Each additional convert option beyond the first requires an additional call credit. A list of supported fiat options can be found here. Each conversion is returned in its own \"quote\" object. | [optional] [default to USD]
|
118
|
-
**sort** | **String**| Valid values
|
119
|
-
**sort_dir** | **String**| Valid values
|
120
|
-
**cryptocurrency_type** | **String**| Valid values
|
120
|
+
**sort** | **String**| Valid values `name` `symbol` `date_added` `market_cap` `price` `circulating_supply` `total_supply` `max_supply` `num_market_pairs` `volume_24h` `percent_change_1h` `percent_change_24h` `percent_change_7d` What field to sort the list of cryptocurrencies by. | [optional] [default to market_cap]
|
121
|
+
**sort_dir** | **String**| Valid values `asc` `desc`. The direction in which to order cryptocurrencies against the specified sort. | [optional]
|
122
|
+
**cryptocurrency_type** | **String**| Valid values `all` `coins` `tokens` The type of cryptocurrency to include. | [optional]
|
121
123
|
|
122
124
|
### Return type
|
123
125
|
|
124
|
-
[**
|
126
|
+
[**InlineResponse2007**](InlineResponse2007.md)
|
125
127
|
|
126
128
|
### Authorization
|
127
129
|
|
@@ -135,7 +137,7 @@ Name | Type | Description | Notes
|
|
135
137
|
|
136
138
|
|
137
139
|
# **cryptocurrency_listings_latest_get**
|
138
|
-
>
|
140
|
+
> InlineResponse2007 cryptocurrency_listings_latest_get(opts)
|
139
141
|
|
140
142
|
List all cryptocurrencies (latest)
|
141
143
|
|
@@ -159,9 +161,9 @@ opts = {
|
|
159
161
|
start: 1, # Integer | Optionally offset the start (1-based index) of the paginated list of items to return.
|
160
162
|
limit: 100, # Integer | Optionally specify the number of results to return. Use this parameter and the \"start\" parameter to determine your own pagination size.
|
161
163
|
convert: 'USD', # String | Optionally calculate market quotes in up to 120 currencies at once by passing a comma-separated list of cryptocurrency or fiat currency symbols. Each additional convert option beyond the first requires an additional call credit. A list of supported fiat options can be found here. Each conversion is returned in its own \"quote\" object.
|
162
|
-
sort: 'market_cap', # String | Valid values
|
163
|
-
sort_dir: 'sort_dir_example', # String | Valid values
|
164
|
-
cryptocurrency_type: 'cryptocurrency_type_example' # String | Valid values
|
164
|
+
sort: 'market_cap', # String | Valid values `name` `symbol` `date_added` `market_cap` `price` `circulating_supply` `total_supply` `max_supply` `num_market_pairs` `volume_24h` `percent_change_1h` `percent_change_24h` `percent_change_7d` What field to sort the list of cryptocurrencies by.
|
165
|
+
sort_dir: 'sort_dir_example', # String | Valid values `asc` `desc`. The direction in which to order cryptocurrencies against the specified sort.
|
166
|
+
cryptocurrency_type: 'cryptocurrency_type_example' # String | Valid values `all` `coins` `tokens` The type of cryptocurrency to include.
|
165
167
|
}
|
166
168
|
|
167
169
|
begin
|
@@ -180,13 +182,13 @@ Name | Type | Description | Notes
|
|
180
182
|
**start** | **Integer**| Optionally offset the start (1-based index) of the paginated list of items to return. | [optional] [default to 1]
|
181
183
|
**limit** | **Integer**| Optionally specify the number of results to return. Use this parameter and the \"start\" parameter to determine your own pagination size. | [optional] [default to 100]
|
182
184
|
**convert** | **String**| Optionally calculate market quotes in up to 120 currencies at once by passing a comma-separated list of cryptocurrency or fiat currency symbols. Each additional convert option beyond the first requires an additional call credit. A list of supported fiat options can be found here. Each conversion is returned in its own \"quote\" object. | [optional] [default to USD]
|
183
|
-
**sort** | **String**| Valid values
|
184
|
-
**sort_dir** | **String**| Valid values
|
185
|
-
**cryptocurrency_type** | **String**| Valid values
|
185
|
+
**sort** | **String**| Valid values `name` `symbol` `date_added` `market_cap` `price` `circulating_supply` `total_supply` `max_supply` `num_market_pairs` `volume_24h` `percent_change_1h` `percent_change_24h` `percent_change_7d` What field to sort the list of cryptocurrencies by. | [optional] [default to market_cap]
|
186
|
+
**sort_dir** | **String**| Valid values `asc` `desc`. The direction in which to order cryptocurrencies against the specified sort. | [optional]
|
187
|
+
**cryptocurrency_type** | **String**| Valid values `all` `coins` `tokens` The type of cryptocurrency to include. | [optional]
|
186
188
|
|
187
189
|
### Return type
|
188
190
|
|
189
|
-
[**
|
191
|
+
[**InlineResponse2007**](InlineResponse2007.md)
|
190
192
|
|
191
193
|
### Authorization
|
192
194
|
|
@@ -200,7 +202,7 @@ Name | Type | Description | Notes
|
|
200
202
|
|
201
203
|
|
202
204
|
# **cryptocurrency_map_get**
|
203
|
-
>
|
205
|
+
> InlineResponse2005 cryptocurrency_map_get(opts)
|
204
206
|
|
205
207
|
Get CoinMarketCap ID map
|
206
208
|
|
@@ -247,7 +249,129 @@ Name | Type | Description | Notes
|
|
247
249
|
|
248
250
|
### Return type
|
249
251
|
|
250
|
-
[**
|
252
|
+
[**InlineResponse2005**](InlineResponse2005.md)
|
253
|
+
|
254
|
+
### Authorization
|
255
|
+
|
256
|
+
[ApiKeyAuth](../README.md#ApiKeyAuth)
|
257
|
+
|
258
|
+
### HTTP request headers
|
259
|
+
|
260
|
+
- **Content-Type**: Not defined
|
261
|
+
- **Accept**: application/json
|
262
|
+
|
263
|
+
|
264
|
+
|
265
|
+
# **global_metrics_quotes_historical_get**
|
266
|
+
> InlineResponse2009 global_metrics_quotes_historical_get(opts)
|
267
|
+
|
268
|
+
List all cryptocurrencies (latest)
|
269
|
+
|
270
|
+
Get a paginated list of all cryptocurrencies with latest market data. You can configure this call to sort by market cap or another market ranking field. Use the \"convert\" option to return market values in multiple fiat and cryptocurrency conversions in the same call.
|
271
|
+
|
272
|
+
### Example
|
273
|
+
```ruby
|
274
|
+
# load the gem
|
275
|
+
require 'coinmarketcap_client'
|
276
|
+
# setup authorization
|
277
|
+
CoinmarketcapClient.configure do |config|
|
278
|
+
# Configure API key authorization: ApiKeyAuth
|
279
|
+
config.api_key['X-CMC_PRO_API_KEY'] = 'YOUR API KEY'
|
280
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
281
|
+
#config.api_key_prefix['X-CMC_PRO_API_KEY'] = 'Bearer'
|
282
|
+
end
|
283
|
+
|
284
|
+
api_instance = CoinmarketcapClient::DefaultApi.new
|
285
|
+
|
286
|
+
opts = {
|
287
|
+
time_start: 'time_start_example', # String | Timestamp (Unix or ISO 8601) to start returning quotes for. Optional, if not passed, we'll return quotes calculated in reverse from \"time_end\".
|
288
|
+
time_end: 'time_end_example', # String | Timestamp (Unix or ISO 8601) to stop returning quotes for (inclusive). Optional, if not passed, we'll default to the current time. If no \"time_start\" is passed, we return quotes in reverse order starting from this time.
|
289
|
+
count: 10, # Integer | The number of interval periods to return results for. Optional, required if both \"time_start\" and \"time_end\" aren't supplied. The default is 10 items. The current query limit is 10000.
|
290
|
+
interval: '1d', # String | Valid values \"yearly\" \"monthly\" \"weekly\" \"daily\" \"hourly\" \"5m\" \"10m\" \"15m\" \"30m\" \"45m\" \"1h\" \"2h\" \"3h\" \"6h\" \"12h\" \"24h\" \"1d\" \"2d\" \"3d\" \"7d\" \"14d\" \"15d\" \"30d\" \"60d\" \"90d\" \"365d\" Interval of time to return data points for. See details in endpoint description.
|
291
|
+
convert_id: 'convert_id_example', # String | One or more comma-separated cryptocurrency CoinMarketCap IDs. Example 1,2
|
292
|
+
convert: 'convert_example' # String | By default market quotes are returned in USD. Optionally calculate market quotes in up to 3 other fiat currencies or cryptocurrencies.
|
293
|
+
}
|
294
|
+
|
295
|
+
begin
|
296
|
+
#List all cryptocurrencies (latest)
|
297
|
+
result = api_instance.global_metrics_quotes_historical_get(opts)
|
298
|
+
p result
|
299
|
+
rescue CoinmarketcapClient::ApiError => e
|
300
|
+
puts "Exception when calling DefaultApi->global_metrics_quotes_historical_get: #{e}"
|
301
|
+
end
|
302
|
+
```
|
303
|
+
|
304
|
+
### Parameters
|
305
|
+
|
306
|
+
Name | Type | Description | Notes
|
307
|
+
------------- | ------------- | ------------- | -------------
|
308
|
+
**time_start** | **String**| Timestamp (Unix or ISO 8601) to start returning quotes for. Optional, if not passed, we'll return quotes calculated in reverse from \"time_end\". | [optional]
|
309
|
+
**time_end** | **String**| Timestamp (Unix or ISO 8601) to stop returning quotes for (inclusive). Optional, if not passed, we'll default to the current time. If no \"time_start\" is passed, we return quotes in reverse order starting from this time. | [optional]
|
310
|
+
**count** | **Integer**| The number of interval periods to return results for. Optional, required if both \"time_start\" and \"time_end\" aren't supplied. The default is 10 items. The current query limit is 10000. | [optional] [default to 10]
|
311
|
+
**interval** | **String**| Valid values \"yearly\" \"monthly\" \"weekly\" \"daily\" \"hourly\" \"5m\" \"10m\" \"15m\" \"30m\" \"45m\" \"1h\" \"2h\" \"3h\" \"6h\" \"12h\" \"24h\" \"1d\" \"2d\" \"3d\" \"7d\" \"14d\" \"15d\" \"30d\" \"60d\" \"90d\" \"365d\" Interval of time to return data points for. See details in endpoint description. | [optional] [default to 1d]
|
312
|
+
**convert_id** | **String**| One or more comma-separated cryptocurrency CoinMarketCap IDs. Example 1,2 | [optional]
|
313
|
+
**convert** | **String**| By default market quotes are returned in USD. Optionally calculate market quotes in up to 3 other fiat currencies or cryptocurrencies. | [optional]
|
314
|
+
|
315
|
+
### Return type
|
316
|
+
|
317
|
+
[**InlineResponse2009**](InlineResponse2009.md)
|
318
|
+
|
319
|
+
### Authorization
|
320
|
+
|
321
|
+
[ApiKeyAuth](../README.md#ApiKeyAuth)
|
322
|
+
|
323
|
+
### HTTP request headers
|
324
|
+
|
325
|
+
- **Content-Type**: Not defined
|
326
|
+
- **Accept**: application/json
|
327
|
+
|
328
|
+
|
329
|
+
|
330
|
+
# **global_metrics_quotes_latest_get**
|
331
|
+
> InlineResponse2008 global_metrics_quotes_latest_get(opts)
|
332
|
+
|
333
|
+
Get aggregate market metrics (latest)
|
334
|
+
|
335
|
+
Get the latest quote of aggregate market metrics. Use the \"convert\" option to return market values in multiple fiat and cryptocurrency conversions in the same call.
|
336
|
+
|
337
|
+
### Example
|
338
|
+
```ruby
|
339
|
+
# load the gem
|
340
|
+
require 'coinmarketcap_client'
|
341
|
+
# setup authorization
|
342
|
+
CoinmarketcapClient.configure do |config|
|
343
|
+
# Configure API key authorization: ApiKeyAuth
|
344
|
+
config.api_key['X-CMC_PRO_API_KEY'] = 'YOUR API KEY'
|
345
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
346
|
+
#config.api_key_prefix['X-CMC_PRO_API_KEY'] = 'Bearer'
|
347
|
+
end
|
348
|
+
|
349
|
+
api_instance = CoinmarketcapClient::DefaultApi.new
|
350
|
+
|
351
|
+
opts = {
|
352
|
+
convert_id: 'convert_id_example', # String | One or more comma-separated cryptocurrency CoinMarketCap IDs. Example 1,2
|
353
|
+
convert: 'convert_example' # String | Optionally calculate market quotes in up to 120 currencies at once by passing a comma-separated list of cryptocurrency or fiat currency symbols. Each additional convert option beyond the first requires an additional call credit. A list of supported fiat options can be found here. Each conversion is returned in its own \"quote\" object.
|
354
|
+
}
|
355
|
+
|
356
|
+
begin
|
357
|
+
#Get aggregate market metrics (latest)
|
358
|
+
result = api_instance.global_metrics_quotes_latest_get(opts)
|
359
|
+
p result
|
360
|
+
rescue CoinmarketcapClient::ApiError => e
|
361
|
+
puts "Exception when calling DefaultApi->global_metrics_quotes_latest_get: #{e}"
|
362
|
+
end
|
363
|
+
```
|
364
|
+
|
365
|
+
### Parameters
|
366
|
+
|
367
|
+
Name | Type | Description | Notes
|
368
|
+
------------- | ------------- | ------------- | -------------
|
369
|
+
**convert_id** | **String**| One or more comma-separated cryptocurrency CoinMarketCap IDs. Example 1,2 | [optional]
|
370
|
+
**convert** | **String**| Optionally calculate market quotes in up to 120 currencies at once by passing a comma-separated list of cryptocurrency or fiat currency symbols. Each additional convert option beyond the first requires an additional call credit. A list of supported fiat options can be found here. Each conversion is returned in its own \"quote\" object. | [optional]
|
371
|
+
|
372
|
+
### Return type
|
373
|
+
|
374
|
+
[**InlineResponse2008**](InlineResponse2008.md)
|
251
375
|
|
252
376
|
### Authorization
|
253
377
|
|
@@ -0,0 +1,10 @@
|
|
1
|
+
# CoinmarketcapClient::GlobalMetricsHistoricalQuote
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**total_market_cap** | **Float** | | [optional]
|
7
|
+
**total_volume_24h** | **Float** | | [optional]
|
8
|
+
**timestamp** | **DateTime** | | [optional]
|
9
|
+
|
10
|
+
|
@@ -0,0 +1,10 @@
|
|
1
|
+
# CoinmarketcapClient::GlobalMetricsQuote
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**total_market_cap** | **Float** | | [optional]
|
7
|
+
**total_volume_24h** | **Float** | | [optional]
|
8
|
+
**last_updated** | **DateTime** | | [optional]
|
9
|
+
|
10
|
+
|
@@ -0,0 +1,10 @@
|
|
1
|
+
# CoinmarketcapClient::GlobalMetricsQuotesHistorical
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**timestamp** | **DateTime** | | [optional]
|
7
|
+
**btc_dominance** | **Float** | | [optional]
|
8
|
+
**quote** | [**Hash<String, GlobalMetricsHistoricalQuote>**](GlobalMetricsHistoricalQuote.md) | | [optional]
|
9
|
+
|
10
|
+
|
@@ -0,0 +1,14 @@
|
|
1
|
+
# CoinmarketcapClient::GlobalMetricsQuotesLatest
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**btc_dominance** | **Float** | | [optional]
|
7
|
+
**eth_dominance** | **Float** | | [optional]
|
8
|
+
**active_cryptocurrencies** | **Integer** | | [optional]
|
9
|
+
**active_market_pairs** | **Integer** | | [optional]
|
10
|
+
**active_exchanges** | **Integer** | | [optional]
|
11
|
+
**last_updated** | **DateTime** | | [optional]
|
12
|
+
**quote** | [**Hash<String, GlobalMetricsQuote>**](GlobalMetricsQuote.md) | | [optional]
|
13
|
+
|
14
|
+
|
data/docs/InlineResponse200.md
CHANGED
@@ -3,7 +3,7 @@
|
|
3
3
|
## Properties
|
4
4
|
Name | Type | Description | Notes
|
5
5
|
------------ | ------------- | ------------- | -------------
|
6
|
-
**data** | [**Array<
|
6
|
+
**data** | [**Array<CryptocurrencyMap>**](CryptocurrencyMap.md) | | [optional]
|
7
7
|
**status** | [**Status**](Status.md) | | [optional]
|
8
8
|
|
9
9
|
|
data/docs/InlineResponse2001.md
CHANGED
@@ -3,7 +3,7 @@
|
|
3
3
|
## Properties
|
4
4
|
Name | Type | Description | Notes
|
5
5
|
------------ | ------------- | ------------- | -------------
|
6
|
-
**data** | [**Hash<String,
|
6
|
+
**data** | [**Hash<String, CryptocurrencyInfo>**](CryptocurrencyInfo.md) | | [optional]
|
7
7
|
**status** | [**Status**](Status.md) | | [optional]
|
8
8
|
|
9
9
|
|
data/docs/InlineResponse2002.md
CHANGED
@@ -3,7 +3,7 @@
|
|
3
3
|
## Properties
|
4
4
|
Name | Type | Description | Notes
|
5
5
|
------------ | ------------- | ------------- | -------------
|
6
|
-
**data** | [**Array<
|
6
|
+
**data** | [**Array<CryptocurrencyListings>**](CryptocurrencyListings.md) | | [optional]
|
7
7
|
**status** | [**Status**](Status.md) | | [optional]
|
8
8
|
|
9
9
|
|