docs.currencyapi.ioQuick Start Guide ? | Currency API

Currency API Home open in new window Pricing open in new window Home open in new window Pricing open in new window Quick Start Guide ? Requirements Getting Started Definitions API URL Authentication (Token) Available symbols (Pairs) Tick data API Historical data API Code Examples JavaScript PHP Python PowerShell cURL C# Go (Native) Ruby Swift NodeJs Java # Introduction Currency API is fast and friendly crypto, commodity, and FX Currency Conversion JSON API, covering over 1200+ pairs. # Requirements We’ve made it easy to be up and running. All you need to do is to visit "My Account" and locate your token. If you don’t have one yet, please subscribe and get one immediately. # Getting Started Get ready to connect to Currency API using few coding lines of your favorite programming language. # Definitions Definition Description API URL The URL which all API request endpoints and URLs are based on. Token The access key assigned to your account and used to authenticate with the API. Symbol The three-letter currency code or currency pair (e.g., EUR, EURUSD). Base Currency The currency to which exchange rates are relative to. (If 1 USD = X EUR, USD is the base currency) Target Currency The currency an amount is converted to. (If 1 USD = X EUR, EUR is the target currency) Timestamp format All timestamps are unix/epoch timestamps (seconds that have passed since since January 1, 1970 UTC). # API URL The Currency API comes with a single endpoint that enables you to query one or many currency codes or pairs, with readable parameters. Depending on your subscription plan, the endpoint will return real-time exchange rate data. https://api.currencyapi.io/ # Authentication (Token) Your API token is a unique access key passed into the API URL’s token parameter to authenticate with the Currency API. The following is an example of how to append the access token for authentication: https : / / api . currencyapi . io / markets ? token = ACCESS_TOKEN # Available symbols (Pairs) To get the complete list of a specific market (e.g., Forex, Crypto, etc.) available symbols/pairs, use the following endpoint. Replace the MARKET_NAME with the targeted market (crypto or forex) https : / / api . currencyapi . io / markets ? token = ACCESS_TOKEN & market = MARKET_NAME # Tick data API /markets endpoint provides you the ability to query a base currency (e.g., EUR) or currency pair (e.g.,EURUSD). # Query with base curency or pair # Search symbol/s GET https : / / api . currencyapi . io / markets ? token = ACCESS_TOKEN & search = SYMBOL Response [ { "t" : "2021-04-15T03:53:00.593Z" , "tms" : "1618458780086" , "s" : "EURUSD" , "b" : 1.19864 , "bd" : 0 , "a" : 1.19867 , "ad" : 1 , "p" : 5 } ] # Get exact symbol/s GET https : / / api . currencyapi . io / markets ? token = ACCESS_TOKEN & symbol = SYMBOL Response { "t" : "2021-04-15T03:53:00.593Z" , "tms" : "1618458780086" , "s" : "EURUSD" , "b" : 1.19864 , "bd" : 0 , "a" : 1.19867 , "ad" : 1 , "p" : 5 } # Symbol Response JSON Structure Key Description t The last update date/time of query result. tms The last update timestamp of query result. s The currency pair. b The bid price. It is also referring to the highest price a buyer will pay for a currency. bd The bid price direction. It is also referring to the color code of the displayed bid price (e.g., red/green). a The ask price. It is also referring to the lowest price a seller will accept for a currency. ad The ask price direction. It is also referring to the color code of the displayed ask price (e.g., red/green). p The Currency precision # Historical data API You can get the historical data of any of the available symbols by adding the historical parameter. Response [ [ 1620604800 , 58336.16 , 59603 , 57399.33 , 57960 ] , ... ] GET https : / / api . currencyapi . io / markets ? token = ACCESS_TOKEN & symbol = SYMBOL & historical = true & offset = OFFSET // Optional (candles offset) & scale = SCALE // Optional (e.g., 1, 60, 1D, 1W, 1M), default to 1D # Historical Data Response JSON Structure index Description 0 Timestamp. 1 Open. 2 High. 3 Low. 4 Close. # Code Examples Currency API supports your favorite programming languages. Here are few examples of how to connect and start getting real-time quotes: # JavaScript Fetch JQuery XHR var requestOptions = { method : ’GET’ , redirect : ’follow’ } ; fetch ( "https://api.currencyapi.io/markets?token=ACCESS_TOKEN&symbol=SYMBOL" , requestOptions ) . then ( response = response . text ( ) ) . then ( result = console . log ( result ) ) . catch ( error = console . log ( ’error’ , error ) ) ; 1 2 3 4 5 6 7 8 9 10 11 12 var settings = { "url" : "https://api.currencyapi.io/markets?token=ACCESS_TOKEN&symbol=SYMBOL" , "method" : "GET" , "timeout" : 0 , } ; $ . ajax ( settings ) . done ( function ( response ) { console . log ( response ) ; } ) ; 1 2 3 4 5 6 7 8 9 var xhr = new XMLHttpRequest ( ) ; xhr . withCredentials = true ; xhr . addEventListener ( "readystatechange" , function ( ) { if ( this . readyState === 4 ) { console . log ( this . responseText ) ; } } ) ; xhr . open ( "GET" , "https://api.currencyapi.io/markets?token=ACCESS_TOKEN&symbol=SYMBOL" ) ; xhr . send ( ) ; 1 2 3 4 5 6 7 8 9 10 11 12 # PHP cURL HTTP_Request2 pecl_http var xhr = new XMLHttpRequest ( ) ; xhr . withCredentials = true ; xhr . addEventListener ( "readystatechange" , function ( ) { if ( this . readyState === 4 ) { console . log ( this . responseText ) ; } } ) ; xhr . open ( "GET" , "https://api.currencyapi.io/markets?token=ACCESS_TOKEN&symbol=SYMBOL" ) ; xhr . send ( ) ; 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 ?php require_once ’HTTP/Request2.php’ ; $request = new HTTP_Request2 ( ) ; $request - setUrl ( ’https://api.currencyapi.io/markets?token=ACCESS_TOKEN&symbol=SYMBOL’ ) ; $request - setMethod ( HTTP_Request2 :: METHOD_GET ) ; $request - setConfig ( array ( ’follow_redirects’ = TRUE ) ) ; try { $response = $request - send ( ) ; if ( $response - getStatus ( ) == 200 ) { echo $response - getBody ( ) ; } else { echo ’Unexpected HTTP status: ’ . $response - getStatus ( ) . ’ ’ . $response - getReasonPhrase ( ) ; } } catch ( HTTP_Request2_Exception $e ) { echo ’Error: ’ . $e - getMessage ( ) ; } 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 ?php $client = new http \ Client ; $request = new http \ Client \ Request ; $request - setRequestUrl ( ’https://api.currencyapi.io/markets?token=ACCESS_TOKEN&symbol=SYMBOL’ ) ; $request - setRequestMethod ( ’GET’ ) ; $request - setOptions ( array ( ) ) ; $client - enqueue ( $request ) - send ( ) ; $response = $client - getResponse ( ) ; echo $response - getBody ( ) ; 1 2 3 4 5 6 7 8 9 10 11 12 # Python http.client Requests import http . client conn = http . client . HTTPSConnection ( "api.currencyapi.io" ) conn . request ( "GET" , "/markets?token=ACCESS_TOKEN&symbol=SYMBOL" , ) res = conn . getresponse ( ) data = res . read ( ) print ( data . decode ( "utf-8" ) ) 1 2 3 4 5 6 7 8 9 10 import requests url = "https://api.currencyapi.io/markets?token=ACCESS_TOKEN&symbol=SYMBOL" payload = { } headers = { } response = requests . request ( "GET" , url , headers = headers , data = payload ) print ( response . text ) 1 2 3 4 5 6 7 8 9 10 # PowerShell RestMethod $response = Invoke-RestMethod ’https://api.currencyapi.io/markets?token=ACCESS_TOKEN&symbol=SYMBOL’ - Method ’GET’ - Headers $headers $response | ConvertTo-Json 1 2 # cURL curl curl location request GET ’https://api.currencyapi.io/markets?token=ACCESS_TOKEN&symbol=SYMBOL’ # C# RestSharp var client = new RestClient ( "https : //api.currencyapi.io/markets?token=ACCESS_TOKEN&symbol=SYMBOL"); client . Timeout = - 1 ; var request = new RestRequest ( Method . GET ) ; IRestResponse response = client . Execute ( request ) ; Console . WriteLine ( response . Content ) ; 1 2 3 4 5 # Go (Native) Native package main import ( "fmt" "net/http" "io/ioutil" ) func main ( ) { url := "https://api.currencyapi.io/markets?token=ACCESS_TOKEN&symbol=SYMBOL" method := "GET" client := & http . Client { } req...