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

ExecutionService

Operations

VenueEventsService

Operations

OrderAdded

Request

PATH: /aurora.core.apiengine.venuev1.VenueEventsService/OrderAdded

Security
Bearer
Bodyapplication/jsonrequired
orderobject(aurora.core.apiengine.venuev1.Order)required

Fields: id, side, quantity, instrument, fee, rebate, min_quantity, order_type, agreement_ids, company_id, order_intent, created_at, updated_at

order.​agreement_idsArray of strings

agreements that the order can be matched under

order.​company_idstringrequired

Company ID for the order

order.​created_atstringrequired

time at which order was created - time in RFC3339 with millisecond precision

order.​feestring

Fee

order.​idstringrequired

reference of the order

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

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

order.​instrument.​cusipstringrequired

CUSIP

order.​instrument.​namestringrequired

Security name

order.​instrument.​tickerstringrequired

Ticker

order.​min_quantitystring(int64)required

Minimum quantity of shares per execution

order.​order_intentstring(aurora.core.consts.oms.OrderIntent)required
Enum"FIRM""IOI"
order.​order_typestring(aurora.core.consts.oms.OmsOrderType)required
Value"LIMIT"
order.​quantitystring(int64)required

Requested quantity of shares

order.​rebatestring

Rebate

order.​sidestring(aurora.core.consts.common.Side)required
Enum"BORROW""LOAN"
order.​updated_atstringrequired

time at which order was last updated at - 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.venuev1.VenueEventsService/OrderAdded \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "order": {
      "agreement_ids": [
        "string"
      ],
      "company_id": "string",
      "created_at": "string",
      "fee": "string",
      "id": "string",
      "instrument": {
        "cusip": "string",
        "name": "string",
        "ticker": "string"
      },
      "min_quantity": "string",
      "order_intent": "FIRM",
      "order_type": "LIMIT",
      "quantity": "string",
      "rebate": "string",
      "side": "BORROW",
      "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
{}

OrderRemoved

Request

PATH: /aurora.core.apiengine.venuev1.VenueEventsService/OrderRemoved

Security
Bearer
Bodyapplication/jsonrequired
orderobject(aurora.core.apiengine.venuev1.Order)required

Fields: id, side, quantity, instrument, fee, rebate, min_quantity, order_type, agreement_ids, company_id, order_intent, created_at, updated_at

order.​agreement_idsArray of strings

agreements that the order can be matched under

order.​company_idstringrequired

Company ID for the order

order.​created_atstringrequired

time at which order was created - time in RFC3339 with millisecond precision

order.​feestring

Fee

order.​idstringrequired

reference of the order

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

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

order.​instrument.​cusipstringrequired

CUSIP

order.​instrument.​namestringrequired

Security name

order.​instrument.​tickerstringrequired

Ticker

order.​min_quantitystring(int64)required

Minimum quantity of shares per execution

order.​order_intentstring(aurora.core.consts.oms.OrderIntent)required
Enum"FIRM""IOI"
order.​order_typestring(aurora.core.consts.oms.OmsOrderType)required
Value"LIMIT"
order.​quantitystring(int64)required

Requested quantity of shares

order.​rebatestring

Rebate

order.​sidestring(aurora.core.consts.common.Side)required
Enum"BORROW""LOAN"
order.​updated_atstringrequired

time at which order was last updated at - 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.venuev1.VenueEventsService/OrderRemoved \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "order": {
      "agreement_ids": [
        "string"
      ],
      "company_id": "string",
      "created_at": "string",
      "fee": "string",
      "id": "string",
      "instrument": {
        "cusip": "string",
        "name": "string",
        "ticker": "string"
      },
      "min_quantity": "string",
      "order_intent": "FIRM",
      "order_type": "LIMIT",
      "quantity": "string",
      "rebate": "string",
      "side": "BORROW",
      "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
{}

VenueService

Operations

LoginService

Operations