Skip to content
/
ContractRequestEventsServ...

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

ContractRequestAccepted

Request

PATH: /aurora.core.apiengine.contractrequestsv1.ContractRequestEventsService/ContractRequestAccepted

Security
Bearer
Bodyapplication/jsonrequired
display_idstringrequired

Display id (persistent contract request id inside Aurora system)

request_idstringrequired

User populated id of the request this response is for

statusstring(aurora.core.consts.contractrequest.ContractRequestStatus)required

possible states in the lifecycle of a contract request

Enum"PENDING""ACCEPTED""REJECTED""EXPIRED""CANCELED""AUTOMATCHED"
curl -i -X POST \
  https://developer.provablemarkets.com/_mock/apis/connectapi/aurora.core.apiengine.contractrequestsv1.ContractRequestEventsService/ContractRequestAccepted \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "display_id": "string",
    "request_id": "string",
    "status": "PENDING"
  }'

Responses

A successful response

Bodyapplication/json
object(google.protobuf.Empty)

A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance:

service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }

Response
application/json
{}

ContractRequestCanceled

Request

PATH: /aurora.core.apiengine.contractrequestsv1.ContractRequestEventsService/ContractRequestCanceled

Security
Bearer
Bodyapplication/jsonrequired
display_idstringrequired

Display id (persistent contract request id inside Aurora system)

request_idstringrequired

User populated id of the request this response is for

statusstring(aurora.core.consts.contractrequest.ContractRequestStatus)required

possible states in the lifecycle of a contract request

Enum"PENDING""ACCEPTED""REJECTED""EXPIRED""CANCELED""AUTOMATCHED"
curl -i -X POST \
  https://developer.provablemarkets.com/_mock/apis/connectapi/aurora.core.apiengine.contractrequestsv1.ContractRequestEventsService/ContractRequestCanceled \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "display_id": "string",
    "request_id": "string",
    "status": "PENDING"
  }'

Responses

A successful response

Bodyapplication/json
object(google.protobuf.Empty)

A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance:

service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }

Response
application/json
{}

ContractRequestDeclined

Request

PATH: /aurora.core.apiengine.contractrequestsv1.ContractRequestEventsService/ContractRequestDeclined

Security
Bearer
Bodyapplication/jsonrequired
display_idstringrequired

Display id (persistent contract request id inside Aurora system)

request_idstringrequired

User populated id of the request this response is for

statusstring(aurora.core.consts.contractrequest.ContractRequestStatus)required

possible states in the lifecycle of a contract request

Enum"PENDING""ACCEPTED""REJECTED""EXPIRED""CANCELED""AUTOMATCHED"
curl -i -X POST \
  https://developer.provablemarkets.com/_mock/apis/connectapi/aurora.core.apiengine.contractrequestsv1.ContractRequestEventsService/ContractRequestDeclined \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "display_id": "string",
    "request_id": "string",
    "status": "PENDING"
  }'

Responses

A successful response

Bodyapplication/json
object(google.protobuf.Empty)

A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance:

service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }

Response
application/json
{}

ContractRequestOpened

Request

PATH: /aurora.core.apiengine.contractrequestsv1.ContractRequestEventsService/ContractRequestOpened

Security
Bearer
Bodyapplication/jsonrequired
contract_requestobject(aurora.core.apiengine.contractrequestsv1.ContractRequestResponse)required

Fields: request_id, side, counterparty_id, quantity, rounding_rule, display_id, status, comment, rate_details, collateral_rate, instrument, contract_id, contract_display_id, is_pre_established, settlement_type

contract_request.​collateral_ratestringrequired

Collateral rate of the contract

contract_request.​commentstring

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

contract_request.​contract_display_idstring

Human readable Id of contract resulting for this contract request action

contract_request.​contract_idstring

Id of contract resulting for this contract request action

contract_request.​counterparty_idstringrequired

Counterparty ID

contract_request.​display_idstringrequired

Display id (persistent contract request id inside Aurora system)

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

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

contract_request.​instrument.​cusipstringrequired

CUSIP

contract_request.​instrument.​namestringrequired

Security name

contract_request.​instrument.​tickerstringrequired

Ticker

contract_request.​is_pre_establishedbooleanrequired

Pre-established contract flag

contract_request.​quantitystring(int64)required

Quantity of shares

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

Fields: rate, benchmark

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

possible rate benchmarks

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

User populated id of the request this response is for

contract_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"
contract_request.​settlement_typestring(aurora.core.consts.settlement.SettlementType)required
Enum"NSCC""BILATERAL"
contract_request.​sidestring(aurora.core.consts.common.Side)required
Enum"BORROW""LOAN"
contract_request.​statusstring(aurora.core.consts.contractrequest.ContractRequestStatus)required

possible states in the lifecycle of a contract request

Enum"PENDING""ACCEPTED""REJECTED""EXPIRED""CANCELED""AUTOMATCHED"
request_idstringrequired

User populated id of the request this response is for

curl -i -X POST \
  https://developer.provablemarkets.com/_mock/apis/connectapi/aurora.core.apiengine.contractrequestsv1.ContractRequestEventsService/ContractRequestOpened \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "contract_request": {
      "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"
    },
    "request_id": "string"
  }'

Responses

A successful response

Bodyapplication/json
object(google.protobuf.Empty)

A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance:

service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }

Response
application/json
{}

ContractRequestService

Operations

InstrumentService

Operations

ExecutionEventsService

Operations

ExecutionService

Operations

VenueEventsService

Operations

VenueService

Operations

LoginService

Operations