Skip to main content
GET
cURL

Authorizations

Authorization
string
header
required

Basic authentication using the partner API keys from https://console.grainfinance.co/keys

Path Parameters

customerId
string<uuid>
required

The id of the customer within the Grain platform.

Pattern: [0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-4[0-9A-Fa-f]{3}-[89ABab][0-9A-Fa-f]{3}-[0-9A-Fa-f]{12}

Query Parameters

page
number<double>

Page number indicating which set of items to return The page indicating which set of items are returned

Required range: x >= 1
per_page
number<double>

number of items in a page

Required range: 1 <= x <= 100
issued_at
string

Creation date filter - only dual hedges created on this date will be returned. Format: YYYY-MM-DD

updated_at
string

Update date filter - only dual hedges updated on this date will be returned. Format: YYYY-MM-DD

Response

Dual Hedges List for Customer

dualHedges
object[]
required

A list of hedges matching the search criteria.

pagination
object
required

Pagination parameters of the returned results.