Where in the world do people have Inklings?

« Back to table of contents

Inkling REST API Documentation

Questions

List

GET /markets.xml?params
Retrieves a list of markets and their stocks from your site. The parameters are:

  • sort - If not set, defaults to "recent". There are two groups of sorts

Admin sorts:

  • my – these are all the markets (private or public) currently running (if you’re an admin) that haven't been cashed out yet
  • my_resolved – public/private markets that have been cashed out
  • pending – public/private markets that have been started on but not finished or they are waiting for approval to be published
  • submitted – public/private markets that have been submitted for approval
  • expired – public/private markets that have reached their end date and need to be cashed out soon

General user sorts:

  • recent – public markets or markets you’ve been invited too sorted in descending order of their "created_at" date
  • expiring – public/invited markets are sorted in ascending order of their "ends_at" date
  • active – public/invited markets are sorted in descending order of their number of positions held
  • closed – public/invited only shows markets that have been fully cashed out

Note the difference in the sorts above between the groups (my, my_resolved, pending, submitted, expired) and (recent, expiring, active, closed). The first group pulls back records that "belong" to the user or admin. If the user is an admin it includes all the markets created on the site. If the user isn't an admin, the markets pulled back are only markets they have created.

The second group pulls back records that are public or that they have been invited to. If an admin account uses the web service with the second group of sorts, they will not see private markets that they haven't been invited to.

eod-price stands for End of Day price. You can use that to tell how much the stock is up today since midnight Pacific time. 

curl -u username:password http://subdomain.inklingmarkets.com/markets.xml?sort=recent
Example of response: 

<?xml version="1.0" encoding="UTF-8"?>
<markets type="array">
  <options>
    <created-at type="datetime">2008-06-15T21:13:26-07:00</created-at>
    <description>first_market</description>
    <ends-at type="datetime">2008-06-23T21:13:26-07:00</ends-at>
    <exclusive type="boolean">true</exclusive>
    <id type="integer">1</id>
    <name>first_market</name>
    <updated-at type="datetime">2008-06-15T21:13:26-07:00</updated-at>
    <membership>
      <id type="integer">799466675</id>
    </membership>
    <stocks type="array">
      <stock>
        <created-at type="datetime">2008-06-15T21:13:26-07:00</created-at>
        <description>First stock description</description>
        <id type="integer">1</id>
        <name>First stock</name>
        <price type="integer">10</price>
        <price-before-resolution type="integer">10</price-before-resolution>
        <refunded type="boolean" nil="true"></refunded>
        <resolved-at type="datetime" nil="true"></resolved-at>
        <starting-price type="integer">10</starting-price>
        <symbol>FSD</symbol>
        <eod-price type="integer">1786</eod-price>
      </stock>
      <stock>
        <created-at type="datetime">2008-06-15T21:13:26-07:00</created-at>
        <description>Another stock description</description>
        <id type="integer">2</id>
        <name>First stock</name>
        <price type="integer">10</price>
        <price-before-resolution type="integer">10</price-before-resolution>
        <refunded type="boolean" nil="true"></refunded>
        <resolved-at type="datetime" nil="true"></resolved-at>
        <starting-price type="integer">10</starting-price>
        <symbol>FSD</symbol>
      </stock>
    </stocks>
  </options>
  <futures>
    <created-at type="datetime">2008-06-15T21:13:26-07:00</created-at>
    <description>futures_market</description>
    <ends-at type="datetime">2008-06-23T21:13:26-07:00</ends-at>
    <exclusive type="boolean" nil="true"></exclusive>
    <id type="integer">2002</id>
    <name>futures_market</name>
    <updated-at type="datetime">2008-06-15T21:13:26-07:00</updated-at>
    <membership>
      <id type="integer">799466675</id>
    </membership>
    <stocks type="array">
      <stock>
        <created-at type="datetime">2008-06-15T21:13:26-07:00</created-at>
        <description>Hunderd dollar stock description</description>
        <id type="integer">5</id>
        <name>Hundred Dollar Stock</name>
        <price type="integer">10000</price>
        <price-before-resolution type="integer">10000</price-before-resolution>
        <refunded type="boolean" nil="true"></refunded>
        <resolved-at type="datetime" nil="true"></resolved-at>
        <starting-price type="integer">10000</starting-price>
        <symbol>HDS</symbol>
      </stock>
      <stock>
        <created-at type="datetime">2008-06-15T21:13:26-07:00</created-at>
        <description>Stock with Position</description>
        <id type="integer">6</id>
        <name>Stock with Position</name>
        <price type="integer">10100</price>
        <price-before-resolution type="integer">10100</price-before-resolution>
        <refunded type="boolean" nil="true"></refunded>
        <resolved-at type="datetime" nil="true"></resolved-at>
        <starting-price type="integer">10000</starting-price>
        <symbol>SWP</symbol>
      </stock>
    </stocks>
  </futures>
</markets>

Each market question returned will be of type:

  • binary – just the answer of yes/no (e.g. Will the Sun rise tomorrow?)
  • options – has a selection of answers (e.g. Which contestant will win American Idol?)
  • numberranges – a selection of number ranges to choose from (e.g. How many Emmy Awards will Grey's Anatomy win? Possible answers: 0-1, 2-4, more than 4)
  • futures – answer to the question is a specific answer.
  • dateranges – a selection of date ranges to choose from (e.g. When will Grey's Anatomy release its fall schedule? Possible answers: June, July, August, September or later)
  • datemarket – answer is a specific date

A reference for some of the fields seen here:

  • price - current price
  • price-before-resolution - if the stock has been chased out, this was the price just before the final answer
  • refunded - true/false if this stock had to be refunded to traders
  • resolved-at - the datetime when this stock was cashed out or refunded
  • starting-price - the price that was original set for this stock to start trading at
  • exclusive - true/false. Some options markets are mutually exclusive (e.g. Which of these products will sell the most).

Show

GET /markets/:market_id.xml
Retrieves the market and stock information for a single market. Similar data is retrieved as the market list service.

eod-price stands for End of Day price. You can use that to tell how much the stock is up today since midnight Pacific time.

For example: 
curl -u username:password http://subdomain.inklingmarkets.com/markets/123.xml
Example of response: 

<?xml version="1.0" encoding="UTF-8"?>
<options>
  <created-at type="datetime">2008-06-15T21:13:26-07:00</created-at>
  <description>first_market</description>
  <ends-at type="datetime">2008-06-23T21:13:26-07:00</ends-at>
  <exclusive type="boolean">true</exclusive>
  <id type="integer">1</id>
  <name>first_market</name>
  <updated-at type="datetime">2008-06-15T21:13:26-07:00</updated-at>
  <membership>
    <id type="integer">799466675</id>
  </membership>
  <stocks type="array">
    <stock>
      <created-at type="datetime">2008-06-15T21:13:26-07:00</created-at>
      <description>First stock description</description>
      <id type="integer">1</id>
      <name>First stock</name>
      <price type="integer">10</price>
      <price-before-resolution type="integer">10</price-before-resolution>
      <refunded type="boolean" nil="true"></refunded>
      <resolved-at type="datetime" nil="true"></resolved-at>
      <starting-price type="integer">10</starting-price>
      <symbol>FSD</symbol>
      <eod-price type="integer">1786</eod-price>
    </stock>
    <stock>
      <created-at type="datetime">2008-06-15T21:13:26-07:00</created-at>
      <description>Another stock description</description>
      <id type="integer">2</id>
      <name>First stock</name>
      <price type="integer">10</price>
      <price-before-resolution type="integer">10</price-before-resolution>
      <refunded type="boolean" nil="true"></refunded>
      <resolved-at type="datetime" nil="true"></resolved-at>
      <starting-price type="integer">10</starting-price>
      <symbol>FSD</symbol>
      <eod-price type="integer">1786</eod-price>
    </stock>
  </stocks>
</options>

Create

POST /markets.xml
Creates a market. Parameters include:
  • name (required): The question you are trying to predict. Between 6 and 130 characters.
  • class-type (required):
    • Exclusive – A mutually exclusive market determining probability of something occurring. (e.g. Who will win American Idol?)
    • Futures – Determine a specific number. (e.g. How many minivans will Chrysler sell in the 4th quarter?)
  • ends-at: A date the market closes to trading. Uses 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 used as TZD. [+-]hh:mm is used otherwise.
  • tag-list
  • scale: for use in Futures (class-type)
  • description: Any background information people need to know to successfully understand the topic you are trying to forecast. Include any details about how your market will end (e.g. A source for which you’ll use to determine “How many minivans will Chrysler sell” could be a the quarterly report.)
For example: 
curl \
-u username:password \
-H 'Content-Type: application/xml' \
-d  "<market> \
  <name>Which team will win the World Series?</name> \
  <ends-at>2008-05-05T02:20:30-05:00</ends-at> \
  <class-type>Exclusive</class-type> \
  <tag-list>sports baseball</tag-list> \
</market>" \
http://subdomain.inklingmarkets.com/markets.xml
Example of response: 

Status: 201 Created
Location: http://subdomain.inklingmarkets.com/markets/:market_id.xml

<market>
  ...
</market>

Update

PUT /markets/:market_id.xml
Updates a market. For example: 
curl \
-u username:password \
-H 'Content-Type: application/xml' \
-X PUT \
-d  "<market> \
  <name>Which team will win the 2008 World Series?</name> \
</market>" \
http://subdomain.inklingmarkets.com/markets/:market_id.xml
Example of response: 

Status: 200 OK

Delete

DELETE /markets/:market_id.xml
For example: 
curl \
-u username:password \
-H 'Content-Type: application/xml' \
-X DELETE \
http://subdomain.inklingmarkets.com/markets/:market_id.xml
Example of response: 

Status: 200 OK

Publish a Market

POST /markets/:market_id/publications.xml
Publishes a market after it's all ready. If the the publisher is an admin it's available for trading immediately. If the publisher isn't an admin, an admin will need to reissue the publish API call. 
curl \
-u username:password \
-H 'Content-Type: application/xml' \
-X POST \
http://subdomain.inklingmarkets.com/markets/:market_id/publications.xml
Example of response: 

Response: 
Status: 201 Created
Location: http://subdomain.inklingmarkets.com/markets/:market_id.xml

<market>
  ...
</market>

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