Difference between revisions of "XcelDataAPI:Metal Feed"

From XcelData Wiki
Jump to: navigation, search
m (Charliej moved page XcelDataAPI/Metal Feed to XcelDataAPI:Metal Feed without leaving a redirect)
(URL Structure)
 
(4 intermediate revisions by 2 users not shown)
Line 1: Line 1:
 
{{InDev}}
 
{{InDev}}
  
=URL Structure=
+
=URL Structures=
  
<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==
Line 17: Line 20:
  
 
===loan-percent, buy-percent and sell-percent===
 
===loan-percent, buy-percent and sell-percent===
''integer or decimal: range between 0 and 100''
+
''integer or decimal: range between 0 and 200''
  
 
Specifies the adjustments that will be shown to tellers.
 
Specifies the adjustments that will be shown to tellers.
Line 24: Line 27:
 
''string: a valid store api key''
 
''string: a valid store api key''
  
Store API keys can bet obtained from [https://app.xceldata.com/ app.xceldata.com]
+
Store API keys can be obtained from [https://app.xceldata.com/customers app.xceldata.com/customers]
 
 
  
 
==Example of good feeds (using dev store api key)==
 
==Example of good feeds (using dev store api key)==

Latest revision as of 23:53, 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 Structures

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