Difference between revisions of "XcelDataAPI:Metal Feed"

From XcelData Wiki
Jump to: navigation, search
(loan-percent, buy-percent and sell-percent)
(URL Structure)
Line 3: Line 3:
 
=URL Structure=
 
=URL Structure=
  
<nowiki>https://api.xceldata.com/0.1/metal-feed/[output-format]/[unit-type]/[loan-percent]/[buy-percent]/[sell-percent]/[apikey]</nowiki>
+
v0.1: <nowiki>https://api.xceldata.com/0.1/metal-feed/[output-format]/[unit-type]/[loan-percent]/[buy-percent]/[sell-percent]/[apikey]</nowiki>
 +
 
 +
v0.2: <nowiki>https://api.xceldata.com/0.2/[output-format]/[apikey]/metal-feed/[unit-type]/[loan-percent]/[buy-percent]/[sell-percent]</nowiki>
 +
* v0.2 - Changed the order of arguments to standardize output-format/apikey, which ensure the key is being properly honored via an in-line lazy service, plus the output formatting code only happens in one place.
  
 
==URL Variable Breakdown==
 
==URL Variable Breakdown==

Revision as of 23:52, 24 April 2018

This article documents features that are still in development.

Information may change rapidly as the event progresses, or if requirements change. The last updates to this article may not reflect the most current information.


URL Structure

v0.1: https://api.xceldata.com/0.1/metal-feed/[output-format]/[unit-type]/[loan-percent]/[buy-percent]/[sell-percent]/[apikey]

v0.2: https://api.xceldata.com/0.2/[output-format]/[apikey]/metal-feed/[unit-type]/[loan-percent]/[buy-percent]/[sell-percent]

  • v0.2 - Changed the order of arguments to standardize output-format/apikey, which ensure the key is being properly honored via an in-line lazy service, plus the output formatting code only happens in one place.

URL Variable Breakdown

output-format

string: xml or json

Specifies XML or JSON output.

unit-type

string: dwt or gr

Specifies Pennyweight or Grams

loan-percent, buy-percent and sell-percent

integer or decimal: range between 0 and 200

Specifies the adjustments that will be shown to tellers.

api-key

string: a valid store api key

Store API keys can be obtained from app.xceldata.com/customers

Example of good feeds (using dev store api key)

https://api.xceldata.com/0.1/metal-feed/xml/dwt/60/80/150/1E17162A-8355-4FF2-8DCD-E5CEE676FD93

https://api.xceldata.com/0.1/metal-feed/xml/gr/60/80/150/1E17162A-8355-4FF2-8DCD-E5CEE676FD93

https://api.xceldata.com/0.1/metal-feed/json/dwt/60/80/150/1E17162A-8355-4FF2-8DCD-E5CEE676FD93

https://api.xceldata.com/0.1/metal-feed/json/gr/60/80/150/1E17162A-8355-4FF2-8DCD-E5CEE676FD93