Skip to content
/ContractRequestService

Aurora API (v1.23.0-rc1)

Download OpenAPI description
connectapi.json
connectapi.yaml
Overview
URL
https://provablemarkets.com/contact
Provable Markets
info@provablemarkets.com
Terms of Service
Languages
Servers
Mock server
https://developer.provablemarkets.com/_mock/apis/connectapi
https://developer.provablemarkets.com

CompanyService

Methods to query companies

Operations

OmsEventsService

Operations

OmsService

Operations

ReportingService

Operations

ContractService

Operations

ContractEventsService

Operations

AgreementService

Operations

ContractRequestEventsService

Operations

ContractRequestService

Operations

AcceptContractRequest

Request

PATH: /aurora.core.apiengine.contractrequestsv1.ContractRequestService/AcceptContractRequest

Security
Bearer
Bodyapplication/jsonrequired
commentstring
display_idstringrequired
sidestring(aurora.core.consts.common.Side)required
Enum"BORROW""LOAN"
curl -i -X POST \
  https://developer.provablemarkets.com/_mock/apis/connectapi/aurora.core.apiengine.contractrequestsv1.ContractRequestService/AcceptContractRequest \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "comment": "string",
    "display_id": "string",
    "side": "BORROW"
  }'

Responses

A successful response

Bodyapplication/json
collateral_ratestringrequired

Collateral rate of the contract

commentstring

Comment given on Accept, Decline or Cancel that is echoed back

contract_display_idstring

Human readable Id of contract resulting for this contract request action

contract_idstring

Id of contract resulting for this contract request action

counterparty_idstringrequired

Counterparty ID

display_idstringrequired

Display id (persistent contract request id inside Aurora system)

instrumentobject(aurora.core.common.protos.PbInstrument)required

Instruments can be identified by their CUSIP or Ticker Symbol
Fields: cusip, ticker, name

instrument.​cusipstringrequired

CUSIP

instrument.​namestringrequired

Security name

instrument.​tickerstringrequired

Ticker

is_pre_establishedbooleanrequired

Pre-established contract flag

quantitystring(int64)required

Quantity of shares

rate_detailsobject(aurora.core.common.protos.PbRateDetails)required

Fields: rate, benchmark

rate_details.​benchmarkstring(aurora.core.consts.benchmark.Benchmark)

possible rate benchmarks

Enum"OBFR""EFFR""SOFR""BGCR""TGCR""IORB"
rate_details.​ratestringrequired
request_idstringrequired

User populated id of the request this response is for

rounding_rulestring(aurora.core.consts.RoundingRule)required
Enum"NO_ROUNDING""UP_TO_NEAREST_0_DOT_01""UP_TO_NEAREST_0_DOT_05""UP_TO_NEAREST_0_DOT_10""UP_TO_NEAREST_0_DOT_25""UP_TO_NEAREST_1_DOT_0"
settlement_typestring(aurora.core.consts.settlement.SettlementType)required
Enum"NSCC""BILATERAL"
sidestring(aurora.core.consts.common.Side)required
Enum"BORROW""LOAN"
statusstring(aurora.core.consts.contractrequest.ContractRequestStatus)required

possible states in the lifecycle of a contract request

Enum"PENDING""ACCEPTED""REJECTED""EXPIRED""CANCELED""AUTOMATCHED"
Response
application/json
{
  "collateral_rate": "string",
  "comment": "string",
  "contract_display_id": "string",
  "contract_id": "string",
  "counterparty_id": "string",
  "display_id": "string",
  "instrument": {
    "cusip": "string",
    "name": "string",
    "ticker": "string"
  },
  "is_pre_established": true,
  "quantity": "string",
  "rate_details": {
    "benchmark": "OBFR",
    "rate": "string"
  },
  "request_id": "string",
  "rounding_rule": "NO_ROUNDING",
  "settlement_type": "NSCC",
  "side": "BORROW",
  "status": "PENDING"
}

CancelContractRequest

Request

PATH: /aurora.core.apiengine.contractrequestsv1.ContractRequestService/CancelContractRequest

Security
Bearer
Bodyapplication/jsonrequired
commentstring
display_idstringrequired
sidestring(aurora.core.consts.common.Side)required
Enum"BORROW""LOAN"
curl -i -X POST \
  https://developer.provablemarkets.com/_mock/apis/connectapi/aurora.core.apiengine.contractrequestsv1.ContractRequestService/CancelContractRequest \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "comment": "string",
    "display_id": "string",
    "side": "BORROW"
  }'

Responses

A successful response

Bodyapplication/json
collateral_ratestringrequired

Collateral rate of the contract

commentstring

Comment given on Accept, Decline or Cancel that is echoed back

contract_display_idstring

Human readable Id of contract resulting for this contract request action

contract_idstring

Id of contract resulting for this contract request action

counterparty_idstringrequired

Counterparty ID

display_idstringrequired

Display id (persistent contract request id inside Aurora system)

instrumentobject(aurora.core.common.protos.PbInstrument)required

Instruments can be identified by their CUSIP or Ticker Symbol
Fields: cusip, ticker, name

instrument.​cusipstringrequired

CUSIP

instrument.​namestringrequired

Security name

instrument.​tickerstringrequired

Ticker

is_pre_establishedbooleanrequired

Pre-established contract flag

quantitystring(int64)required

Quantity of shares

rate_detailsobject(aurora.core.common.protos.PbRateDetails)required

Fields: rate, benchmark

rate_details.​benchmarkstring(aurora.core.consts.benchmark.Benchmark)

possible rate benchmarks

Enum"OBFR""EFFR""SOFR""BGCR""TGCR""IORB"
rate_details.​ratestringrequired
request_idstringrequired

User populated id of the request this response is for

rounding_rulestring(aurora.core.consts.RoundingRule)required
Enum"NO_ROUNDING""UP_TO_NEAREST_0_DOT_01""UP_TO_NEAREST_0_DOT_05""UP_TO_NEAREST_0_DOT_10""UP_TO_NEAREST_0_DOT_25""UP_TO_NEAREST_1_DOT_0"
settlement_typestring(aurora.core.consts.settlement.SettlementType)required
Enum"NSCC""BILATERAL"
sidestring(aurora.core.consts.common.Side)required
Enum"BORROW""LOAN"
statusstring(aurora.core.consts.contractrequest.ContractRequestStatus)required

possible states in the lifecycle of a contract request

Enum"PENDING""ACCEPTED""REJECTED""EXPIRED""CANCELED""AUTOMATCHED"
Response
application/json
{
  "collateral_rate": "string",
  "comment": "string",
  "contract_display_id": "string",
  "contract_id": "string",
  "counterparty_id": "string",
  "display_id": "string",
  "instrument": {
    "cusip": "string",
    "name": "string",
    "ticker": "string"
  },
  "is_pre_established": true,
  "quantity": "string",
  "rate_details": {
    "benchmark": "OBFR",
    "rate": "string"
  },
  "request_id": "string",
  "rounding_rule": "NO_ROUNDING",
  "settlement_type": "NSCC",
  "side": "BORROW",
  "status": "PENDING"
}

DeclineContractRequest

Request

PATH: /aurora.core.apiengine.contractrequestsv1.ContractRequestService/DeclineContractRequest

Security
Bearer
Bodyapplication/jsonrequired
commentstring
display_idstringrequired
sidestring(aurora.core.consts.common.Side)required
Enum"BORROW""LOAN"
curl -i -X POST \
  https://developer.provablemarkets.com/_mock/apis/connectapi/aurora.core.apiengine.contractrequestsv1.ContractRequestService/DeclineContractRequest \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "comment": "string",
    "display_id": "string",
    "side": "BORROW"
  }'

Responses

A successful response

Bodyapplication/json
collateral_ratestringrequired

Collateral rate of the contract

commentstring

Comment given on Accept, Decline or Cancel that is echoed back

contract_display_idstring

Human readable Id of contract resulting for this contract request action

contract_idstring

Id of contract resulting for this contract request action

counterparty_idstringrequired

Counterparty ID

display_idstringrequired

Display id (persistent contract request id inside Aurora system)

instrumentobject(aurora.core.common.protos.PbInstrument)required

Instruments can be identified by their CUSIP or Ticker Symbol
Fields: cusip, ticker, name

instrument.​cusipstringrequired

CUSIP

instrument.​namestringrequired

Security name

instrument.​tickerstringrequired

Ticker

is_pre_establishedbooleanrequired

Pre-established contract flag

quantitystring(int64)required

Quantity of shares

rate_detailsobject(aurora.core.common.protos.PbRateDetails)required

Fields: rate, benchmark

rate_details.​benchmarkstring(aurora.core.consts.benchmark.Benchmark)

possible rate benchmarks

Enum"OBFR""EFFR""SOFR""BGCR""TGCR""IORB"
rate_details.​ratestringrequired
request_idstringrequired

User populated id of the request this response is for

rounding_rulestring(aurora.core.consts.RoundingRule)required
Enum"NO_ROUNDING""UP_TO_NEAREST_0_DOT_01""UP_TO_NEAREST_0_DOT_05""UP_TO_NEAREST_0_DOT_10""UP_TO_NEAREST_0_DOT_25""UP_TO_NEAREST_1_DOT_0"
settlement_typestring(aurora.core.consts.settlement.SettlementType)required
Enum"NSCC""BILATERAL"
sidestring(aurora.core.consts.common.Side)required
Enum"BORROW""LOAN"
statusstring(aurora.core.consts.contractrequest.ContractRequestStatus)required

possible states in the lifecycle of a contract request

Enum"PENDING""ACCEPTED""REJECTED""EXPIRED""CANCELED""AUTOMATCHED"
Response
application/json
{
  "collateral_rate": "string",
  "comment": "string",
  "contract_display_id": "string",
  "contract_id": "string",
  "counterparty_id": "string",
  "display_id": "string",
  "instrument": {
    "cusip": "string",
    "name": "string",
    "ticker": "string"
  },
  "is_pre_established": true,
  "quantity": "string",
  "rate_details": {
    "benchmark": "OBFR",
    "rate": "string"
  },
  "request_id": "string",
  "rounding_rule": "NO_ROUNDING",
  "settlement_type": "NSCC",
  "side": "BORROW",
  "status": "PENDING"
}

QueryContractRequests

Request

PATH: /aurora.core.apiengine.contractrequestsv1.ContractRequestService/QueryContractRequests

Security
Bearer
Bodyapplication/jsonrequired
contract_request_idstring

User populated id of a previous request - optional

counterparty_idsArray of strings

Counterparty ID - optional

instrumentstring

Instrument (CUSIP or Ticker) - optional

is_pre_establishedbooleanrequired

Preestablished contract flag

sidestring(aurora.core.consts.common.Side)
Enum"BORROW""LOAN"
curl -i -X POST \
  https://developer.provablemarkets.com/_mock/apis/connectapi/aurora.core.apiengine.contractrequestsv1.ContractRequestService/QueryContractRequests \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "contract_request_id": "string",
    "counterparty_ids": [
      "string"
    ],
    "instrument": "string",
    "is_pre_established": true,
    "side": "BORROW"
  }'

Responses

A successful response

Bodyapplication/json
contract_requestsArray of objects(aurora.core.apiengine.contractrequestsv1.ContractRequestResponse)

Details of the contract requests

number_of_contractsstring(int64)

Total number of contracts in the response

Response
application/json
{
  "contract_requests": [
    { … }
  ],
  "number_of_contracts": "string"
}

SubmitContractRequest

Request

PATH: /aurora.core.apiengine.contractrequestsv1.ContractRequestService/SubmitContractRequest

Security
Bearer
Bodyapplication/jsonrequired
collateral_ratestringrequired

Collateral rate of contract

counterparty_idstringrequired

Counterparty ID

instrumentstringrequired

Instrument (CUSIP or Ticker)

is_pre_establishedbooleanrequired

Preestablished contract flag

quantitystring(int64)required

Quantity of shares

rate_detailsobject(aurora.core.common.protos.PbRateDetails)required

Fields: rate, benchmark

rate_details.​benchmarkstring(aurora.core.consts.benchmark.Benchmark)

possible rate benchmarks

Enum"OBFR""EFFR""SOFR""BGCR""TGCR""IORB"
rate_details.​ratestringrequired
request_idstringrequired

User populated id of this request

rounding_rulestring(aurora.core.consts.RoundingRule)required
Enum"NO_ROUNDING""UP_TO_NEAREST_0_DOT_01""UP_TO_NEAREST_0_DOT_05""UP_TO_NEAREST_0_DOT_10""UP_TO_NEAREST_0_DOT_25""UP_TO_NEAREST_1_DOT_0"
settlement_typestring(aurora.core.consts.settlement.SettlementType)
Enum"NSCC""BILATERAL"
sidestring(aurora.core.consts.common.Side)required
Enum"BORROW""LOAN"
curl -i -X POST \
  https://developer.provablemarkets.com/_mock/apis/connectapi/aurora.core.apiengine.contractrequestsv1.ContractRequestService/SubmitContractRequest \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "collateral_rate": "string",
    "counterparty_id": "string",
    "instrument": "string",
    "is_pre_established": true,
    "quantity": "string",
    "rate_details": {
      "benchmark": "OBFR",
      "rate": "string"
    },
    "request_id": "string",
    "rounding_rule": "NO_ROUNDING",
    "settlement_type": "NSCC",
    "side": "BORROW"
  }'

Responses

A successful response

Bodyapplication/json
collateral_ratestringrequired

Collateral rate of the contract

commentstring

Comment given on Accept, Decline or Cancel that is echoed back

contract_display_idstring

Human readable Id of contract resulting for this contract request action

contract_idstring

Id of contract resulting for this contract request action

counterparty_idstringrequired

Counterparty ID

display_idstringrequired

Display id (persistent contract request id inside Aurora system)

instrumentobject(aurora.core.common.protos.PbInstrument)required

Instruments can be identified by their CUSIP or Ticker Symbol
Fields: cusip, ticker, name

instrument.​cusipstringrequired

CUSIP

instrument.​namestringrequired

Security name

instrument.​tickerstringrequired

Ticker

is_pre_establishedbooleanrequired

Pre-established contract flag

quantitystring(int64)required

Quantity of shares

rate_detailsobject(aurora.core.common.protos.PbRateDetails)required

Fields: rate, benchmark

rate_details.​benchmarkstring(aurora.core.consts.benchmark.Benchmark)

possible rate benchmarks

Enum"OBFR""EFFR""SOFR""BGCR""TGCR""IORB"
rate_details.​ratestringrequired
request_idstringrequired

User populated id of the request this response is for

rounding_rulestring(aurora.core.consts.RoundingRule)required
Enum"NO_ROUNDING""UP_TO_NEAREST_0_DOT_01""UP_TO_NEAREST_0_DOT_05""UP_TO_NEAREST_0_DOT_10""UP_TO_NEAREST_0_DOT_25""UP_TO_NEAREST_1_DOT_0"
settlement_typestring(aurora.core.consts.settlement.SettlementType)required
Enum"NSCC""BILATERAL"
sidestring(aurora.core.consts.common.Side)required
Enum"BORROW""LOAN"
statusstring(aurora.core.consts.contractrequest.ContractRequestStatus)required

possible states in the lifecycle of a contract request

Enum"PENDING""ACCEPTED""REJECTED""EXPIRED""CANCELED""AUTOMATCHED"
Response
application/json
{
  "collateral_rate": "string",
  "comment": "string",
  "contract_display_id": "string",
  "contract_id": "string",
  "counterparty_id": "string",
  "display_id": "string",
  "instrument": {
    "cusip": "string",
    "name": "string",
    "ticker": "string"
  },
  "is_pre_established": true,
  "quantity": "string",
  "rate_details": {
    "benchmark": "OBFR",
    "rate": "string"
  },
  "request_id": "string",
  "rounding_rule": "NO_ROUNDING",
  "settlement_type": "NSCC",
  "side": "BORROW",
  "status": "PENDING"
}

InstrumentService

Operations

ExecutionEventsService

Operations

ExecutionService

Operations

VenueEventsService

Operations

VenueService

Operations

LoginService

Operations