NOnordpoolgroup

Collaterals summary

Get all collateral summaries for a time period. The collateral summary includes the collateral call, as well as its underlying collateral items and margin components.

get/api/collaterals/summary

Request

  • Base URL
    https://apiclearing.test.nordpoolgroup.com
  • URL
    https://apiclearing.test.nordpoolgroup.com/api/collaterals/summary
  • Auth
    API key in header Authorization

Query parameters

startDatestring date required

Start date of the collateral period. Expected format: yyyy-MM-dd

endDatestring date required

End date of the collateral period. Expected format: yyyy-MM-dd

Response

200

Currencystring
AvailableCollateralinteger
CollateralCallinteger
SurplusOrRequiredinteger
UpdatedTimestring
CcpCodestring
IsMonitoredBySettlementBankboolean
CollateralCallDatestring
LegalEntityCodestring
LegalEntityNamestring
OrganizationNumberstring

Example response

[
  {
    "Currency": "string",
    "UpdatedTime": "2023-04-03T10:21:33.920Z",
    "CollateralItems": [
      {
        "Type": "string",
        "ReferenceNumber": "string",
        "IssuerOrBank": "string",
        "IssuerCode": "string",
        "Currency": "string",
        "ValidFrom": "2023-04-03T10:21:33.920Z",
        "ValidTo": "2023-04-03T10:21:33.920Z",
        "CcpCode": "string",
        "LegalEntityCode": "string",
        "LegalEntityName": "string",
        "OrganizationNumber": "string"
      }
    ],
    "MarginComponents": [
      {
        "Type": "string",
        "Currency": "string",
        "RiskAccountId": "string",
        "ValidFrom": "2023-04-03T10:21:33.920Z",
        "ValidTo": "2023-04-03T10:21:33.920Z",
        "LegalEntityCode": "string",
        "LegalEntityName": "string",
        "OrganizationNumber": "string"
      }
    ],
    "CcpCode": "string",
    "IsMonitoredBySettlementBank": true,
    "CollateralCallDate": "2023-04-03T10:21:33.920Z",
    "LegalEntityCode": "string",
    "LegalEntityName": "string",
    "OrganizationNumber": "string"
  }
]

Changes

No recorded changes to this operation across all 1 revision of this API.