Get stop order
GEThttps://vega-data.nodes.guru:3008/api/v2/stoporder/:orderId
Get a stop order by its ID. A stop order's ID will be the SHA3-256 hash of the signature that the order was submitted with. A stop order's ID is likely to be different from the ID of the order that will be submitted when the stop is triggered.
Request
Path Parameters
orderId stringrequired
Order ID to retrieve order information for.
Responses
- 200
- 500
- default
A successful response.
- application/json
- Schema
- Example (from schema)
Schema
order object
{
"order": {
"stopOrder": {
"createdAt": "string",
"expiresAt": "string",
"expiryStrategy": "EXPIRY_STRATEGY_UNSPECIFIED",
"id": "string",
"marketId": "string",
"ocoLinkId": "string",
"orderId": "string",
"partyId": "string",
"price": "string",
"rejectionReason": "REJECTION_REASON_UNSPECIFIED",
"sizeOverrideSetting": "SIZE_OVERRIDE_SETTING_UNSPECIFIED",
"sizeOverrideValue": {
"percentage": "string"
},
"status": "STATUS_UNSPECIFIED",
"trailingPercentOffset": "string",
"triggerDirection": "TRIGGER_DIRECTION_UNSPECIFIED",
"updatedAt": "string"
},
"submission": {
"expiresAt": "string",
"icebergOpts": {
"minimumVisibleSize": "string",
"peakSize": "string"
},
"marketId": "string",
"peggedOrder": {
"offset": "string",
"reference": "PEGGED_REFERENCE_UNSPECIFIED"
},
"postOnly": true,
"price": "string",
"reduceOnly": true,
"reference": "string",
"side": "SIDE_UNSPECIFIED",
"size": "string",
"timeInForce": "TIME_IN_FORCE_UNSPECIFIED",
"type": "TYPE_UNSPECIFIED"
}
}
}
An internal server error
- application/json
- Schema
- Example (from schema)
Schema
code int32
details object[]
message string
{
"code": 0,
"details": [
{
"@type": "string"
}
],
"message": "string"
}
An unexpected error response.
- application/json
- Schema
- Example (from schema)
Schema
code int32
details object[]
message string
{
"code": 0,
"details": [
{
"@type": "string"
}
],
"message": "string"
}
- curl
- python
- go
- nodejs
- CURL
curl -L -X GET 'https://vega-data.nodes.guru:3008/api/v2/stoporder/:orderId' \
-H 'Accept: application/json'
ResponseClear