Prodigy Market Control REST API - Symbol Controller
The market/<market>/symbol/<code> URL provides management of an individual symbol listed on a Market.
Permission: Symbol
Retrieve symbol configuration and state
Section titled “Retrieve symbol configuration and state”GET market/<market>/symbol/<code>
Retrieves the configuration and market state of the symbol.
URL Parameters
Section titled “URL Parameters”| Parameter | Description |
|---|---|
| market | A URL-encoded Market Code. |
| code | A URL-encoded Symbol Code. |
Query Parameters
Section titled “Query Parameters”| Parameter | Expected | Description |
|---|---|---|
| withState | Optional | True to include the symbol state from the cache. If omitted, defaults to False. |
Response
Section titled “Response”| Code | Status | Description |
|---|---|---|
| 200 | Success | Content is a single SymbolInfo object. |
| 404 | Failure | The Market or Symbol does not exist. |
List new symbol
Section titled “List new symbol”POST market/<market>/symbol/<code>
Lists a new Symbol on the Market.
URL Parameters
Section titled “URL Parameters”| Parameter | Description |
|---|---|
| market | A URL-encoded Market Code. |
| code | A URL-encoded Symbol Code. |
POST Body
Section titled “POST Body”A single MarketBody object.
Response
Section titled “Response”| Code | Status | Description |
|---|---|---|
| 201 | Success | Operation completed successfully. Location is the newly updated symbol. |
| 400 | Failure | Invalid or incomplete request. |
| 404 | Failure | The Market does not exist. |
| 409 | Failure | The Market already exists. |
| 422 | Failure | Invalid data was provided. Content is a JSON array of one or more error codes describing the problem. |
Update symbol configuration
Section titled “Update symbol configuration”PUT market/<market>/symbol/<code>
Updates the configuration of the Symbol.
URL Parameters
Section titled “URL Parameters”| Parameter | Description |
|---|---|
| market | A URL-encoded Market Code. |
| code | A URL-encoded Symbol Code. |
PUT Body
Section titled “PUT Body”A single MarketBody object.
Response
Section titled “Response”| Code | Status | Description |
|---|---|---|
| 201 | Success | Operation completed successfully. Location is the newly updated symbol. |
| 400 | Failure | Invalid or incomplete request. |
| 404 | Failure | The Market or Symbol does not exist. |
| 422 | Failure | Invalid data was provided. Content is a JSON array of one or more error codes describing the problem. |
Unlist symbol
Section titled “Unlist symbol”DELETE market/<market>/symbol/<code>
Unlists the Symbol from the Market.
URL Parameters
Section titled “URL Parameters”| Parameter | Description |
|---|---|
| market | A URL-encoded Market Code. |
| code | A URL-encoded Symbol Code. |
Response
Section titled “Response”| Code | Status | Description |
|---|---|---|
| 200 | Success | Content is a single string communicating the result of the operation (typically: Removed). |
| 404 | Failure | The Market or Symbol does not exist. |
| 422 | Failure | Invalid data was provided. Content is a JSON array of one or more error codes describing the problem. |