Skip to content
/ContractService

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

AcceptAwaitingContractReturn

Request

PATH: /aurora.core.apiengine.contractsv1.ContractService/AcceptAwaitingContractReturn

Security
Bearer
Bodyapplication/jsonrequired
idstringrequired

Return identifier (persistent identifier inside Aurora system for the return)

request_idstring

An optional identifier provided by the user to help associate the order request any internal record keeping. If the same value is observed recently then the request will be rejected.

curl -i -X POST \
  https://developer.provablemarkets.com/_mock/apis/connectapi/aurora.core.apiengine.contractsv1.ContractService/AcceptAwaitingContractReturn \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "id": "string",
    "request_id": "string"
  }'

Responses

A successful response

Bodyapplication/json
idstringrequired

Return identifier (persistent identifier inside Aurora system for the return)

Response
application/json
{
  "id": "string"
}

AcceptRateModification

Request

PATH: /aurora.core.apiengine.contractsv1.ContractService/AcceptRateModification

Security
Bearer
Bodyapplication/jsonrequired
idstringrequired

Id of rate_modification that is to be modified

request_idstring

User populated id of this request

curl -i -X POST \
  https://developer.provablemarkets.com/_mock/apis/connectapi/aurora.core.apiengine.contractsv1.ContractService/AcceptRateModification \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "id": "string",
    "request_id": "string"
  }'

Responses

A successful response

Bodyapplication/json
idstringrequired

Id of rate_modification that was created

statusstring(aurora.core.consts.contractratemodification.ContractRateModificationStatus)required

Different stages of a rate renegotiation

Enum"PROPOSED""ACCEPTED""FINALIZED""REJECTED""CANCELED""DROPPED""EXPIRED"
Response
application/json
{
  "id": "string",
  "status": "PROPOSED"
}

BuyInContract

Request

PATH: /aurora.core.apiengine.contractsv1.ContractService/BuyInContract

Buying-In Against Recalled Contracts

Where a lender has requested a recall of a contract, but the borrower has not returned the shares before the allowed_execution_date indicated on the Contract Recall, the lender may buy-in the shares against the borrower.

Aurora acts as a gateway to capture the purchase price and quantity of this buy-in, allowing the lender to reclaim the costs of the buy-in against the borrower, and adjusting the contract records within Aurora and downstream clearing and settlement. The lender may submit the execution price and quantity of shares by submitting this message.

Note that buy-ins are allocated against outstanding recalls for the indicated contract on a first-in-first-out basis, and therefore a contract_recall_id is not supported in this message.

The submitted buy-in details must be processed by DTC before updating outstanding contracts and recall request(s) within Aurora.

Security
Bearer
Bodyapplication/jsonrequired
avg_price_per_sharestringrequired

Average price per share for buy-in

idstringrequired

Contract identifier (persistent contract identifier inside Aurora system)

quantitystring(int64)required

Amount of shares to buy-in

request_idstring

An optional identifier provided by the user to help associate the order request any internal record keeping. If the same value is observed recently then the request will be rejected.

curl -i -X POST \
  https://developer.provablemarkets.com/_mock/apis/connectapi/aurora.core.apiengine.contractsv1.ContractService/BuyInContract \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "avg_price_per_share": "string",
    "id": "string",
    "quantity": "string",
    "request_id": "string"
  }'

Responses

A successful response
Returns current status of the BuyIn request

Bodyapplication/json
buyinobject(aurora.core.apiengine.contractsv1.BuyIn)required

Fields: id, contract_id, quantity, price, status

buyin.​contract_idstringrequired

Contract identifier (persistent identifier inside Aurora system)

buyin.​idstringrequired

Buy-in identifier (persistent identifier inside Aurora system for the return)

buyin.​pricestringrequired

Average price of the shares bought-in

buyin.​quantitystring(int64)required

Amount of shares being bought-in

buyin.​statusstring(aurora.core.consts.contractbuyin.ContractBuyInStatus)required

ContractBuyInStatus : the state a Buy-In is in now

Enum"PENDING""ACCEPTED""REJECTED"
Response
application/json
{
  "buyin": {
    "contract_id": "string",
    "id": "string",
    "price": "string",
    "quantity": "string",
    "status": "PENDING"
  }
}

ContractEventsService

Operations

AgreementService

Operations

ContractRequestEventsService

Operations

ContractRequestService

Operations

InstrumentService

Operations

ExecutionEventsService

Operations

ExecutionService

Operations

VenueEventsService

Operations

VenueService

Operations

LoginService

Operations