Data Feed
The Data Feed service consists of a RESTful API that
gives access to exchange rate information
data. The data format
(XML, CSV, JSON, etc.) and content options
(base unit, language for currency names, additional properties, etc.) are
indicated by setting query fields in the access URL. In addition to the HTTP(S)
service, an FTP write option is
available upon request.
The general access format is:
https://fx.currencysystem.com/v5/?arguments
For example:
https://fx.currencysystem.com/v5/?licensekey=1234&format=XML
The supported arguments are:
- LicenseKey: Data Feed service subscription license key (this is the only required argument)
- Format: XML, INI, JSON, JSONP, TSV, CSV (default is INI)
- BaseCurrency: EUR, USD or any other supported currency (default is EUR)
- CurrencyNames: Boolean value indicating whether the output should include
currency names (default is True)
- CurrencySymbols: Boolean value indicating whether the output should include
currency symbols (default is False)
- CountryNames: String value indicating whether the output should
include country names. Possible values: False (default), Official (for
extended official names) or Short (commonly used short names)
- SmallestUnit: Boolean value indicating whether the output should include
the smallest unit for each currency (default is False)
- Regime: Boolean value indicating whether the output should include the
regime identifier for each currency (default is False)
- Language: Language for currency names (EN for English, default)
- TitleStyle: Boolean value indicating whether title style capitalization should be used in
the currency names (default is True)
- DateOnly: Boolean value indicating whether the time stamps should include
only the date (no time, while the default is date and time)
- Date: Reserved for future use (currently must be omitted or be set to an
empty value)
- Type: Reserved for future use (currently must be omitted or be set to an
empty value)
- Unique: Ignored as a feed option, but may be used to insert a
unique (sequential or random) portion to minimize possible caching by
intermediate proxy servers (which may otherwise serve a copy of previous
data)
Multiple semicolon-separated BaseCurrency values are allowed, in which case
the result will include additional cross-rate combinations. The arguments match equivalent options in the
managed Web Service, where the interface is documented in more
detail.
A yearly
subscription to the managed Data Feed for up to 50 accesses/day can be activated in the
Purchase section. Fetching the entire set of rates
counts as a single access. For more information:
For additional implementation procedures please refer
to the Quality Checklist. |
