Prodigy Market Control REST API - Market Controller
The market/<market> URL provides management of a specific Market hosted on Prodigy.
Permission: Exchange
Retrieve market configuration
Section titled “Retrieve market configuration”GET market/<market>
Retrieves the current configuration for the market.
URL Parameters
Section titled “URL Parameters”| Parameter | Description |
|---|---|
| market | A URL-encoded Market Code. |
Query Parameters
Section titled “Query Parameters”| Parameter | Expected | Description |
|---|---|---|
| withState | Optional | True to include the market state from the cache. If omitted, defaults to False. |
Response
Section titled “Response”| Code | Status | Description |
|---|---|---|
| 200 | Success | Content is a single MarketInfo object. |
| 404 | Failure | The Market does not exist. |
| 422 | Failure | Invalid data was provided. Content is a JSON array of one or more error codes describing the problem. |
Create new market
Section titled “Create new market”POST market/<market>
Creates a new Market.
URL Parameters
Section titled “URL Parameters”| Parameter | Description |
|---|---|
| market | A URL-encoded Market Code. |
POST Body
Section titled “POST Body”A single MarketCreateBody object.
Response
Section titled “Response”| Code | Status | Description |
|---|---|---|
| 201 | Success | Operation completed successfully. Location is the newly created market. |
| 400 | Failure | Invalid or incomplete request. |
| 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 market configuration
Section titled “Update market configuration”PUT market/<market>
Updates the configuration for this market.
URL Parameters
Section titled “URL Parameters”| Parameter | Description |
|---|---|
| market | A URL-encoded Market 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 market. |
| 400 | Failure | Invalid or incomplete request. |
| 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. |
Delete market
Section titled “Delete market”DELETE market/<market>
Deletes an existing market from Prodigy. Removes all trace of the market, including historical data from the database.
URL Parameters
Section titled “URL Parameters”| Parameter | Description |
|---|---|
| market | A URL-encoded Market 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 does not exist. |
| 422 | Failure | Invalid data was provided. Content is a JSON array of one or more error codes describing the problem. |