Search retirements

Searches for all retirements for given program and/or between given date range

SecuritybearerToken

Request

path Parameters

AccountIdentifier

required

string

Account identifier

Example: 098B0A25

query Parameters

include

string

Comma-separated values from optional response fields

Request Body schema: application/json
required

program	string (ProgramCode) Enum: "NEPOOL" "M_RETS" "NAR" "ERCOT" "PJM" "MIRECS" "NCRETS" "NYGATS" "IREC" "TIGR" "CAR" "VCS" "ACR" "CERCARBONO" "RMS"
lastUpdatedDateFrom	string <date-time>
lastUpdatedDateTo	string <date-time>
externalIdentifier	string

Responses

200

Retirements

400

Bad Request

401

Not authorized error

404

Not found

500

Internal server error

post/retirements/account/{AccountIdentifier}/action/search

Request samples

Payload

application/json

{"program": "NEPOOL",
"lastUpdatedDateFrom": "2019-08-24T14:15:22Z",
"lastUpdatedDateTo": "2019-08-24T14:15:22Z",
"externalIdentifier": "string"
}

Response samples

application/json

{"retirements": [{"instrument": {"id": 0,
"ein": "string",
"description": "string",
"program": "NEPOOL",
"vintage": {"year": 0,
"month": 0
},
"markets": [{"market": {"name": "string",
"apiCode": "string",
"applicableExecutionVenues": [null
],
"applicablePrograms": [null
]
},
"marketModelInstrument": {"ein": "string",
"description": "string",
"price": {"amount": null,
"currency": null,
"lastUpdatedDate": null
}
}
}
],
"type": ["REC",
"CARBON"
],
"creditType": "string"
},
"lastUpdatedDate": "2019-08-24T14:15:22Z",
"createdDate": "2019-08-24T14:15:22Z",
"quantity": 0,
"status": "NEW",
"batchIdentifier": "string",
"identifier": "string",
"externalIdentifier": "string",
"registryTransferIdentifier": "string",
"registryPositionId": "string",
"attributes": { }
}
]
}

Search retirements

path Parameters

query Parameters

Request Body schema: application/jsonrequired

Request Body schema: application/json
required