List funding period data points

GET 
/api/v2/funding-periods/data-points/:marketId

Get a list of data points for a perpetual market's funding periods.

Request

Path Parameters

marketId stringrequired

Market ID to get funding period data points for.

Query Parameters

dateRange.startTimestamp int64

Timestamp in Unix nanoseconds indicating the start of the date range.

dateRange.endTimestamp int64

Timestamp in Unix nanoseconds indicating the end of the date range.

source string
Possible values: [SOURCE_UNSPECIFIED, SOURCE_EXTERNAL, SOURCE_INTERNAL]
Default value: SOURCE_UNSPECIFIED
Restrict the data points to those with the given source type.
• SOURCE_UNSPECIFIED: Default value
• SOURCE_EXTERNAL: Data point is from an external data source, such as an oracle, and represents the spot price of the underlying asset.
• SOURCE_INTERNAL: Data point from within Vega such as the mark price after performing mark-to-market.
seq uint64

Restrict the data points to those that contributed to the given funding period sequence.

pagination.first int32

Number of records to be returned that sort greater than row identified by cursor supplied in 'after'.

pagination.after string

If paging forwards, the cursor string for the last row of the previous page.

pagination.last int32

Number of records to be returned that sort less than row identified by cursor supplied in 'before'.

pagination.before string

If paging forwards, the cursor string for the first row of the previous page.

pagination.newestFirst boolean

Whether to order the results with the newest records first. If not set, the default value is true.

Responses

200

A successful response.

application/json

Schema

Schema

fundingPeriodDataPoints object

Page of funding period data points and corresponding page information.

edges object[]

Page of funding period data points and their corresponding cursors.

Array [

cursor string

Cursor that can be used to fetch further pages.

node object

Funding period data point.

dataPointType FundingPeriodDataPointSource (string)

Possible values: [SOURCE_UNSPECIFIED, SOURCE_EXTERNAL, SOURCE_INTERNAL]

Default value: SOURCE_UNSPECIFIED

Origin of the data point.

marketId string

Market ID which the data point relates to.

price string

Price of the asset as seen by this data point.

seq uint64

Sequence number of the funding period this data point belongs to.

timestamp int64

Timestamp in Unix nanoseconds of when the data point was received.

twap string

The TWAP for this source with this data-point added.

]

pageInfo object

Page information that is used for fetching further pages.

endCursor string

End cursor.

hasNextPage boolean

Indicator if there is a next page.

hasPreviousPage boolean

Indicator if there is a previous page.

startCursor string

Start cursor.

Example (from schema)

{
  "fundingPeriodDataPoints": {
    "edges": [
      {
        "cursor": "string",
        "node": {
          "dataPointType": "SOURCE_UNSPECIFIED",
          "marketId": "string",
          "price": "string",
          "seq": "string",
          "timestamp": "string",
          "twap": "string"
        }
      }
    ],
    "pageInfo": {
      "endCursor": "string",
      "hasNextPage": true,
      "hasPreviousPage": true,
      "startCursor": "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...