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.

Single Result - This endpoint returns only one single result. GET /market-data/assets/{assetSymbol}

Path Parameters

Required
assetSymbol string

Specifies the asset's unique symbol in the Crypto APIs listings.

Example : BTC

Query parameters

Optional
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.

Example : yourExampleString

Response schema

200 400 401 402 403 409 415 422 429 500

HTTP Status Code: 200
Content-Type: application/json

The request has been successful.

Object :
Required
apiVersion string

Specifies the version of the API that incorporates this endpoint.

Example : 2023-04-25
Required
requestId string

Defines the ID of the request. The requestId is generated by Crypto APIs and it's unique for every request.

Example : 601c1710034ed6d407996b30
Optional
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.

Example : yourExampleString
Required
data
object
- Required
  item object
  
  Required
  assetId string
  
  Defines the unique ID of the specific asset.
  
  Example : 5b1ea92e584bf50020130615
  
  Required
  assetLogo object
  
  Required
  encoding string
  
  Defines the encoding of the image data which is usually base64.
  
  Example : base64
  
  Required
  imageData string
  
  Defines the encoded image data as a string.
  
  Example : PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIHdpZHRoPSIzMiIgaGVpZ2h0PSIzMiI+PGcgZmlsbD0ibm9uZSIgZmlsbC1ydWxlPSJldmVub2RkIj48Y2lyY2xlIGN4PSIxNiIgY3k9IjE2IiByPSIxNiIgZmlsbD0iI0Y3OTMxQSIvPjxwYXRoIGZpbGw9IiNGRkYiIGZpbGwtcnVsZT0ibm9uemVybyIgZD0iTTIzLjE4OSAxNC4wMmMuMzE0LTIuMDk2LTEuMjgzLTMuMjIzLTMuNDY1LTMuOTc1bC43MDgtMi44NC0xLjcyOC0uNDMtLjY5IDIuNzY1Yy0uNDU0LS4xMTQtLjkyLS4yMi0xLjM4NS0uMzI2bC42OTUtMi43ODNMMTUuNTk2IDZsLS43MDggMi44MzljLS4zNzYtLjA4Ni0uNzQ2LS4xNy0xLjEwNC0uMjZsLjAwMi0uMDA5LTIuMzg0LS41OTUtLjQ2IDEuODQ2czEuMjgzLjI5NCAxLjI1Ni4zMTJjLjcuMTc1LjgyNi42MzguODA1IDEuMDA2bC0uODA2IDMuMjM1Yy4wNDguMDEyLjExLjAzLjE4LjA1N2wtLjE4My0uMDQ1LTEuMTMgNC41MzJjLS4wODYuMjEyLS4zMDMuNTMxLS43OTMuNDEuMDE4LjAyNS0xLjI1Ni0uMzEzLTEuMjU2LS4zMTNsLS44NTggMS45NzggMi4yNS41NjFjLjQxOC4xMDUuODI4LjIxNSAxLjIzMS4zMThsLS43MTUgMi44NzIgMS43MjcuNDMuNzA4LTIuODRjLjQ3Mi4xMjcuOTMuMjQ1IDEuMzc4LjM1N2wtLjcwNiAyLjgyOCAxLjcyOC40My43MTUtMi44NjZjMi45NDguNTU4IDUuMTY0LjMzMyA2LjA5Ny0yLjMzMy43NTItMi4xNDYtLjAzNy0zLjM4NS0xLjU4OC00LjE5MiAxLjEzLS4yNiAxLjk4LTEuMDAzIDIuMjA3LTIuNTM4em0tMy45NSA1LjUzOGMtLjUzMyAyLjE0Ny00LjE0OC45ODYtNS4zMi42OTVsLjk1LTMuODA1YzEuMTcyLjI5MyA0LjkyOS44NzIgNC4zNyAzLjExem0uNTM1LTUuNTY5Yy0uNDg3IDEuOTUzLTMuNDk1Ljk2LTQuNDcuNzE3bC44Ni0zLjQ1Yy45NzUuMjQzIDQuMTE4LjY5NiAzLjYxIDIuNzMzeiIvPjwvZz48L3N2Zz4=
  
  Required
  mimeType string
  
  Defines the image type of the logo - jpg, png, svg, etc.
  
  Example : image/svg+xml
  
  Required
  assetName string
  
  Specifies the name of the asset in question.
  
  Example : Bitcoin
  
  Required
  assetOriginalSymbol string
  
  Specifies the asset's original symbol as introduced by its founders.
  
  Example : BTC
  
  Required
  assetSymbol string
  
  Specifies the asset's unique symbol in the Crypto APIs listings.
  
  Example : BTC
  
  Required
  assetType string
  
  Defines the type of the supported asset. This could be either "crypto" or "fiat".
  
  Example : crypto
  
  Possible Values : fiat crypto
  
  Required
  latestRate object
  
  Specifies the latest price of the asset.
  
  Required
  amount string
  
  Represents the amount of the latest rate.
  
  Example : 61704.20995670996
  
  Optional
  calculationTimestamp integer
  
  Defines when the price was calculated in UNIX timestamp. Oldest possible timestamp is 30 days.
  
  Example : 1636107864
  
  Required
  unit string
  
  Specifies the unit of the latest price of the asset.
  
  Example : USD
  
  Optional
  slug string
  
  Represents the asset`s unique slug string in Crypto APIs listings.
  
  Example : bitcoin
  
  Required
  specificData object One Of
  
  object
  
  Required
  1HourPriceChangeInPercentage string
  
  Represents the percentage of the asset's current price against the its price from 1 hour ago.
  
  Example : -0.4277852328344024
  
  Required
  1WeekPriceChangeInPercentage string
  
  Represents the percentage of the asset's current price against the its price from 1 week ago.
  
  Example : 1.6572304104646762
  
  Required
  24HoursPriceChangeInPercentage string
  
  Represents the percentage of the asset's current price against the its price from 24 hours ago.
  
  Example : -0.059688916478600924
  
  Required
  24HoursTradingVolume string
  
  Represents the trading volume of the asset for the time frame of 24 hours.
  
  Example : 3116834672.508857
  
  Required
  assetType string
  
  Defines the type of the supported asset. This could be either "crypto" or "fiat".
  
  Example : coin
  
  Possible Values : coin token
  
  Required
  circulatingSupply string
  
  Represents the amount of the asset that is circulating on the market and in public hands.
  
  Example : 18562881
  
  Required
  marketCapInUSD string
  
  Defines the total market value of the asset's circulating supply in USD.
  
  Example : 1146119021006.8835
  
  Required
  maxSupply string
  
  Represents the maximum amount of all coins of a specific asset that will ever exist in its lifetime.
  
  Example : 21000000

Credits Cost : 500 Credits For 1 Result(s)

Try it out

Request Example

Http Java C# PHP Python Ruby Node.js Go

GET

https://rest.cryptoapis.io/market-data/assets/BTC?context=yourExampleString

Headers

Content-Type: application/json

X-API-Key: my-api-key

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://rest.cryptoapis.io/market-data/assets/BTC?context=yourExampleString")
  .get()
  .addHeader("Content-Type", "application/json")
  .addHeader("X-API-Key", "my-api-key")
  .build();

Response response = client.newCall(request).execute();

var client = new RestClient("https://rest.cryptoapis.io/market-data/assets/BTC?context=yourExampleString");
var request = new RestRequest(Method.GET);
request.AddHeader("X-API-Key", "my-api-key");
IRestResponse response = client.Execute(request);

$request = new HttpRequest();
$request->setUrl('https://rest.cryptoapis.io/market-data/assets/BTC?context=yourExampleString');
$request->setMethod(HTTP_METH_GET);

$request->setHeaders(array(
    'Content-Type' => 'application/json',
    'X-API-Key' => 'my-api-key'
));

try {
    $response = $request->send();

    echo $response->getBody();
} catch (HttpException $ex) {
    echo $ex;
}

import http.client

conn = http.client.HTTPConnection("https://rest.cryptoapis.io")
querystring = {"context":"yourExampleString"}
headers = {
  'Content-Type': "application/json",
  'X-API-Key': "my-api-key"
}

conn.request("GET", "market-data,assets,BTC", headers=headers  , params=querystring )

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))
}

require 'uri'
require 'net/http'

url = URI("https://rest.cryptoapis.io/market-data/assets/BTC?context=yourExampleString")

http = Net::HTTP.new(url.host, url.port)

request = Net::HTTP::Get.new(url)
request["Content-Type"] = 'application/json'
request["X-API-Key"] = 'my-api-key'

response = http.request(request)
puts response.read_body

var https = require("https");

var options = {
  "method": "GET",
  "hostname": "rest.cryptoapis.io",
  "path": "/v2/market-data/assets/BTC",
  "qs": {"context":"yourExampleString"},
  "headers": {
    "Content-Type": "application/json",
    "X-API-Key": "my-api-key"
  }
};

var req = https.request(options, function (res) {
  var chunks = [];

  res.on("data", function (chunk) {
    chunks.push(chunk);
  });

  res.on("end", function () {
    var body = Buffer.concat(chunks);
    console.log(body.toString());
  });
});

req.end();

package main

import (
  "fmt"
  "net/http"
  "io/ioutil"
)

func main() {

  url := "https://rest.cryptoapis.io/market-data/assets/BTC?context=yourExampleString"

  req, _ := http.NewRequest("GET", url, nil)

  req.Header.Add("Content-Type", "application/json")
  req.Header.Add("X-API-Key", "my-api-key")

  res, _ := http.DefaultClient.Do(req)

  defer res.Body.Close()
  body, _ := ioutil.ReadAll(res.Body)

  fmt.Println(res)
  fmt.Println(string(body))

}

200 400 401 402 403 409 415 422 429 500

Response Example

{
    "apiVersion": "2023-04-25",
    "requestId": "601c1710034ed6d407996b30",
    "context": "yourExampleString",
    "data": {
        "item": {
            "assetId": "5b1ea92e584bf50020130615",
            "assetLogo": {
                "encoding": "base64",
                "imageData": "PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIHdpZHRoPSIzMiIgaGVpZ2h0PSIzMiI+PGcgZmlsbD0ibm9uZSIgZmlsbC1ydWxlPSJldmVub2RkIj48Y2lyY2xlIGN4PSIxNiIgY3k9IjE2IiByPSIxNiIgZmlsbD0iI0Y3OTMxQSIvPjxwYXRoIGZpbGw9IiNGRkYiIGZpbGwtcnVsZT0ibm9uemVybyIgZD0iTTIzLjE4OSAxNC4wMmMuMzE0LTIuMDk2LTEuMjgzLTMuMjIzLTMuNDY1LTMuOTc1bC43MDgtMi44NC0xLjcyOC0uNDMtLjY5IDIuNzY1Yy0uNDU0LS4xMTQtLjkyLS4yMi0xLjM4NS0uMzI2bC42OTUtMi43ODNMMTUuNTk2IDZsLS43MDggMi44MzljLS4zNzYtLjA4Ni0uNzQ2LS4xNy0xLjEwNC0uMjZsLjAwMi0uMDA5LTIuMzg0LS41OTUtLjQ2IDEuODQ2czEuMjgzLjI5NCAxLjI1Ni4zMTJjLjcuMTc1LjgyNi42MzguODA1IDEuMDA2bC0uODA2IDMuMjM1Yy4wNDguMDEyLjExLjAzLjE4LjA1N2wtLjE4My0uMDQ1LTEuMTMgNC41MzJjLS4wODYuMjEyLS4zMDMuNTMxLS43OTMuNDEuMDE4LjAyNS0xLjI1Ni0uMzEzLTEuMjU2LS4zMTNsLS44NTggMS45NzggMi4yNS41NjFjLjQxOC4xMDUuODI4LjIxNSAxLjIzMS4zMThsLS43MTUgMi44NzIgMS43MjcuNDMuNzA4LTIuODRjLjQ3Mi4xMjcuOTMuMjQ1IDEuMzc4LjM1N2wtLjcwNiAyLjgyOCAxLjcyOC40My43MTUtMi44NjZjMi45NDguNTU4IDUuMTY0LjMzMyA2LjA5Ny0yLjMzMy43NTItMi4xNDYtLjAzNy0zLjM4NS0xLjU4OC00LjE5MiAxLjEzLS4yNiAxLjk4LTEuMDAzIDIuMjA3LTIuNTM4em0tMy45NSA1LjUzOGMtLjUzMyAyLjE0Ny00LjE0OC45ODYtNS4zMi42OTVsLjk1LTMuODA1YzEuMTcyLjI5MyA0LjkyOS44NzIgNC4zNyAzLjExem0uNTM1LTUuNTY5Yy0uNDg3IDEuOTUzLTMuNDk1Ljk2LTQuNDcuNzE3bC44Ni0zLjQ1Yy45NzUuMjQzIDQuMTE4LjY5NiAzLjYxIDIuNzMzeiIvPjwvZz48L3N2Zz4=",
                "mimeType": "image/svg+xml"
            },
            "assetName": "Bitcoin",
            "assetOriginalSymbol": "BTC",
            "assetSymbol": "BTC",
            "assetType": "crypto",
            "latestRate": {
                "amount": "61704.20995670996",
                "calculationTimestamp": 1636107864,
                "unit": "USD"
            },
            "slug": "bitcoin",
            "specificData": {
                "1HourPriceChangeInPercentage": "-0.4277852328344024",
                "1WeekPriceChangeInPercentage": "1.6572304104646762",
                "24HoursPriceChangeInPercentage": "-0.059688916478600924",
                "24HoursTradingVolume": "3116834672.508857",
                "assetType": "coin",
                "circulatingSupply": "18562881",
                "marketCapInUSD": "1146119021006.8835",
                "maxSupply": "21000000"
            }
        }
    }
}

{
    "apiVersion": "2023-04-25",
    "requestId": "601c1710034ed6d407996b30",
    "context": "yourExampleString",
    "error": {
        "code": "uri_not_found",
        "message": "The specified URI has not been found. Check the URI and try again.",
        "details": [
            {
                "attribute": "attribute which content caused the error",
                "message": "message describing the error"
            }
        ]
    }
}

{
    "apiVersion": "2023-04-25",
    "requestId": "601c1710034ed6d407996b30",
    "context": "yourExampleString",
    "error": {
        "code": "limit_greater_than_allowed",
        "message": "You have reached the allowed limit. The maximum number of items for this endpoint is {limit}, please use the specific pagination attributes to get the items in portions.",
        "details": [
            {
                "attribute": "attribute which content caused the error",
                "message": "message describing the error"
            }
        ]
    }
}

{
    "apiVersion": "2023-04-25",
    "requestId": "601c1710034ed6d407996b30",
    "context": "yourExampleString",
    "error": {
        "code": "invalid_pagination",
        "message": "The pagination attributes that have been used are invalid. Please check the Documentation to see details on pagination.",
        "details": [
            {
                "attribute": "attribute which content caused the error",
                "message": "message describing the error"
            }
        ]
    }
}

{
    "apiVersion": "2023-04-25",
    "requestId": "601c1710034ed6d407996b30",
    "context": "yourExampleString",
    "error": {
        "code": "missing_api_key",
        "message": "The specific authorization header (API Key) is missing, please check our Authorization section in our Documentation.",
        "details": [
            {
                "attribute": "attribute which content caused the error",
                "message": "message describing the error"
            }
        ]
    }
}

{
    "apiVersion": "2023-04-25",
    "requestId": "601c1710034ed6d407996b30",
    "context": "yourExampleString",
    "error": {
        "code": "invalid_api_key",
        "message": "The provided API key is invalid. Please, generate a new one from your Dashboard.",
        "details": [
            {
                "attribute": "attribute which content caused the error",
                "message": "message describing the error"
            }
        ]
    }
}

{
    "apiVersion": "2023-04-25",
    "requestId": "601c1710034ed6d407996b30",
    "context": "yourExampleString",
    "error": {
        "code": "insufficient_credits",
        "message": "You have insufficient credits. Please upgrade your plan from your Dashboard or contact our team via email.",
        "details": [
            {
                "attribute": "attribute which content caused the error",
                "message": "message describing the error"
            }
        ]
    }
}

{
    "apiVersion": "2023-04-25",
    "requestId": "601c1710034ed6d407996b30",
    "context": "yourExampleString",
    "error": {
        "code": "banned_ip_address",
        "message": "This IP address has been banned. To check the reason for that, please contact our team via email.",
        "details": [
            {
                "attribute": "attribute which content caused the error",
                "message": "message describing the error"
            }
        ]
    }
}

{
    "apiVersion": "2023-04-25",
    "requestId": "601c1710034ed6d407996b30",
    "context": "yourExampleString",
    "error": {
        "code": "endpoint_not_allowed_for_plan",
        "message": "This endpoint is not available for your current subscription plan, please upgrade your plan to be able to use it.",
        "details": [
            {
                "attribute": "attribute which content caused the error",
                "message": "message describing the error"
            }
        ]
    }
}

{
    "apiVersion": "2023-04-25",
    "requestId": "601c1710034ed6d407996b30",
    "context": "yourExampleString",
    "error": {
        "code": "endpoint_not_allowed_for_api_key",
        "message": "This endpoint is not available for your API key.",
        "details": [
            {
                "attribute": "attribute which content caused the error",
                "message": "message describing the error"
            }
        ]
    }
}

{
    "apiVersion": "2023-04-25",
    "requestId": "601c1710034ed6d407996b30",
    "context": "yourExampleString",
    "error": {
        "code": "feature_mainnets_not_allowed_for_plan",
        "message": "Mainnets access is not available for your current subscription plan, please upgrade your plan to be able to use it.",
        "details": [
            {
                "attribute": "attribute which content caused the error",
                "message": "message describing the error"
            }
        ]
    }
}

{
    "apiVersion": "2023-04-25",
    "requestId": "601c1710034ed6d407996b30",
    "context": "yourExampleString",
    "error": {
        "code": "invalid_data",
        "message": "The data provided seems to be invalid.",
        "details": [
            {
                "attribute": "attribute which content caused the error",
                "message": "message describing the error"
            }
        ]
    }
}

{
    "apiVersion": "2023-04-25",
    "requestId": "601c1710034ed6d407996b30",
    "context": "yourExampleString",
    "error": {
        "code": "unsupported_media_type",
        "message": "The selected Media Type is unavailable. The Content-Type header should be 'application/json'.",
        "details": [
            {
                "attribute": "attribute which content caused the error",
                "message": "message describing the error"
            }
        ]
    }
}

{
    "apiVersion": "2023-04-25",
    "requestId": "601c1710034ed6d407996b30",
    "context": "yourExampleString",
    "error": {
        "code": "invalid_request_body_structure",
        "message": "Your request body for POST requests must have a structure of { data: { item: [...properties] } }",
        "details": [
            {
                "attribute": "attribute which content caused the error",
                "message": "message describing the error"
            }
        ]
    }
}

{
    "apiVersion": "2023-04-25",
    "requestId": "601c1710034ed6d407996b30",
    "context": "yourExampleString",
    "error": {
        "code": "request_limit_reached",
        "message": "The request limit has been reached. There can be maximum {requests} requests per {seconds} second(s) made. Please contact our team via email if you need more or upgrade your plan.",
        "details": [
            {
                "attribute": "attribute which content caused the error",
                "message": "message describing the error"
            }
        ]
    }
}

{
    "apiVersion": "2023-04-25",
    "requestId": "601c1710034ed6d407996b30",
    "context": "yourExampleString",
    "error": {
        "code": "unexpected_server_error",
        "message": "An unexpected server error has occurred, we are working to fix this. Please try again later and in case it occurs again please report it to our team via email.",
        "details": [
            {
                "attribute": "attribute which content caused the error",
                "message": "message describing the error"
            }
        ]
    }
}

Get Asset Details By Asset Symbol

Path Parameters

Query parameters

Response schema

Object :

Object :

Object :

Object :

Object :

Object :

Object :

Object :

Object :

Object :

Credits Cost : 500 Credits For 1 Result(s)

Request Example

Response Example

Try It Out API Endpoint