Methods to query companies
Aurora API (v1.23.0-rc1)
Download OpenAPI description
Overview
Languages
Servers
Mock server
https://developer.provablemarkets.com/_mock/apis/connectapi
https://developer.provablemarkets.com
Bodyapplication/jsonrequired
Fields: id, external_id, version_reference, instrument, side, order_status, order_type, order_intent, time_in_force, good_till_time, quantity, min_quantity, fee, rebate, agreement_ids, open_quantity, total_execution_quantity, avg_execution_fee, avg_execution_rebate, created_at, updated_at, created_by, last_updated_by, firm_quantity, ioi_quantity, executions, allow_odd_lots
List of executions on this Order
Rate limit, expressed as fee Optional for certain order types: IOI And not applicable for certain order types: Market
The time the order will be canceled if populated. Time in RFC3339 with millisecond precision
Instruments can be identified by their CUSIP or Ticker Symbol
Fields: cusip, ticker, name
Enum"OPEN""FILLED""CANCELED""EXPIRED""TERMINATED""HELD""FORCE_CANCELED"
Rate limit, expressed as rebate (same as fee, but relative to benchmark) Optional for certain order types: IOI And not applicable for certain order types: Market
Enum"DAY""GOOD_TILL_CANCEL""IMMEDIATE_OR_CANCEL""FILL_OR_KILL""GOOD_TILL_TIME"
Order was last changed at - time in RFC3339 with millisecond precision
- Mock serverhttps://developer.provablemarkets.com/_mock/apis/connectapi/aurora.core.apiengine.omsv1.OmsEventsService/OrderCanceled
- https://developer.provablemarkets.com/aurora.core.apiengine.omsv1.OmsEventsService/OrderCanceled
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X POST \
https://developer.provablemarkets.com/_mock/apis/connectapi/aurora.core.apiengine.omsv1.OmsEventsService/OrderCanceled \
-H 'Authorization: YOUR_API_KEY_HERE' \
-H 'Content-Type: application/json' \
-d '{
"order": {
"agreement_ids": [
"string"
],
"allow_odd_lots": true,
"avg_execution_fee": "string",
"avg_execution_rebate": "string",
"created_at": "string",
"created_by": "string",
"executions": [
{
"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"
}
],
"external_id": "string",
"fee": "string",
"firm_quantity": "string",
"good_till_time": "string",
"id": "string",
"instrument": {
"cusip": "string",
"name": "string",
"ticker": "string"
},
"ioi_quantity": "string",
"last_updated_by": "string",
"min_quantity": "string",
"open_quantity": "string",
"order_intent": "FIRM",
"order_status": "OPEN",
"order_type": "LIMIT",
"quantity": "string",
"rebate": "string",
"side": "BORROW",
"time_in_force": "DAY",
"total_execution_quantity": "string",
"updated_at": "string",
"version_reference": "string"
},
"request_id": "string"
}'A successful response
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
{}
Bodyapplication/jsonrequired
Fields: id, external_id, version_reference, instrument, side, order_status, order_type, order_intent, time_in_force, good_till_time, quantity, min_quantity, fee, rebate, agreement_ids, open_quantity, total_execution_quantity, avg_execution_fee, avg_execution_rebate, created_at, updated_at, created_by, last_updated_by, firm_quantity, ioi_quantity, executions, allow_odd_lots
List of executions on this Order
Rate limit, expressed as fee Optional for certain order types: IOI And not applicable for certain order types: Market
The time the order will be canceled if populated. Time in RFC3339 with millisecond precision
Instruments can be identified by their CUSIP or Ticker Symbol
Fields: cusip, ticker, name
Enum"OPEN""FILLED""CANCELED""EXPIRED""TERMINATED""HELD""FORCE_CANCELED"
Rate limit, expressed as rebate (same as fee, but relative to benchmark) Optional for certain order types: IOI And not applicable for certain order types: Market
Enum"DAY""GOOD_TILL_CANCEL""IMMEDIATE_OR_CANCEL""FILL_OR_KILL""GOOD_TILL_TIME"
Order was last changed at - time in RFC3339 with millisecond precision
- Mock serverhttps://developer.provablemarkets.com/_mock/apis/connectapi/aurora.core.apiengine.omsv1.OmsEventsService/OrderClosed
- https://developer.provablemarkets.com/aurora.core.apiengine.omsv1.OmsEventsService/OrderClosed
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X POST \
https://developer.provablemarkets.com/_mock/apis/connectapi/aurora.core.apiengine.omsv1.OmsEventsService/OrderClosed \
-H 'Authorization: YOUR_API_KEY_HERE' \
-H 'Content-Type: application/json' \
-d '{
"order": {
"agreement_ids": [
"string"
],
"allow_odd_lots": true,
"avg_execution_fee": "string",
"avg_execution_rebate": "string",
"created_at": "string",
"created_by": "string",
"executions": [
{
"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"
}
],
"external_id": "string",
"fee": "string",
"firm_quantity": "string",
"good_till_time": "string",
"id": "string",
"instrument": {
"cusip": "string",
"name": "string",
"ticker": "string"
},
"ioi_quantity": "string",
"last_updated_by": "string",
"min_quantity": "string",
"open_quantity": "string",
"order_intent": "FIRM",
"order_status": "OPEN",
"order_type": "LIMIT",
"quantity": "string",
"rebate": "string",
"side": "BORROW",
"time_in_force": "DAY",
"total_execution_quantity": "string",
"updated_at": "string",
"version_reference": "string"
},
"request_id": "string"
}'A successful response
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
{}
Bodyapplication/jsonrequired
Fields: id, external_id, version_reference, instrument, side, order_status, order_type, order_intent, time_in_force, good_till_time, quantity, min_quantity, fee, rebate, agreement_ids, open_quantity, total_execution_quantity, avg_execution_fee, avg_execution_rebate, created_at, updated_at, created_by, last_updated_by, firm_quantity, ioi_quantity, executions, allow_odd_lots
List of executions on this Order
Rate limit, expressed as fee Optional for certain order types: IOI And not applicable for certain order types: Market
The time the order will be canceled if populated. Time in RFC3339 with millisecond precision
Instruments can be identified by their CUSIP or Ticker Symbol
Fields: cusip, ticker, name
Enum"OPEN""FILLED""CANCELED""EXPIRED""TERMINATED""HELD""FORCE_CANCELED"
Rate limit, expressed as rebate (same as fee, but relative to benchmark) Optional for certain order types: IOI And not applicable for certain order types: Market
Enum"DAY""GOOD_TILL_CANCEL""IMMEDIATE_OR_CANCEL""FILL_OR_KILL""GOOD_TILL_TIME"
Order was last changed at - time in RFC3339 with millisecond precision
- Mock serverhttps://developer.provablemarkets.com/_mock/apis/connectapi/aurora.core.apiengine.omsv1.OmsEventsService/OrderCreated
- https://developer.provablemarkets.com/aurora.core.apiengine.omsv1.OmsEventsService/OrderCreated
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X POST \
https://developer.provablemarkets.com/_mock/apis/connectapi/aurora.core.apiengine.omsv1.OmsEventsService/OrderCreated \
-H 'Authorization: YOUR_API_KEY_HERE' \
-H 'Content-Type: application/json' \
-d '{
"order": {
"agreement_ids": [
"string"
],
"allow_odd_lots": true,
"avg_execution_fee": "string",
"avg_execution_rebate": "string",
"created_at": "string",
"created_by": "string",
"executions": [
{
"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"
}
],
"external_id": "string",
"fee": "string",
"firm_quantity": "string",
"good_till_time": "string",
"id": "string",
"instrument": {
"cusip": "string",
"name": "string",
"ticker": "string"
},
"ioi_quantity": "string",
"last_updated_by": "string",
"min_quantity": "string",
"open_quantity": "string",
"order_intent": "FIRM",
"order_status": "OPEN",
"order_type": "LIMIT",
"quantity": "string",
"rebate": "string",
"side": "BORROW",
"time_in_force": "DAY",
"total_execution_quantity": "string",
"updated_at": "string",
"version_reference": "string"
},
"request_id": "string"
}'A successful response
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
{}
Bodyapplication/jsonrequired
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
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
Datetime that agreement was approved by the second party - time in RFC3339 with millisecond precision
Enum"USD""CAD""GBP""EUR""JPY"
Enum"USD""CAD""GBP""EUR""JPY"
execution.agreement.collateral_methodstring(aurora.core.consts.agreements.CollateralMethod)required
Enum"COLLATERAL_METHOD_UNSPECIFIED""PLEDGE""TITLE_TRANSFER"
Enum"COLLATERAL_TYPE_UNSPECIFIED""CASH""NON_CASH_UST""NON_CASH_EQ""NON_CASH_JGB"
The Provable assigned company_id of the counterparty in the agreement
Datetime that agreement was initially created - time in RFC3339 with millisecond precision
Enum"DELIVERY_TYPE_UNSPECIFIED""DVP""FOP"
A unique reference for the agreement assigned by Provable Markets
Enum"USD""CAD""GBP""EUR""JPY"
Enum"BORROW""LOAN"
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"
Enum"SETTLEMENT_SYSTEM_UNSPECIFIED""PROVABLE_MARKET""LOANET""LOANET_SFT""SPIRE""PROP"
Enum"NSCC""BILATERAL"
The short name your company has assigned to this agreement
possible agreement status
Enum"AGREEMENT_STATUS_UNSPECIFIED""DRAFT""ACTIVE""REJECTED""CANCELED""INACTIVE"
Enum"TERM_TYPE_UNSPECIFIED""NONE""FIXED""EVERGREEN""ONE_DAY""BULLET"
The contract value (calculated as Collateral Adjusted Price * Quantity)
date and time of the execution - time in RFC3339 with millisecond precision
Instruments can be identified by their CUSIP or Ticker Symbol
Fields: cusip, ticker, name
Fields: id, external_id, version_reference, instrument, side, order_status, order_type, order_intent, time_in_force, good_till_time, quantity, min_quantity, fee, rebate, agreement_ids, open_quantity, total_execution_quantity, avg_execution_fee, avg_execution_rebate, created_at, updated_at, created_by, last_updated_by, firm_quantity, ioi_quantity, executions, allow_odd_lots
List of executions on this Order
Rate limit, expressed as fee Optional for certain order types: IOI And not applicable for certain order types: Market
The time the order will be canceled if populated. Time in RFC3339 with millisecond precision
Instruments can be identified by their CUSIP or Ticker Symbol
Fields: cusip, ticker, name
Enum"OPEN""FILLED""CANCELED""EXPIRED""TERMINATED""HELD""FORCE_CANCELED"
Rate limit, expressed as rebate (same as fee, but relative to benchmark) Optional for certain order types: IOI And not applicable for certain order types: Market
Enum"DAY""GOOD_TILL_CANCEL""IMMEDIATE_OR_CANCEL""FILL_OR_KILL""GOOD_TILL_TIME"
Order was last changed at - time in RFC3339 with millisecond precision
- Mock serverhttps://developer.provablemarkets.com/_mock/apis/connectapi/aurora.core.apiengine.omsv1.OmsEventsService/OrderExecuted
- https://developer.provablemarkets.com/aurora.core.apiengine.omsv1.OmsEventsService/OrderExecuted
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X POST \
https://developer.provablemarkets.com/_mock/apis/connectapi/aurora.core.apiengine.omsv1.OmsEventsService/OrderExecuted \
-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"
},
"order": {
"agreement_ids": [
"string"
],
"allow_odd_lots": true,
"avg_execution_fee": "string",
"avg_execution_rebate": "string",
"created_at": "string",
"created_by": "string",
"executions": [
{
"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"
}
],
"external_id": "string",
"fee": "string",
"firm_quantity": "string",
"good_till_time": "string",
"id": "string",
"instrument": {
"cusip": "string",
"name": "string",
"ticker": "string"
},
"ioi_quantity": "string",
"last_updated_by": "string",
"min_quantity": "string",
"open_quantity": "string",
"order_intent": "FIRM",
"order_status": "OPEN",
"order_type": "LIMIT",
"quantity": "string",
"rebate": "string",
"side": "BORROW",
"time_in_force": "DAY",
"total_execution_quantity": "string",
"updated_at": "string",
"version_reference": "string"
},
"request_id": "string"
}'A successful response
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
{}
Bodyapplication/jsonrequired
Fields: id, external_id, version_reference, instrument, side, order_status, order_type, order_intent, time_in_force, good_till_time, quantity, min_quantity, fee, rebate, agreement_ids, open_quantity, total_execution_quantity, avg_execution_fee, avg_execution_rebate, created_at, updated_at, created_by, last_updated_by, firm_quantity, ioi_quantity, executions, allow_odd_lots
List of executions on this Order
Rate limit, expressed as fee Optional for certain order types: IOI And not applicable for certain order types: Market
The time the order will be canceled if populated. Time in RFC3339 with millisecond precision
Instruments can be identified by their CUSIP or Ticker Symbol
Fields: cusip, ticker, name
Enum"OPEN""FILLED""CANCELED""EXPIRED""TERMINATED""HELD""FORCE_CANCELED"
Rate limit, expressed as rebate (same as fee, but relative to benchmark) Optional for certain order types: IOI And not applicable for certain order types: Market
Enum"DAY""GOOD_TILL_CANCEL""IMMEDIATE_OR_CANCEL""FILL_OR_KILL""GOOD_TILL_TIME"
Order was last changed at - time in RFC3339 with millisecond precision
- Mock serverhttps://developer.provablemarkets.com/_mock/apis/connectapi/aurora.core.apiengine.omsv1.OmsEventsService/OrderExpired
- https://developer.provablemarkets.com/aurora.core.apiengine.omsv1.OmsEventsService/OrderExpired
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X POST \
https://developer.provablemarkets.com/_mock/apis/connectapi/aurora.core.apiengine.omsv1.OmsEventsService/OrderExpired \
-H 'Authorization: YOUR_API_KEY_HERE' \
-H 'Content-Type: application/json' \
-d '{
"order": {
"agreement_ids": [
"string"
],
"allow_odd_lots": true,
"avg_execution_fee": "string",
"avg_execution_rebate": "string",
"created_at": "string",
"created_by": "string",
"executions": [
{
"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"
}
],
"external_id": "string",
"fee": "string",
"firm_quantity": "string",
"good_till_time": "string",
"id": "string",
"instrument": {
"cusip": "string",
"name": "string",
"ticker": "string"
},
"ioi_quantity": "string",
"last_updated_by": "string",
"min_quantity": "string",
"open_quantity": "string",
"order_intent": "FIRM",
"order_status": "OPEN",
"order_type": "LIMIT",
"quantity": "string",
"rebate": "string",
"side": "BORROW",
"time_in_force": "DAY",
"total_execution_quantity": "string",
"updated_at": "string",
"version_reference": "string"
},
"request_id": "string"
}'A successful response
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
{}
Bodyapplication/jsonrequired
Fields: id, external_id, version_reference, instrument, side, order_status, order_type, order_intent, time_in_force, good_till_time, quantity, min_quantity, fee, rebate, agreement_ids, open_quantity, total_execution_quantity, avg_execution_fee, avg_execution_rebate, created_at, updated_at, created_by, last_updated_by, firm_quantity, ioi_quantity, executions, allow_odd_lots
List of executions on this Order
Rate limit, expressed as fee Optional for certain order types: IOI And not applicable for certain order types: Market
The time the order will be canceled if populated. Time in RFC3339 with millisecond precision
Instruments can be identified by their CUSIP or Ticker Symbol
Fields: cusip, ticker, name
Enum"OPEN""FILLED""CANCELED""EXPIRED""TERMINATED""HELD""FORCE_CANCELED"
Rate limit, expressed as rebate (same as fee, but relative to benchmark) Optional for certain order types: IOI And not applicable for certain order types: Market
Enum"DAY""GOOD_TILL_CANCEL""IMMEDIATE_OR_CANCEL""FILL_OR_KILL""GOOD_TILL_TIME"
Order was last changed at - time in RFC3339 with millisecond precision
- Mock serverhttps://developer.provablemarkets.com/_mock/apis/connectapi/aurora.core.apiengine.omsv1.OmsEventsService/OrderModified
- https://developer.provablemarkets.com/aurora.core.apiengine.omsv1.OmsEventsService/OrderModified
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X POST \
https://developer.provablemarkets.com/_mock/apis/connectapi/aurora.core.apiengine.omsv1.OmsEventsService/OrderModified \
-H 'Authorization: YOUR_API_KEY_HERE' \
-H 'Content-Type: application/json' \
-d '{
"order": {
"agreement_ids": [
"string"
],
"allow_odd_lots": true,
"avg_execution_fee": "string",
"avg_execution_rebate": "string",
"created_at": "string",
"created_by": "string",
"executions": [
{
"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"
}
],
"external_id": "string",
"fee": "string",
"firm_quantity": "string",
"good_till_time": "string",
"id": "string",
"instrument": {
"cusip": "string",
"name": "string",
"ticker": "string"
},
"ioi_quantity": "string",
"last_updated_by": "string",
"min_quantity": "string",
"open_quantity": "string",
"order_intent": "FIRM",
"order_status": "OPEN",
"order_type": "LIMIT",
"quantity": "string",
"rebate": "string",
"side": "BORROW",
"time_in_force": "DAY",
"total_execution_quantity": "string",
"updated_at": "string",
"version_reference": "string"
},
"request_id": "string"
}'A successful response
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
{}