Crypto Exchange Endpoint

The Crypto Exchange endpoint allows you to get the exchange of any cryptocurrency compared against USD or any other local currency

Crypto Exchange Endpoint

GET https://api-stg.onekeypayments.com/v3/exchange_rates/crypto?currency={currency}&amount={amount}&crypto={crypto}

The Crypto Exchange endpoint allows you to get the exchange of any crypto currency compared against USD or any other local currency.

Query Parameters

Name

Type

Description

currency

string

USD or the country's local currency that will be used by the payer

amount

number

Amount in the previously specified currency. Used to calculate the exchange in the cryptocurrency specified below. Default: 1

crypto

string

Cryptocurrency symbol in which the amount will be converted to

Headers

Name

Type

Description

Authorization

string

"Bearer " + Read-Only API Key

{
  "fx_rate": 5.8829,
  "converted_amount": 58.829,
  "fee": 0.64
}

Please find all the country and currencies codes in the Countries Specifications section.

Description

The Crypto Exchange Endpoint allows you to convert any amount in USD or Local Currency to the specified Cryptocurrency.

Request

In order to start using the Crypto Exchange endpoint, you need to:

Send the request with GET method.
Specify a valid currency code in the request as QUERY PARAMS.
Specify the amount to convert.* If it's not specified, 1 is assumed.
Specify a valid cryptocurrency symbol that will be converted the amount to.
Send the Authorization header with your read-only API Key as Bearer as follows:

Authorization: Bearer your_read_only_key_here

Example request

curl --location --request GET 'https://api-stg.onekeypayments.com/v3/exchange_rates/crypto?currency=BRL&crypto=USDT' \
--header 'Authorization: Bearer your_read_only_key_here'

import java.io.*;
import okhttp3.*;

public class main {
  public static void main(String []args) throws IOException{
    OkHttpClient client = new OkHttpClient().newBuilder()
      .build();
    Request request = new Request.Builder()
      .url("https://api-stg.onekeypayments.com/v3/exchange_rates/crypto?currency=BRL&amount=1000&crypto=USDT")
      .method("GET", null)
      .addHeader("Authorization", "Bearer your_read_only_key_here")
      .build();
    Response response = client.newCall(request).execute();
    System.out.println(response.body().string());
  }
}

using System;
using RestSharp;

namespace HelloWorldApplication {
    class HelloWorld {
        static void Main(string[] args) {
            var client = new RestClient("https://api-stg.onekeypayments.com/v3/exchange_rates/crypto?currency=BRL&amount=1000&crypto=USDT");
            client.Timeout = -1;
            var request = new RestRequest(Method.GET);
            request.AddHeader("Authorization", "Bearer your_read_only_key_here");
            IRestResponse response = client.Execute(request);
            Console.WriteLine(response.Content);
        }
    }
}

<?php

$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => "https://api-stg.onekeypayments.com/v3/exchange_rates/crypto?currency=BRL&amount=1000&crypto=USDT",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 0,
  CURLOPT_FOLLOWLOCATION => true,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => array(
    "Authorization: Bearer your_read_only_key_here"
  ),
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;

Example Response

{
  "fx_rate": 5.8829,
  "converted_amount": 58.829,
  "fee": 0.64
}

Response fields

Field name

Format

Description

fx_rate

Number

Exchange rate of the cryptocurrency against the base currency

converted_amount

Number

Amount in the cryptocurrency specified. Default: 1

fee

Number

Fee for converting the specified amount to the cryptocurrency.

PreviousCurrency Exchange Endpoint NextCountry States Codes Endpoint

Last updated 2 years ago

Was this helpful?

hashtagCrypto Exchange Endpoint

hashtagQuery Parameters

hashtagHeaders

hashtagDescription

hashtagRequest

hashtagExample request

hashtagExample Response

hashtag

hashtagResponse fields