Skip to main content
POST
Store borrow curves for equities.

Authorizations

Authorization
string
header
required

OAuth2 access-token requested from AWS Cognito and provided as a Auth Bearer header

Body

The upload payload. Provide either ProviderId or MarketDataEnvironmentName, not both; omitting both selects the caller's organisation scope. BorrowCurves must be non-empty. The legacy BorrowRatesByIdentifiers form is also accepted and treats its rate values as percentages, using MarketDate and UploadZeroRates.

Accepts typed equity borrow curves with per-row value dates, or legacy keyed percentage rates sharing MarketDate.

$type
enum<string>
required
Available options:
Derivitec.Web.Core.MarketData.ApiUploadBorrowCurvesRequest, Derivitec.Web.Core
market_data_environment_name
string | null

Name of the market-data environment to use. Supply either this name or provider_id, not both.

Example:

"Example market data"

provider_id
string | null

Opaque identifier of the market-data provider to use. Supply either this identifier or market_data_environment_name, not both.

borrow_curves
object[] | null

Preferred typed equity borrow-curve rows; nonempty typed rows take precedence over the legacy map.

borrow_rates_by_identifiers
object[] | null

Legacy map from asset selector to tenor/rate entries expressed as percentages; values are converted to decimals.

market_date
string<date-time>

Date-only value date shared by legacy keyed borrow rates when typed rows are absent or empty.

upload_zero_rates
boolean

Whether legacy rate inputs are interpreted as zero rather than forward rates; defaults to false.

Response

Returns whether any borrow curves were stored and errors for invalid providers, identifiers, tenors, maturities, factors, or rate vectors.

Returns the success flag and error messages from a borrow-curve upload.

$type
enum<string>
required
Available options:
Derivitec.Web.Core.MarketData.ApiUploadBorrowCurvesResponse, Derivitec.Web.Core
is_success
boolean

Whether the operation completed successfully. The default is true; error outcomes set it to false.

Example:

true

error_messages
string[] | null

Messages explaining operation-level failures. The collection is empty by default.