Class: CryptoApis::AssetsApi

Inherits:
Object
  • Object
show all
Defined in:
lib/crypto_apis/api/assets_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ AssetsApi

Returns a new instance of AssetsApi.



19
20
21
 
# File 'lib/crypto_apis/api/assets_api.rb', line 19

def initialize(api_client = ApiClient.default)
  @api_client = api_client
end

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



17
18
19
 
# File 'lib/crypto_apis/api/assets_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#get_asset_details_by_asset_id(asset_id, opts = {}) ⇒ GetAssetDetailsByAssetIDR

Get Asset Details By Asset ID Through this endpoint users can obtain information on assets by ‘assetId`. The details returned could include information on the latest rate and rate fluctuation of different periods of time - 24 hours, a week, one hour, the encoding of the logo, and more.

Parameters:

  • asset_id (String) —

    Defines the unique ID of the specific asset.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :context (String) —

    In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.

Returns:



28
29
30
31
 
# File 'lib/crypto_apis/api/assets_api.rb', line 28

def get_asset_details_by_asset_id(asset_id, opts = {})
  data, _status_code, _headers = get_asset_details_by_asset_id_with_http_info(asset_id, opts)
  data
end

#get_asset_details_by_asset_id_with_http_info(asset_id, opts = {}) ⇒ Array<(GetAssetDetailsByAssetIDR, Integer, Hash)>

Get Asset Details By Asset ID Through this endpoint users can obtain information on assets by &#x60;assetId&#x60;. The details returned could include information on the latest rate and rate fluctuation of different periods of time - 24 hours, a week, one hour, the encoding of the logo, and more.

Parameters:

  • asset_id (String) —

    Defines the unique ID of the specific asset.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :context (String) —

    In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. &#x60;context&#x60; is specified by the user.

Returns:

  • (Array<(GetAssetDetailsByAssetIDR, Integer, Hash)>) —

    GetAssetDetailsByAssetIDR data, response status code and response headers



39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
 
# File 'lib/crypto_apis/api/assets_api.rb', line 39

def get_asset_details_by_asset_id_with_http_info(asset_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AssetsApi.get_asset_details_by_asset_id ...'
  end
  # verify the required parameter 'asset_id' is set
  if @api_client.config.client_side_validation && asset_id.nil?
    fail ArgumentError, "Missing the required parameter 'asset_id' when calling AssetsApi.get_asset_details_by_asset_id"
  end
  # resource path
  local_var_path = '/market-data/assets/assetId/{assetId}'.sub('{' + 'assetId' + '}', CGI.escape(asset_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'context'] = opts[:'context'] if !opts[:'context'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'GetAssetDetailsByAssetIDR'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['ApiKey']

  new_options = opts.merge(
    :operation => :"AssetsApi.get_asset_details_by_asset_id",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AssetsApi#get_asset_details_by_asset_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_asset_details_by_asset_symbol(asset_symbol, opts = {}) ⇒ GetAssetDetailsByAssetSymbolR

Get Asset Details By Asset Symbol Through this endpoint users can obtain information on assets by asset symbol. The details returned could include information on the latest rate and rate fluctuation of different periods of time - 24 hours, a week, one hour, the encoding of the logo, and more.

Parameters:

  • asset_symbol (String) —

    Specifies the asset&#39;s unique symbol in the Crypto APIs listings.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :context (String) —

    In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. &#x60;context&#x60; is specified by the user.

Returns:



94
95
96
97
 
# File 'lib/crypto_apis/api/assets_api.rb', line 94

def get_asset_details_by_asset_symbol(asset_symbol, opts = {})
  data, _status_code, _headers = get_asset_details_by_asset_symbol_with_http_info(asset_symbol, opts)
  data
end

#get_asset_details_by_asset_symbol_with_http_info(asset_symbol, opts = {}) ⇒ Array<(GetAssetDetailsByAssetSymbolR, Integer, Hash)>

Get Asset Details By Asset Symbol Through this endpoint users can obtain information on assets by asset symbol. The details returned could include information on the latest rate and rate fluctuation of different periods of time - 24 hours, a week, one hour, the encoding of the logo, and more.

Parameters:

  • asset_symbol (String) —

    Specifies the asset&#39;s unique symbol in the Crypto APIs listings.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :context (String) —

    In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. &#x60;context&#x60; is specified by the user.

Returns:



105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
 
# File 'lib/crypto_apis/api/assets_api.rb', line 105

def get_asset_details_by_asset_symbol_with_http_info(asset_symbol, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AssetsApi.get_asset_details_by_asset_symbol ...'
  end
  # verify the required parameter 'asset_symbol' is set
  if @api_client.config.client_side_validation && asset_symbol.nil?
    fail ArgumentError, "Missing the required parameter 'asset_symbol' when calling AssetsApi.get_asset_details_by_asset_symbol"
  end
  # resource path
  local_var_path = '/market-data/assets/{assetSymbol}'.sub('{' + 'assetSymbol' + '}', CGI.escape(asset_symbol.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'context'] = opts[:'context'] if !opts[:'context'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'GetAssetDetailsByAssetSymbolR'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['ApiKey']

  new_options = opts.merge(
    :operation => :"AssetsApi.get_asset_details_by_asset_symbol",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AssetsApi#get_asset_details_by_asset_symbol\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#list_assets_details(opts = {}) ⇒ ListAssetsDetailsR

List Assets Details This endpoint will return a list of details on assets. These could be cryptocurrencies or FIAT assets that we support. Each asset has a unique identifier - ‘assetId` and a unique symbol in the form of a string, e.g. "BTC". The details returned could include information on the latest rate and rate fluctuation of different periods of time - 24 hours, a week, one hour, the encoding of the logo, and more.

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :context (String) —

    In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. &#x60;context&#x60; is specified by the user.

  • :asset_type (String) —

    Defines the type of the supported asset. This could be either &quot;crypto&quot; or &quot;fiat&quot;.

  • :crypto_type (String) —

    Subtype of the crypto assets. Could be COIN or TOKEN

  • :limit (Integer) —

    Defines how many items should be returned in the response per page basis. (default to 50)

  • :offset (Integer) —

    The starting index of the response items, i.e. where the response should start listing the returned items. (default to 0)

  • :waas_enabled (Boolean) —

    Show only if WaaS is/not enabled

Returns:



164
165
166
167
 
# File 'lib/crypto_apis/api/assets_api.rb', line 164

def list_assets_details(opts = {})
  data, _status_code, _headers = list_assets_details_with_http_info(opts)
  data
end

#list_assets_details_with_http_info(opts = {}) ⇒ Array<(ListAssetsDetailsR, Integer, Hash)>

List Assets Details This endpoint will return a list of details on assets. These could be cryptocurrencies or FIAT assets that we support. Each asset has a unique identifier - &#x60;assetId&#x60; and a unique symbol in the form of a string, e.g. &quot;BTC&quot;. The details returned could include information on the latest rate and rate fluctuation of different periods of time - 24 hours, a week, one hour, the encoding of the logo, and more.

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :context (String) —

    In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. &#x60;context&#x60; is specified by the user.

  • :asset_type (String) —

    Defines the type of the supported asset. This could be either &quot;crypto&quot; or &quot;fiat&quot;.

  • :crypto_type (String) —

    Subtype of the crypto assets. Could be COIN or TOKEN

  • :limit (Integer) —

    Defines how many items should be returned in the response per page basis. (default to 50)

  • :offset (Integer) —

    The starting index of the response items, i.e. where the response should start listing the returned items. (default to 0)

  • :waas_enabled (Boolean) —

    Show only if WaaS is/not enabled

Returns:

  • (Array<(ListAssetsDetailsR, Integer, Hash)>) —

    ListAssetsDetailsR data, response status code and response headers



179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
 
# File 'lib/crypto_apis/api/assets_api.rb', line 179

def list_assets_details_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AssetsApi.list_assets_details ...'
  end
  allowable_values = ["fiat", "crypto"]
  if @api_client.config.client_side_validation && opts[:'asset_type'] && !allowable_values.include?(opts[:'asset_type'])
    fail ArgumentError, "invalid value for \"asset_type\", must be one of #{allowable_values}"
  end
  allowable_values = ["coin", "token"]
  if @api_client.config.client_side_validation && opts[:'crypto_type'] && !allowable_values.include?(opts[:'crypto_type'])
    fail ArgumentError, "invalid value for \"crypto_type\", must be one of #{allowable_values}"
  end
  # resource path
  local_var_path = '/market-data/assets/details'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'context'] = opts[:'context'] if !opts[:'context'].nil?
  query_params[:'assetType'] = opts[:'asset_type'] if !opts[:'asset_type'].nil?
  query_params[:'cryptoType'] = opts[:'crypto_type'] if !opts[:'crypto_type'].nil?
  query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
  query_params[:'offset'] = opts[:'offset'] if !opts[:'offset'].nil?
  query_params[:'waasEnabled'] = opts[:'waas_enabled'] if !opts[:'waas_enabled'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'ListAssetsDetailsR'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['ApiKey']

  new_options = opts.merge(
    :operation => :"AssetsApi.list_assets_details",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AssetsApi#list_assets_details\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end