Where in the world do people have Inklings?

« Back to table of contents

REST API Documentation

Memberships

Create

POST /memberships.xml
Creates a user for your site. Need to be an admin of the site to use this service. Parameters include:
  • login
  • email
  • first_name
  • last_name
  • password
  • openid_url
  • email_new_market_alerts: If set to true, users get an email alert when new markets are created.
The request xml can look like: 
<membership> 
  <login>new_user</login> 
  <password>somepassword</password> 
  <email>new_user@yahoo.com</email> 
  <first-name>Joe</first-name>
  <last-name>Smith</last-name>
</membership>
First and last name are optional. For example: 
curl \
-u username:password \
-H 'Content-Type: application/xml' \
-X POST \
-d "
<membership> 
  <login>new_user</login> 
  <password>somepassword</password> 
  <email>new_user@yahoo.com</email> 
</membership>" http://subdomain.inklingmarkets.com/memberships.xml
Example of response: 

<?xml version="1.0" encoding="UTF-8"?>
<membership>
  <id type="integer">90103</id>
</membership>

Store this membership ID for single sign on and other reporting/user management needs. Here is a list of current errors returned and their definitions:

  • Alias has already been taken. - When the user you are trying to create already exists at the Inkling site.
  • Email is not properly formatted. - An invalid email, either the wrong length, none supplied, or no @ sign.
  • Email has already been registered. - User already has a trading membership at this site.

Show

GET /memberships/:membership_id.xml
Retrieves information on a single user. An available balance is returned which is the users balance minus any risk the user has with short positions they own. For example: 
curl -u username:password http://subdomain.inklingmarkets.com/memberships/123.xml
Example of response: 


<?xml version="1.0" encoding="UTF-8"?>
<membership>
  <id type="integer">965195095</id>
  <portfolio type="integer">250</portfolio>
  <worth type="integer">5000250</worth>
  <available-balance type="integer">4500000</available-balance>
  <user>
    <active type="boolean">true</active>
    <email>test_trader@example.com</email>
    <first-name>Mr.</first-name>
    <last-name>Trade</last-name>
    <login>trader</login>
  </user>
  <balance type="integer">5000000</balance>
</membership>

Me

GET /memberships/me.xml
Retrieves information on the current signed in user. An available balance is returned which is the users balance minus any risk the user has with short positions they own. For example: 
curl -u username:password http://subdomain.inklingmarkets.com/memberships/me.xml
Example of response: 


<?xml version="1.0" encoding="UTF-8"?>
<membership>
  <id type="integer">965195095</id>
  <portfolio type="integer">250</portfolio>
  <worth type="integer">5000250</worth>
  <available-balance type="integer">4500000</available-balance>
  <user>
    <active type="boolean">true</active>
    <email>test_trader@example.com</email>
    <first-name>Mr.</first-name>
    <last-name>Trade</last-name>
    <login>trader</login>
  </user>
  <balance type="integer">5000000</balance>
</membership>

Update

PUT /memberships/:membership_id.xml
Updates a previously created user. You must be using an admin account in order to change the information of someone that isn't you. For example: 
curl \
-u user:password \
-H 'Content-Type: application/xml' \
-X PUT \
-d  "<membership> \
  <first-name>Joe</first-name>
  <last-name>Somebody</last-name>
</membership>" \
http://subdomain.inklingmarkets.com/memberships/:membership_id.xml
Example of response: 

Status: 200 OK

List

GET /memberships.xml
You can obtain a list of the memberships at your site and their balance and portfolio. For example: 
curl -u username:password http://subdomain.inklingmarkets.com/memberships.xml
Example of response: 


<?xml version="1.0" encoding="UTF-8"?>
<memberships type="array">
  <membership>
    <id type="integer">965195095</id>
    <user>
      <active type="boolean">true</active>
      <email>test_trader@example.com</email>
      <first-name>Mr.</first-name>
      <last-name>Trade</last-name>
      <login>trader</login>
    </user>
    <balance type="integer">5000000</balance>
    <portfolio type="integer">4400000</portfolio>
  </membership>
  <membership>
    <id type="integer">900692218</id>
    <user>
      <active type="boolean">true</active>
      <email>test_trader2@example.com</email>
      <first-name>Mr.</first-name>
      <last-name>Trade2</last-name>
      <login>trader2</login>
    </user>
    <balance type="integer">5000000</balance>
    <portfolio type="integer">4500000</portfolio>
  </membership>
</memberships>

Delete

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

Status: 200 OK

Update user's balance

PUT /memberships/:membership_id/balance.xml
Update a user's balance. Every now and then you might decide to give another player more money. You must be using an admin account in order to change the information of someone that isn't you. For example, to reset the user's balance to $5,000: 
curl \
-u user:password \
-H 'Content-Type: application/xml' \
-X PUT \
-d  "<balance> \
  <value>500000</value>
</balance>" \
http://subdomain.inklingmarkets.com/memberships/:membership_id/balance.xml
Example of response: 

Status: 200 Ok

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