Skip to content

Latest commit

 

History

History
67 lines (45 loc) · 2.84 KB

MetadataApi.md

File metadata and controls

67 lines (45 loc) · 2.84 KB
Raw

Cryptoapis.MetadataApi

All URIs are relative to https://rest.cryptoapis.io

Method HTTP request Description
listSupportedAssets GET /market-data/assets/supported List Supported Assets

listSupportedAssets

ListSupportedAssetsR listSupportedAssets(opts)

List Supported Assets

This endpoint will return a list of supported assets. The asset could be a cryptocurrency 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".

Example

import Cryptoapis from 'cryptoapis';
let defaultClient = Cryptoapis.ApiClient.instance;
// Configure API key authorization: ApiKey
let ApiKey = defaultClient.authentications['ApiKey'];
ApiKey.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKey.apiKeyPrefix = 'Token';

let apiInstance = new Cryptoapis.MetadataApi();
let opts = {
  'context': yourExampleString, // 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.
  'assetType': crypto, // String | Defines the type of the supported asset. This could be either \"crypto\" or \"fiat\".
  'limit': 50, // Number | Defines how many items should be returned in the response per page basis.
  'offset': 0 // Number | The starting index of the response items, i.e. where the response should start listing the returned items.
};
apiInstance.listSupportedAssets(opts).then((data) => {
  console.log('API called successfully. Returned data: ' + data);
}, (error) => {
  console.error(error);
});

Parameters

Name Type Description Notes
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. [optional]
assetType String Defines the type of the supported asset. This could be either "crypto" or "fiat". [optional]
limit Number Defines how many items should be returned in the response per page basis. [optional] [default to 50]
offset Number The starting index of the response items, i.e. where the response should start listing the returned items. [optional] [default to 0]

Return type

ListSupportedAssetsR

Authorization

ApiKey

HTTP request headers

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