Where in the world do people have Inklings?

« Back to table of contents

REST API Documentation

Prices

List

GET /prices.xml?params
To retrieve a delta of changes to all stock prices. The url to this service takes these parameters:
  • "from" - the datetime which this price history should begin
  • "to" - the datetime at which this price history should conclude
The "datetime" is an HTML escaped form of the xmlschema format (CCYY-MM-DDThh:mm:ssTZD) of a date. Where TZD is Z or [+-]hh:mm. If self is a UTC time, Z is If you are pulling all the price changes on your site for a given period you would use the following url: 
http://subdomain.example.com/prices.xml?
from=2006-08-08T00%3A00%3A00-07%3A00&to=2006-08-08T08%3A14%3A43-07%3A00
However, if you'd just like the price changes in this time perdiod for a single market you are interested you'd use this url 
http://subdomain.example.com/markets/:market_id/prices.xml?
from=2006-08-08T00%3A00%3A00-07%3A00&to=2006-08-08T08%3A14%3A43-07%3A00
And to narrow it down even more, to get the price changes in this period for a single stock: 
http://subdomain.example.com/stocks/:stock_id/prices.xml?
from=2006-08-08T00%3A00%3A00-07%3A00&to=2006-08-08T08%3A14%3A43-07%3A00
For example: 
curl -u username:password http://subdomain.example.com/prices.xml?
from=2006-08-08T00%3A00%3A00-07%3A00&to=2006-08-08T08%3A14%3A43-07%3A00
Example of response: 

<?xml version="1.0" encoding="UTF-8"?>
<prices type="array">
  <price>
    <created-at type="datetime">2008-06-16T10:02:33-07:00</created-at>
    <value type="integer">4000</value>
    <stock><id type="integer">10</id></stock>  
  </price>
  <price>
    <created-at type="datetime">2008-06-16T10:02:33-07:00</created-at>
    <value type="integer">6000</value>
    <stock><id type="integer">9</id></stock>  
  </price>
  <price>
    <created-at type="datetime">2008-06-10T10:02:33-07:00</created-at>
    <value type="integer">5000</value>
    <stock><id type="integer">10</id></stock>  
  </price>
  <price>
    <created-at type="datetime">2008-06-09T10:02:33-07:00</created-at>
    <value type="integer">5000</value>
    <stock><id type="integer">9</id></stock>  
  </price>
</prices>

It should be noted that these price changes aren't enough to create to create the typical "price graph" just by plotting the data returned, since you still have to extrapolate the prices of the stocks at the time periods you are specifically interested. For example, if you are looking at Stock XYZ, if there hasn't been a stock price change reported from this service since 2 months ago for Stock XYZ then you can extrapolate that the price on every day since 2 months ago is still at that same price.

In other words, you can assume that the latest price returned from this service is the most current price.

Designed and built in Chicago, Illinois.
© Inkling Incorporated 2012

Facebook_chicklet_large   Twitter_chicklet_large

contact@inklingmarkets.com

+1 312 376 8129

blog.inklingmarkets.com