Get time weighted notional position

GET 
/api/v2/time-weighted-notional-position

Get the time weighted notional position for a given party and asset. The time weighted notional position is used to check if a party qualifies for a reward. If no epoch is specified, the final time weighted notional position from the end of the most recently completed epoch is returned. If an epoch is specified, the final time weighted notional position at that epoch is returned.

Request

Query Parameters

assetId string

Asset ID to filter for.

partyId string

Party ID to filter for.

gameId string

Game ID to filter for.

atEpoch uint64

Epoch to filter for.

Responses

200

A successful response.

application/json

Schema

Schema

timeWeightedNotionalPosition object

Time weighted notional position for the party and asset.

assetId string

Asset ID for the settlement asset associated with the position.

atEpoch uint64

Epoch at which the time weighted notional position is calculated.

gameId string

Game ID for the game associated with the position.

lastUpdated int64

Vega time of the block in which the last position update occurred.

partyId string

Party ID for the party associated with the position.

timeWeightedNotionalPosition string

Time weighted notional position for the party and asset.

Example (from schema)

{
  "timeWeightedNotionalPosition": {
    "assetId": "string",
    "atEpoch": "string",
    "gameId": "string",
    "lastUpdated": "string",
    "partyId": "string",
    "timeWeightedNotionalPosition": "string"
  }
}

500

An internal server error

application/json

Schema

Schema

code int32
details object[]
Array [
@type string
A URL/resource name that uniquely identifies the type of the serialized protocol buffer message. This string must contain at least one "/" character. The last segment of the URL's path must represent the fully qualified name of the type (as in path/google.protobuf.Duration). The name should be in a canonical form (e.g., leading "." is not accepted).
In practice, teams usually precompile into the binary all types that they expect it to use in the context of Any. However, for URLs which use the scheme http, https, or no scheme, one can optionally set up a type server that maps type URLs to message definitions as follows:
• If no scheme is provided, https is assumed.
• An HTTP GET on the URL must yield a [google.protobuf.Type][] value in binary format, or produce an error.
• Applications are allowed to cache lookup results based on the URL, or have them precompiled into a binary to avoid any lookup. Therefore, binary compatibility needs to be preserved on changes to types. (Use versioned type names to manage breaking changes.)
Note: this functionality is not currently available in the official protobuf release, and it is not used for type URLs beginning with type.googleapis.com.
Schemes other than http, https (or the empty scheme) might be used with implementation specific semantics.
]
message string

Example (from schema)

{
  "code": 0,
  "details": [
    {
      "@type": "string"
    }
  ],
  "message": "string"
}

default

An unexpected error response.

application/json

Schema

Schema

code int32
details object[]
Array [
@type string
A URL/resource name that uniquely identifies the type of the serialized protocol buffer message. This string must contain at least one "/" character. The last segment of the URL's path must represent the fully qualified name of the type (as in path/google.protobuf.Duration). The name should be in a canonical form (e.g., leading "." is not accepted).
In practice, teams usually precompile into the binary all types that they expect it to use in the context of Any. However, for URLs which use the scheme http, https, or no scheme, one can optionally set up a type server that maps type URLs to message definitions as follows:
• If no scheme is provided, https is assumed.
• An HTTP GET on the URL must yield a [google.protobuf.Type][] value in binary format, or produce an error.
• Applications are allowed to cache lookup results based on the URL, or have them precompiled into a binary to avoid any lookup. Therefore, binary compatibility needs to be preserved on changes to types. (Use versioned type names to manage breaking changes.)
Note: this functionality is not currently available in the official protobuf release, and it is not used for type URLs beginning with type.googleapis.com.
Schemes other than http, https (or the empty scheme) might be used with implementation specific semantics.
]
message string

Example (from schema)

{
  "code": 0,
  "details": [
    {
      "@type": "string"
    }
  ],
  "message": "string"
}

Loading...