coinmarketcap_client 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 3bc475d564706f5b2d40af56bc8f12c1c281c5bc568caae86a24d57dabc23e88
+  data.tar.gz: d2926f697fcc9accdc5d7fdcbaabd487c7068a5a3883b09a5b954b31c7a5a847
+SHA512:
+  metadata.gz: 22fe4ce596e9cc4e393c63a0cf27275fa7c04c578363b0d64579eb21e7b9bb70469f29618255bf73e0b9a28962532e0e2438d50dd4c06125d2f09afb7f7c23b7
+  data.tar.gz: 37ba6798f62c234ed249f5d8560be2c59df321de9a4bc3a6c209c95daebcfe8fd9123db150db62118fd4fe02c37dca02f89c13416763f81750608f840c626549

data/Gemfile

@@ -0,0 +1,7 @@
+source 'https://rubygems.org'
+
+gemspec
+
+group :development, :test do
+  gem 'rake', '~> 12.0.0'
+end

data/README.md

@@ -0,0 +1,121 @@
+# coinmarketcap_client
+
+CoinmarketcapAPI - the Ruby gem for the Coinmarketcap API Swagger Implementation
+
+Define coinmarketcap's api in swagger 2.0 openapi standard
+
+This SDK is automatically generated by the [Swagger Codegen](https://github.com/swagger-api/swagger-codegen) project:
+
+- API version: 1.0.0
+- Package version: 1.0.0
+- Build package: io.swagger.codegen.languages.RubyClientCodegen
+
+## Installation
+
+### Build a gem
+
+To build the Ruby code into a gem:
+
+```shell
+gem build coinmarketcap_client.gemspec
+```
+
+Then either install the gem locally:
+
+```shell
+gem install ./coinmarketcap_client-1.0.0.gem
+```
+(for development, run `gem install --dev ./coinmarketcap_client-1.0.0.gem` to install the development dependencies)
+
+or publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/).
+
+Finally add this to the Gemfile:
+
+    gem 'coinmarketcap_client', '~> 1.0.0'
+
+### Install from Git
+
+If the Ruby gem is hosted at a git repository: https://github.com/GIT_USER_ID/GIT_REPO_ID, then add the following in the Gemfile:
+
+    gem 'coinmarketcap_client', :git => 'https://github.com/GIT_USER_ID/GIT_REPO_ID.git'
+
+### Include the Ruby code directly
+
+Include the Ruby code directly using `-I` as follows:
+
+```shell
+ruby -Ilib script.rb
+```
+
+## Getting Started
+
+Please follow the [installation](#installation) procedure and then run the following code:
+```ruby
+# Load the gem
+require 'coinmarketcap_client'
+
+# Setup authorization
+CoinmarketcapAPI.configure do |config|
+  # Configure API key authorization: ApiKeyAuth
+  config.api_key['X-CMC_PRO_API_KEY'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  #config.api_key_prefix['X-CMC_PRO_API_KEY'] = 'Bearer'
+end
+
+api_instance = CoinmarketcapAPI::DefaultApi.new
+
+opts = { 
+  id: 'id_example', # String | One or more comma-separated CoinMarketCap cryptocurrency IDs. Example: \"1,2\"
+  symbol: 'symbol_example' # String | Alternatively pass one or more comma-separated cryptocurrency symbols. Example: \"BTC,ETH\". At least one \"id\" or \"symbol\" is required.
+}
+
+begin
+  #Get metadata
+  result = api_instance.cryptocurrency_info_get(opts)
+  p result
+rescue CoinmarketcapAPI::ApiError => e
+  puts "Exception when calling DefaultApi->cryptocurrency_info_get: #{e}"
+end
+
+```
+
+## Documentation for API Endpoints
+
+All URIs are relative to *https://pro-api.coinmarketcap.com/v1*
+
+Class | Method | HTTP request | Description
+------------ | ------------- | ------------- | -------------
+*CoinmarketcapAPI::DefaultApi* | [**cryptocurrency_info_get**](docs/DefaultApi.md#cryptocurrency_info_get) | **GET** /cryptocurrency/info | Get metadata
+*CoinmarketcapAPI::DefaultApi* | [**cryptocurrency_listings_historical_get**](docs/DefaultApi.md#cryptocurrency_listings_historical_get) | **GET** /cryptocurrency/listings/historical | List all cryptocurrencies (historical)
+*CoinmarketcapAPI::DefaultApi* | [**cryptocurrency_listings_latest_get**](docs/DefaultApi.md#cryptocurrency_listings_latest_get) | **GET** /cryptocurrency/listings/latest | List all cryptocurrencies (latest)
+*CoinmarketcapAPI::DefaultApi* | [**cryptocurrency_map_get**](docs/DefaultApi.md#cryptocurrency_map_get) | **GET** /cryptocurrency/map | Get CoinMarketCap ID map
+
+
+## Documentation for Models
+
+ - [CoinmarketcapAPI::Info](docs/Info.md)
+ - [CoinmarketcapAPI::InfoUrls](docs/InfoUrls.md)
+ - [CoinmarketcapAPI::InlineResponse200](docs/InlineResponse200.md)
+ - [CoinmarketcapAPI::InlineResponse2001](docs/InlineResponse2001.md)
+ - [CoinmarketcapAPI::InlineResponse2002](docs/InlineResponse2002.md)
+ - [CoinmarketcapAPI::InlineResponse2003](docs/InlineResponse2003.md)
+ - [CoinmarketcapAPI::InlineResponse2004](docs/InlineResponse2004.md)
+ - [CoinmarketcapAPI::InlineResponse2005](docs/InlineResponse2005.md)
+ - [CoinmarketcapAPI::InlineResponseDefault](docs/InlineResponseDefault.md)
+ - [CoinmarketcapAPI::InlineResponseDefault1](docs/InlineResponseDefault1.md)
+ - [CoinmarketcapAPI::Map](docs/Map.md)
+ - [CoinmarketcapAPI::MarketData](docs/MarketData.md)
+ - [CoinmarketcapAPI::Platform](docs/Platform.md)
+ - [CoinmarketcapAPI::Quote](docs/Quote.md)
+ - [CoinmarketcapAPI::Status](docs/Status.md)
+
+
+## Documentation for Authorization
+
+
+### ApiKeyAuth
+
+- **Type**: API key
+- **API key parameter name**: X-CMC_PRO_API_KEY
+- **Location**: HTTP header
+

data/Rakefile

@@ -0,0 +1,8 @@
+begin
+  require 'rspec/core/rake_task'
+
+  RSpec::Core::RakeTask.new(:spec)
+  task default: :spec
+rescue LoadError
+  # no rspec available
+end

data/coinmarketcap_api.gemspec

@@ -0,0 +1,45 @@
+# -*- encoding: utf-8 -*-
+
+=begin
+#Coinmarketcap API Swagger Implementation
+
+#Define coinmarketcap's api in swagger 2.0 openapi standard
+
+OpenAPI spec version: 1.0.0
+
+Generated by: https://github.com/swagger-api/swagger-codegen.git
+Swagger Codegen version: 2.4.4
+
+=end
+
+$:.push File.expand_path("../lib", __FILE__)
+require "coinmarketcap_api/version"
+
+Gem::Specification.new do |s|
+  s.name        = "coinmarketcap_api"
+  s.version     = CoinmarketcapAPI::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Joshua Wilkosz"]
+  s.email       = ["joshua@wilkosz.com.au"]
+  s.homepage    = "https://github.com/wilkosz/coinmarketcap_api_sdks"
+  s.summary     = "Swagger 2.0 Implementation of Coinmarketcaps API"
+  s.description = "Swagger 2.0 Implementation of Coinmarketcaps API"
+  s.license     = "Unlicense"
+  s.required_ruby_version = ">= 1.9"
+
+  s.add_runtime_dependency 'typhoeus', '~> 1.0', '>= 1.0.1'
+  s.add_runtime_dependency 'json', '~> 2.1', '>= 2.1.0'
+
+  s.add_development_dependency 'rspec', '~> 3.6', '>= 3.6.0'
+  s.add_development_dependency 'vcr', '~> 3.0', '>= 3.0.1'
+  s.add_development_dependency 'webmock', '~> 1.24', '>= 1.24.3'
+  s.add_development_dependency 'autotest', '~> 4.4', '>= 4.4.6'
+  s.add_development_dependency 'autotest-rails-pure', '~> 4.1', '>= 4.1.2'
+  s.add_development_dependency 'autotest-growl', '~> 0.2', '>= 0.2.16'
+  s.add_development_dependency 'autotest-fsevent', '~> 0.2', '>= 0.2.12'
+
+  s.files         = `find *`.split("\n").uniq.sort.select { |f| !f.empty? }
+  s.test_files    = `find spec/*`.split("\n")
+  s.executables   = []
+  s.require_paths = ["lib"]
+end

data/coinmarketcap_client.gemspec

@@ -0,0 +1,45 @@
+# -*- encoding: utf-8 -*-
+
+=begin
+#Coinmarketcap API Swagger Implementation
+
+#Define coinmarketcap's api in swagger 2.0 openapi standard
+
+OpenAPI spec version: 1.0.0
+
+Generated by: https://github.com/swagger-api/swagger-codegen.git
+Swagger Codegen version: 2.4.4
+
+=end
+
+$:.push File.expand_path("../lib", __FILE__)
+require "coinmarketcap_client/version"
+
+Gem::Specification.new do |s|
+  s.name        = "coinmarketcap_client"
+  s.version     = CoinmarketcapAPI::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Joshua Wilkosz"]
+  s.email       = ["joshua@wilkosz.com.au"]
+  s.homepage    = "https://github.com/wilkosz/coinmarketcap_api_sdks"
+  s.summary     = "Swagger 2.0 Implementation of Coinmarketcaps API"
+  s.description = "Swagger 2.0 Implementation of Coinmarketcaps API"
+  s.license     = "Unlicense"
+  s.required_ruby_version = ">= 1.9"
+
+  s.add_runtime_dependency 'typhoeus', '~> 1.0', '>= 1.0.1'
+  s.add_runtime_dependency 'json', '~> 2.1', '>= 2.1.0'
+
+  s.add_development_dependency 'rspec', '~> 3.6', '>= 3.6.0'
+  s.add_development_dependency 'vcr', '~> 3.0', '>= 3.0.1'
+  s.add_development_dependency 'webmock', '~> 1.24', '>= 1.24.3'
+  s.add_development_dependency 'autotest', '~> 4.4', '>= 4.4.6'
+  s.add_development_dependency 'autotest-rails-pure', '~> 4.1', '>= 4.1.2'
+  s.add_development_dependency 'autotest-growl', '~> 0.2', '>= 0.2.16'
+  s.add_development_dependency 'autotest-fsevent', '~> 0.2', '>= 0.2.12'
+
+  s.files         = `find *`.split("\n").uniq.sort.select { |f| !f.empty? }
+  s.test_files    = `find spec/*`.split("\n")
+  s.executables   = []
+  s.require_paths = ["lib"]
+end

data/docs/DefaultApi.md

@@ -0,0 +1,262 @@
+# CoinmarketcapAPI::DefaultApi
+
+All URIs are relative to *https://pro-api.coinmarketcap.com/v1*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**cryptocurrency_info_get**](DefaultApi.md#cryptocurrency_info_get) | **GET** /cryptocurrency/info | Get metadata
+[**cryptocurrency_listings_historical_get**](DefaultApi.md#cryptocurrency_listings_historical_get) | **GET** /cryptocurrency/listings/historical | List all cryptocurrencies (historical)
+[**cryptocurrency_listings_latest_get**](DefaultApi.md#cryptocurrency_listings_latest_get) | **GET** /cryptocurrency/listings/latest | List all cryptocurrencies (latest)
+[**cryptocurrency_map_get**](DefaultApi.md#cryptocurrency_map_get) | **GET** /cryptocurrency/map | Get CoinMarketCap ID map
+
+
+# **cryptocurrency_info_get**
+> InlineResponse2004 cryptocurrency_info_get(opts)
+
+Get metadata
+
+Returns all static metadata for one or more cryptocurrencies including name, symbol, logo, and its various registered URLs.
+
+### Example
+```ruby
+# load the gem
+require 'coinmarketcap_client'
+# setup authorization
+CoinmarketcapAPI.configure do |config|
+  # Configure API key authorization: ApiKeyAuth
+  config.api_key['X-CMC_PRO_API_KEY'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  #config.api_key_prefix['X-CMC_PRO_API_KEY'] = 'Bearer'
+end
+
+api_instance = CoinmarketcapAPI::DefaultApi.new
+
+opts = { 
+  id: 'id_example', # String | One or more comma-separated CoinMarketCap cryptocurrency IDs. Example: \"1,2\"
+  symbol: 'symbol_example' # String | Alternatively pass one or more comma-separated cryptocurrency symbols. Example: \"BTC,ETH\". At least one \"id\" or \"symbol\" is required.
+}
+
+begin
+  #Get metadata
+  result = api_instance.cryptocurrency_info_get(opts)
+  p result
+rescue CoinmarketcapAPI::ApiError => e
+  puts "Exception when calling DefaultApi->cryptocurrency_info_get: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **id** | **String**| One or more comma-separated CoinMarketCap cryptocurrency IDs. Example: \"1,2\" | [optional] 
+ **symbol** | **String**| Alternatively pass one or more comma-separated cryptocurrency symbols. Example: \"BTC,ETH\". At least one \"id\" or \"symbol\" is required. | [optional] 
+
+### Return type
+
+[**InlineResponse2004**](InlineResponse2004.md)
+
+### Authorization
+
+[ApiKeyAuth](../README.md#ApiKeyAuth)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+
+# **cryptocurrency_listings_historical_get**
+> InlineResponse2005 cryptocurrency_listings_historical_get(opts)
+
+List all cryptocurrencies (historical)
+
+Get a paginated list of all cryptocurrencies with market data for a given historical time. Use the \"convert\" option to return market values in multiple fiat and cryptocurrency conversions in the same call.
+
+### Example
+```ruby
+# load the gem
+require 'coinmarketcap_client'
+# setup authorization
+CoinmarketcapAPI.configure do |config|
+  # Configure API key authorization: ApiKeyAuth
+  config.api_key['X-CMC_PRO_API_KEY'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  #config.api_key_prefix['X-CMC_PRO_API_KEY'] = 'Bearer'
+end
+
+api_instance = CoinmarketcapAPI::DefaultApi.new
+
+opts = { 
+  timestamp: 'timestamp_example', # String | Timestamp (Unix or ISO 8601) to return historical cryptocurrency listings for.
+  start: 1, # Integer | Optionally offset the start (1-based index) of the paginated list of items to return.
+  limit: 100, # Integer | Optionally specify the number of results to return. Use this parameter and the \"start\" parameter to determine your own pagination size.
+  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.
+  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.
+  sort_dir: 'sort_dir_example', # String | Valid values: `asc` `desc`. The direction in which to order cryptocurrencies against the specified sort.
+  cryptocurrency_type: 'cryptocurrency_type_example' # String | Valid values: `all` `coins` `tokens` The type of cryptocurrency to include.
+}
+
+begin
+  #List all cryptocurrencies (historical)
+  result = api_instance.cryptocurrency_listings_historical_get(opts)
+  p result
+rescue CoinmarketcapAPI::ApiError => e
+  puts "Exception when calling DefaultApi->cryptocurrency_listings_historical_get: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **timestamp** | **String**| Timestamp (Unix or ISO 8601) to return historical cryptocurrency listings for. | [optional] 
+ **start** | **Integer**| Optionally offset the start (1-based index) of the paginated list of items to return. | [optional] [default to 1]
+ **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]
+ **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]
+ **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]
+ **sort_dir** | **String**| Valid values: `asc` `desc`. The direction in which to order cryptocurrencies against the specified sort. | [optional] 
+ **cryptocurrency_type** | **String**| Valid values: `all` `coins` `tokens` The type of cryptocurrency to include. | [optional] 
+
+### Return type
+
+[**InlineResponse2005**](InlineResponse2005.md)
+
+### Authorization
+
+[ApiKeyAuth](../README.md#ApiKeyAuth)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+
+# **cryptocurrency_listings_latest_get**
+> InlineResponse2005 cryptocurrency_listings_latest_get(opts)
+
+List all cryptocurrencies (latest)
+
+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.
+
+### Example
+```ruby
+# load the gem
+require 'coinmarketcap_client'
+# setup authorization
+CoinmarketcapAPI.configure do |config|
+  # Configure API key authorization: ApiKeyAuth
+  config.api_key['X-CMC_PRO_API_KEY'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  #config.api_key_prefix['X-CMC_PRO_API_KEY'] = 'Bearer'
+end
+
+api_instance = CoinmarketcapAPI::DefaultApi.new
+
+opts = { 
+  start: 1, # Integer | Optionally offset the start (1-based index) of the paginated list of items to return.
+  limit: 100, # Integer | Optionally specify the number of results to return. Use this parameter and the \"start\" parameter to determine your own pagination size.
+  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.
+  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.
+  sort_dir: 'sort_dir_example', # String | Valid values: `asc` `desc`. The direction in which to order cryptocurrencies against the specified sort.
+  cryptocurrency_type: 'cryptocurrency_type_example' # String | Valid values: `all` `coins` `tokens` The type of cryptocurrency to include.
+}
+
+begin
+  #List all cryptocurrencies (latest)
+  result = api_instance.cryptocurrency_listings_latest_get(opts)
+  p result
+rescue CoinmarketcapAPI::ApiError => e
+  puts "Exception when calling DefaultApi->cryptocurrency_listings_latest_get: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **start** | **Integer**| Optionally offset the start (1-based index) of the paginated list of items to return. | [optional] [default to 1]
+ **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]
+ **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]
+ **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]
+ **sort_dir** | **String**| Valid values: `asc` `desc`. The direction in which to order cryptocurrencies against the specified sort. | [optional] 
+ **cryptocurrency_type** | **String**| Valid values: `all` `coins` `tokens` The type of cryptocurrency to include. | [optional] 
+
+### Return type
+
+[**InlineResponse2005**](InlineResponse2005.md)
+
+### Authorization
+
+[ApiKeyAuth](../README.md#ApiKeyAuth)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+
+# **cryptocurrency_map_get**
+> InlineResponse2003 cryptocurrency_map_get(opts)
+
+Get CoinMarketCap ID map
+
+Returns a paginated list of all cryptocurrencies by CoinMarketCap ID. We recommend using this convenience endpoint to lookup and utilize our unique cryptocurrency id across all endpoints as typical identifiers like ticker symbols can match multiple cryptocurrencies and change over time. As a convenience you may pass a comma-separated list of cryptocurrency symbols as symbol to filter this list to only those you require.
+
+### Example
+```ruby
+# load the gem
+require 'coinmarketcap_client'
+# setup authorization
+CoinmarketcapAPI.configure do |config|
+  # Configure API key authorization: ApiKeyAuth
+  config.api_key['X-CMC_PRO_API_KEY'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  #config.api_key_prefix['X-CMC_PRO_API_KEY'] = 'Bearer'
+end
+
+api_instance = CoinmarketcapAPI::DefaultApi.new
+
+opts = { 
+  listing_status: 'active', # String | Only active coins are returned by default. Pass 'inactive' to get a list of coins that are no longer active.
+  start: 1, # Integer | Optionally offset the start (1-based index) of the paginated list of items to return.
+  limit: 56, # Integer | Optionally specify the number of results to return. Use this parameter and the \"start\" parameter to determine your own pagination size.
+  symbol: 'symbol_example' # String | Optionally pass a comma-separated list of cryptocurrency symbols to return CoinMarketCap IDs for. If this option is passed, other options will be ignored.
+}
+
+begin
+  #Get CoinMarketCap ID map
+  result = api_instance.cryptocurrency_map_get(opts)
+  p result
+rescue CoinmarketcapAPI::ApiError => e
+  puts "Exception when calling DefaultApi->cryptocurrency_map_get: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **listing_status** | **String**| Only active coins are returned by default. Pass 'inactive' to get a list of coins that are no longer active. | [optional] [default to active]
+ **start** | **Integer**| Optionally offset the start (1-based index) of the paginated list of items to return. | [optional] [default to 1]
+ **limit** | **Integer**| Optionally specify the number of results to return. Use this parameter and the \"start\" parameter to determine your own pagination size. | [optional] 
+ **symbol** | **String**| Optionally pass a comma-separated list of cryptocurrency symbols to return CoinMarketCap IDs for. If this option is passed, other options will be ignored. | [optional] 
+
+### Return type
+
+[**InlineResponse2003**](InlineResponse2003.md)
+
+### Authorization
+
+[ApiKeyAuth](../README.md#ApiKeyAuth)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+