Scribd
Upload
102 views

XE Currency Data API Non Technical Quick Start Guide

This document provides instructions for accessing currency exchange rate data through the Xe Currency Data API via web browser requests. It describes the different types of API requests that can be made, including currencies lists, currency conversions, and historic rates. It also provides steps to build sample API request URLs, submit URLs with credentials to access results in JSON, CSV or XML format.

Uploaded by

Bertrand Marcel Ngoufack Anoumbo
Copyright
© © All Rights Reserved
We take content rights seriously. If you suspect this is your content, claim it here.
Available Formats
Download as PDF, TXT or read online on Scribd
102 views

XE Currency Data API Non Technical Quick Start Guide

This document provides instructions for accessing currency exchange rate data through the Xe Currency Data API via web browser requests. It describes the different types of API requests that can be made, including currencies lists, currency conversions, and historic rates. It also provides steps to build sample API request URLs, submit URLs with credentials to access results in JSON, CSV or XML format.

Uploaded by

Bertrand Marcel Ngoufack Anoumbo
Copyright
© © All Rights Reserved
We take content rights seriously. If you suspect this is your content, claim it here.
Available Formats
Download as PDF, TXT or read online on Scribd
You are on page 1/ 5

Xe Currency Data API

Quick Start Guide


Jan 2022

Xe Corporation
What kind of requests can I make with the API?
You can make different kinds of requests to the API. Here’s a sample:

• Currencies List - Access a list of all available currencies.


• Convert From - Convert from one base currency to one or multiple counter currencies
• Convert To - Convert to a currency amount from one or multiple other currencies.
• Historic Rate - Get historic rates for one base currency against one or more counter currencies.

How can I access the API?


There are several ways to access the API – some are more technical than others. This document details how to
access the API through your web browser. For details on how to integrate Xe Currency Data with your software,
refer to our API Specifications document located in our Help Centre; note that it is more technical in nature.

How can I access the API through my web browser?


The API can be easily accessed through your web browser. Decide on which type of request you would like to
make and the results can be returned directly in your browser. Detailed instructions can be found below.

Step 1 – Build your API Request URL


Select the request type you wish to make and build your URL. Instructions for each request type are listed below.

Request Type: Currencies List


Description: Access a list of all available currencies (without rates).
Sample URL: https://xecdapi.xe.com/v1/currencies.json/?obsolete=true


Component Description
xecdapi.xe.com This is the domain you must use to access the API
v1 This is the API version number. Our API is currently on version 1.

currencies This is the type of request you want to make.
.json/ This defines the format of your data. Supported formats are: .json, .csv, or .xml
?obsolete=true This optional parameter returns active and obsolete currencies.

Xe Corporation
Request Type: Convert From
Description: Convert from one base currency to one or multiple counter currencies.
Example: Convert 110.23 CAD to USD and GBP.
Note: Each rate returned counts as one API request towards your monthly limit.
Sample URL: https://xecdapi.xe.com/v1/convert_from.json/?from=CAD&to=USD,GBP&amount=110.23

Component Description
xecdapi.xe.com This is the domain you must use to access the API
v1 This is the API version number. API is currently on version 1.
convert_from This is the type of request you want to make.
.json/ This defines the format of your data. Supported formats are: .json, .csv, or .xml
/?from=CAD This is the base currency you want to convert an amount from.
&to=USD,GBP These are the currencies you want to convert to.
Use commas to separate multiple currencies.
&amount=110.23 This is the amount you want to convert from.

Request Type: Convert To


Description: Convert to a currency amount from multiple other currencies.
Example: Determine how much USD and EUR you need to get $1,000 CAD.
Note: Each rate returned counts as one API request towards your monthly limit.
Sample URL: https://xecdapi.xe.com/v1/convert_to.json/?to=CAD&from=USD,EUR&amount=1000

Component Description
xecdapi.xe.com This is the domain you must use to access the API
v1 This is the API version number. API is currently on version 1.
convert_to This is the type of request you want to make.
.json/ This defines the format of your data. Supported formats are: .json, .csv, or .xml
/?to=CAD This is the currency you want to convert to.
&from=USD,EUR These are the currencies you want to convert from.
Use commas to separate multiple currencies.
&amount=1000 This is the amount you want to convert to.

Xe Corporation
Request Type: Historic Rate
Description: Get the historic rate for one base currency against one or more counter currencies.
Example: Convert $150 from USD to CAD and JPY for May 5th, 2011.
Note: Each rate returned counts as one API request towards your monthly limit
Sample URL:
https://xecdapi.xe.com/v1/historic_rate.json/?from=USD&date=2011-03-05&to=CAD,JPY&amount=150

Component Description
xecdapi.xe.com This is the domain you must use to access the API
v1 This is the API version number. API is currently on version 1.
historic_rate This is the type of request you want to make.
.json/ This defines the format of your data. Supported formats are: .json, .csv, or .xml
/?from=USD This is the currency you want to convert from.
&date=2011-03-05 This is the date you want the rates as of. YYYY-MM-DD
&to=CAD,JPY These are the currencies you want to convert to.
Use commas to separate multiple currencies.
&amount=150 This is the amount you want to convert.

Step 2 – Submit your URL and API Credentials


Input your request URL into your browser and enter your credentials. Enter your Account ID into the Name field
and your API Key into the Password field. These details are provided to you when you sign up for the service.

Xe Corporation
Step 3 – Access your API Results
Results from your API request will appear in your browser. Below are sample API results in each of the
supported formats.

.json format sample:

.csv format sample:

.xml format sample:

Xe Corporation

You might also like