GET
/
v2
/
markets
/
{marketId}
Get a market
curl --request GET \
  --url https://rest.forestreet.com/v2/markets/{marketId} \
  --header 'x-api-key: <api-key>'
{
  "data": {
    "id": 123,
    "name": "<string>",
    "description": "<string>",
    "headerImage": "<string>",
    "status": "<string>",
    "isEditable": true,
    "isArchived": true,
    "createdAt": "<string>",
    "updatedAt": "<string>"
  }
}

Authorizations

​
x-api-key
string
header
required

Pass a static API key for every request, provided by your customer support.

Path Parameters

​
marketId
integer
required

ID of the specific market.

Required range: x > 0

Response

200 - application/json

GET a market in collection response

The response is of type object.