Favorites


GET favorites

Description

Gets the list of 'favorites' for the user. Favorites can be used to create quick links to commonly viewed data in applications.

Resource URL

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

Example Request

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

Example Response

[ "/orders", "/markets/8" ]

POST favorites

Description

Adds the specified favorite to the user's list of favorites.

Resource URL

https://api.optionscity.com/favorites
Authentication Required
HTTP Methods POST
Media Types application/json
Response Object None
Response Type Standard
Request Object String

Example Request

POST https://api.optionscity.com/favorites
"/markets/8"

Example Response

{ }

DELETE favorites/:favorite

Description

Deletes the specified favorite from the user's list of favorites.

Resource URL

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

Parameters

NameDescriptionRequired?Type
favorite The favorite to delete, URL encoded. Yes String

Example Request

DELETE https://api.optionscity.com/favorites/%2Fmarkets%2F8

Example Response

{ }

* Date and time elements are ISO-8601 string representations