Organization


Organization Object

Description

Basic information for an organization. An organization could be a brokerage, a proprietary trading firm, or an independent trader, for example.

Fields

Field Type Optional Description
id Number No The City API ID for the organization.
name String No The name given to the organization.

JSON Sample

{
  "id" : 12345,
  "unique_name" : "abcfutures",
  "name" : "ABC Futures",
  "customer_redirect_url" : "http://optionshop.com"
}

GET organizations/:id

Description

Get the details for the specified organization.

Resource URL

https://api.optionscity.com/organizations/:id
Authentication Required
HTTP Methods GET
Media Types application/json
Response Object Organization
Response Type Standard

Parameters

NameDescriptionRequired?Type
id The unique City API identifier for the organization. Yes Number

Example Request

GET https://api.optionscity.com/organizations/94857

Example Response

{
  "id" : 12345,
  "unique_name" : "abcfutures",
  "name" : "ABC Futures",
  "customer_redirect_url" : "http://optionshop.com"
}

GET organizations/:id/users

Description

Get all users for the specified organization.

Resource URL

https://api.optionscity.com/organizations/:id/users
Authentication Required
HTTP Methods GET
Media Types application/json
Response Object User
Response Type Standard

Parameters

NameDescriptionRequired?Type
id The unique City API identifier for the organization. Yes Number
page 1-indexed page to retrieve. Default is 1. No Number
per_page Number of entries returned per page. Default is 20. No Number

Example Request

GET https://api.optionscity.com/organizations/94857/users

Example Response

[ {
  "email" : "first.last@example.com",
  "first_name" : "Doug",
  "last_name" : "Kurth",
  "user_type" : "Customer",
  "trading_capacity" : 1,
  "liquidity_provision" : 1,
  "commodity_deriv_indicator" : 0,
  "investment_decision" : 2345,
  "execution_decision" : 6789,
  "trader_id" : "5678",
  "is_professional" : false,
  "id" : 12345,
  "is_active" : false
} ]

PUT organizations/:id

Description

Modify an existing organization.

Resource URL

https://api.optionscity.com/organizations/:id
Authentication Required
HTTP Methods PUT
Media Types application/json
Response Object Organizations
Response Type Standard
Request Object Organizations

Parameters

NameDescriptionRequired?Type
id The organization ID for the organization to modify. Yes Number

Example Request

PUT https://api.optionscity.com/organizations/1
{
  "unique_name" : "abcfutures",
  "name" : "ABC Futures",
  "customer_redirect_url" : "http://optionshop.com"
}

GET orginstblacklist

Description

Get the entire list of blacklisted instruments for your organization.

Resource URL

https://api.optionscity.com/orginstblacklist
Authentication Required
HTTP Methods GET
Media Types application/json
Response Object See example
Response Type Standard

Example Request

GET https://api.optionscity.com/orginstblacklist

Example Response

[ {
  "id" : 1,
  "instrument_id" : 1
} ]

POST orginstblacklist

Description

Add an instrument to your organization's instrument blacklist.

Resource URL

https://api.optionscity.com/orginstblacklist
Authentication Required
HTTP Methods POST
Media Types application/json
Response Object See example
Response Type Standard
Request Object See example

Example Request

POST https://api.optionscity.com/orginstblacklist
{
  "id" : 1,
  "instrument_id" : 1
}

Example Response

{
  "id" : 1,
  "instrument_id" : 1
}

DELETE orginstblacklist/:id

Description

Delete an instrument from your organization's instrument blacklist.

Resource URL

https://api.optionscity.com/orginstblacklist/:id
Authentication Required
HTTP Methods DELETE
Media Types application/json
Response Object None
Response Type Standard

Example Request

DELETE https://api.optionscity.com/orginstblacklist/1

GET orgprodblacklist

Description

Get the entire list of blacklisted product symbols for your organization.

Resource URL

https://api.optionscity.com/orgprodblacklist
Authentication Required
HTTP Methods GET
Media Types application/json
Response Object See example
Response Type Standard

Example Request

GET https://api.optionscity.com/orgprodblacklist

Example Response

[ {
  "id" : 1,
  "exchange" : "CME",
  "product_symbol" : "6E1"
} ]

POST orgprodblacklist

Description

Add a product symbol to your organization's product blacklist.

Resource URL

https://api.optionscity.com/orgprodblacklist
Authentication Required
HTTP Methods POST
Media Types application/json
Response Object See example
Response Type Standard
Request Object See example

Example Request

POST https://api.optionscity.com/orgprodblacklist
{
  "id" : 1,
  "exchange" : "CME",
  "product_symbol" : "6E1"
}

Example Response

{
  "id" : 1,
  "exchange" : "CME",
  "product_symbol" : "6E1"
}

DELETE orgprodblacklist/:id

Description

Delete a product symbol from your organization's product blacklist.

Resource URL

https://api.optionscity.com/orgprodblacklist/:id
Authentication Required
HTTP Methods DELETE
Media Types application/json
Response Object None
Response Type Standard

Example Request

DELETE https://api.optionscity.com/orgprodblacklist/1

GET orgmdaccess

Description

Get the market data access for one or more organizations.

Resource URL

https://api.optionscity.com/orgmdaccess
Authentication Required
HTTP Methods GET
Media Types application/json
Response Object See example
Response Type Standard

Parameters

NameDescriptionRequired?Type
org_id The specific organization ID to retrieve records for. No Number
page 1-indexed page to retrieve. Default is 1. No Number
per_page Number of entries returned per page. Default is 100. No Number

Example Request

GET https://api.optionscity.com/orgmdaccess?org_id=13

Example Response

[ {
  "id" : 45,
  "org_id" : 13,
  "group_name" : "CME"
} ]

POST orgmdaccess

Description

Adds market data access to an organization.

Resource URL

https://api.optionscity.com/orgmdaccess
Authentication Required
HTTP Methods POST
Media Types application/json
Response Object See example
Response Type Standard
Request Object See example

Example Request

POST https://api.optionscity.com/orgmdaccess
[ {
  "org_id" : 13,
  "group_name" : "CME"
} ]

Example Response

[ {
  "id" : 45,
  "org_id" : 13,
  "group_name" : "CME"
} ]

DELETE orgmdaccess/:id

Description

Removes an organization's market data access, using the internal id field of the market data access-organization pair you want to delete.

Resource URL

https://api.optionscity.com/orgmdaccess/:id
Authentication Required
HTTP Methods DELETE
Media Types application/json
Response Object None
Response Type Standard

Example Request

DELETE https://api.optionscity.com/orgmdaccess/45

* Date and time elements are ISO-8601 string representations