Skip to content

Aurora API (v1.23.0-rc1)

Download OpenAPI description
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

InstrumentService

Operations

ExecutionEventsService

Operations

Execution

Request

PATH: /aurora.core.apiengine.executionsv1.ExecutionEventsService/Execution

Security
Bearer
Bodyapplication/jsonrequired
executionobject(aurora.core.apiengine.executionsv1.Execution)required

Fields: id, order_id, instrument, side, counterparty_id, execution_quantity, unit_price, settlement_price, collateral_price, fee, rebate, settlement_amount, contract_value, start_date, execution_time, trade_date, settlement_date, is_acknowledged, status, contra_status, cancel_reason, updated_at, order_created_by, order_last_updated_by, agreement

execution.​agreementobject(aurora.core.apiengine.agreementsv1.Agreement)required

Fields: id, short_name, side, counterparty_id, settlement_type, rounding_rule, collateral_rate, status, proposer_user, proposed_by_side, responder_user, version, collateral_type, pricing_currency, billing_currency, collateral_currency, collateral_method, dividend_required, term_type, term_start_date, term_end_date, balance_target, balance_target_variance, rwa_bucket, settlement_system, created_at, approved_at, booking_account, counterparty_booking_account, trade_type, profit_center, delivery_type

execution.​agreement.​approved_atstring

Datetime that agreement was approved by the second party - time in RFC3339 with millisecond precision

execution.​agreement.​balance_targetstring
execution.​agreement.​balance_target_variancestring
execution.​agreement.​billing_currencystring(aurora.core.common.protos.Currency)required
Enum"USD""CAD""GBP""EUR""JPY"
execution.​agreement.​booking_accountstring
execution.​agreement.​collateral_currencystring(aurora.core.common.protos.Currency)
Enum"USD""CAD""GBP""EUR""JPY"
execution.​agreement.​collateral_methodstring(aurora.core.consts.agreements.CollateralMethod)required
Enum"COLLATERAL_METHOD_UNSPECIFIED""PLEDGE""TITLE_TRANSFER"
execution.​agreement.​collateral_ratestringrequired

Collateral Rate

execution.​agreement.​collateral_typestring(aurora.core.consts.agreements.CollateralType)required
Enum"COLLATERAL_TYPE_UNSPECIFIED""CASH""NON_CASH_UST""NON_CASH_EQ""NON_CASH_JGB"
execution.​agreement.​counterparty_booking_accountstring
execution.​agreement.​counterparty_idstringrequired

The Provable assigned company_id of the counterparty in the agreement

execution.​agreement.​created_atstringrequired

Datetime that agreement was initially created - time in RFC3339 with millisecond precision

execution.​agreement.​delivery_typestring(aurora.core.consts.agreements.DeliveryType)required
Enum"DELIVERY_TYPE_UNSPECIFIED""DVP""FOP"
execution.​agreement.​dividend_requiredstringrequired
execution.​agreement.​idstringrequired

A unique reference for the agreement assigned by Provable Markets

execution.​agreement.​pricing_currencystring(aurora.core.common.protos.Currency)required
Enum"USD""CAD""GBP""EUR""JPY"
execution.​agreement.​profit_centerstring
execution.​agreement.​proposed_by_sidestring(aurora.core.consts.common.Side)required
Enum"BORROW""LOAN"
execution.​agreement.​proposer_userstringrequired

The user who initially created the agreement

execution.​agreement.​responder_userstring

The user who approved or rejected the agreement

execution.​agreement.​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"
execution.​agreement.​rwa_bucketstring
execution.​agreement.​settlement_systemstring(aurora.core.consts.agreements.SettlementSystem)
Enum"SETTLEMENT_SYSTEM_UNSPECIFIED""PROVABLE_MARKET""LOANET""LOANET_SFT""SPIRE""PROP"
execution.​agreement.​settlement_typestring(aurora.core.consts.settlement.SettlementType)required
Enum"NSCC""BILATERAL"
execution.​agreement.​short_namestringrequired

The short name your company has assigned to this agreement

execution.​agreement.​sidestring(aurora.core.consts.common.Side)required
Enum"BORROW""LOAN"
execution.​agreement.​statusstring(aurora.core.consts.agreements.AgreementStatus)required

possible agreement status

Enum"AGREEMENT_STATUS_UNSPECIFIED""DRAFT""ACTIVE""REJECTED""CANCELED""INACTIVE"
execution.​agreement.​term_end_datestring
execution.​agreement.​term_start_datestring
execution.​agreement.​term_typestring(aurora.core.consts.agreements.TermType)required
Enum"TERM_TYPE_UNSPECIFIED""NONE""FIXED""EVERGREEN""ONE_DAY""BULLET"
execution.​agreement.​trade_typestring
execution.​agreement.​versionstring(int64)required

After modifications are accepted, the sequential count changes to the next value. Note: Short Name changes do not result in a new version. Just shared element updates do.

execution.​cancel_reasonstring

Reason of cancellation if status is cancelled

execution.​collateral_pricestringrequired

The collateral_rate adjusted price rounded up.

execution.​contra_statusstringrequired

Execution status of other side

execution.​contract_valuestringrequired

The contract value (calculated as Collateral Adjusted Price * Quantity)

execution.​counterparty_idstringrequired

Company id of the counterparty

execution.​execution_quantitystring(int64)required

Executed quantity

execution.​execution_timestringrequired

date and time of the execution - time in RFC3339 with millisecond precision

execution.​feestringrequired

Rate as fee

execution.​idstringrequired

A execution reference ID assigned by Provable Markets

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

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

execution.​instrument.​cusipstringrequired

CUSIP

execution.​instrument.​namestringrequired

Security name

execution.​instrument.​tickerstringrequired

Ticker

execution.​is_acknowledgedbooleanrequired

has the execution been acknowledged

execution.​order_created_bystringrequired

Order created by user

execution.​order_idstringrequired

Id of the order

execution.​order_last_updated_bystringrequired

Order last updated by user

execution.​rebatestringrequired

Rate as rebate

execution.​settlement_amountstringrequired

Deprecated. Please use contract_value.

execution.​settlement_datestringrequired

settlement date - date in YYYY-MM-DD format

execution.​settlement_pricestringrequired

Deprecated. Please use collateral_price.

execution.​sidestring(aurora.core.consts.common.Side)required
Enum"BORROW""LOAN"
execution.​start_datestringrequired

Start date deprecated

execution.​statusstringrequired

Execution status

execution.​trade_datestringrequired

trade date - date in YYYY-MM-DD format

execution.​unit_pricestringrequired

Last prior day market price

execution.​updated_atstringrequired

Last Updated - time in RFC3339 with millisecond precision

request_idstringrequired

Unique request identifier assigned to the event

curl -i -X POST \
  https://developer.provablemarkets.com/_mock/apis/connectapi/aurora.core.apiengine.executionsv1.ExecutionEventsService/Execution \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "execution": {
      "agreement": {
        "approved_at": "string",
        "balance_target": "string",
        "balance_target_variance": "string",
        "billing_currency": "USD",
        "booking_account": "string",
        "collateral_currency": "USD",
        "collateral_method": "COLLATERAL_METHOD_UNSPECIFIED",
        "collateral_rate": "string",
        "collateral_type": "COLLATERAL_TYPE_UNSPECIFIED",
        "counterparty_booking_account": "string",
        "counterparty_id": "string",
        "created_at": "string",
        "delivery_type": "DELIVERY_TYPE_UNSPECIFIED",
        "dividend_required": "string",
        "id": "string",
        "pricing_currency": "USD",
        "profit_center": "string",
        "proposed_by_side": "BORROW",
        "proposer_user": "string",
        "responder_user": "string",
        "rounding_rule": "NO_ROUNDING",
        "rwa_bucket": "string",
        "settlement_system": "SETTLEMENT_SYSTEM_UNSPECIFIED",
        "settlement_type": "NSCC",
        "short_name": "string",
        "side": "BORROW",
        "status": "AGREEMENT_STATUS_UNSPECIFIED",
        "term_end_date": "string",
        "term_start_date": "string",
        "term_type": "TERM_TYPE_UNSPECIFIED",
        "trade_type": "string",
        "version": "string"
      },
      "cancel_reason": "string",
      "collateral_price": "string",
      "contra_status": "string",
      "contract_value": "string",
      "counterparty_id": "string",
      "execution_quantity": "string",
      "execution_time": "string",
      "fee": "string",
      "id": "string",
      "instrument": {
        "cusip": "string",
        "name": "string",
        "ticker": "string"
      },
      "is_acknowledged": true,
      "order_created_by": "string",
      "order_id": "string",
      "order_last_updated_by": "string",
      "rebate": "string",
      "settlement_amount": "string",
      "settlement_date": "string",
      "settlement_price": "string",
      "side": "BORROW",
      "start_date": "string",
      "status": "string",
      "trade_date": "string",
      "unit_price": "string",
      "updated_at": "string"
    },
    "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
{}

ExecutionService

Operations

VenueEventsService

Operations

VenueService

Operations

LoginService

Operations