info:
  contact:
    email: info@provablemarkets.com
    name: Provable Markets
    url: https://provablemarkets.com/contact
  termsOfService: https://provablemarkets.com/terms-conditions
  title: Aurora API
  version: v1.23.0-rc1
servers:
  - url: https://developer.provablemarkets.com
components:
  schemas:
    agreements_rules.buf.validate.StringRules:
      description: >-
        Fields: short_name_validated, decimal_valid_number,
        decimal_allow_negative, decimal_precision_max_digits,
        decimal_precision_scale
      properties:
        decimal_allow_negative:
          type: boolean
        decimal_precision_max_digits:
          format: int32
          type: integer
        decimal_precision_scale:
          format: int32
          type: integer
        decimal_valid_number:
          type: boolean
        short_name_validated:
          type: boolean
      type: object
    aurora.core.apiengine.agreementsv1.Agreement:
      description: >-
        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
      properties:
        approved_at:
          description: >-
            Datetime that agreement was approved by the second party - time in
            RFC3339 with millisecond precision
          type: string
        balance_target:
          type: string
        balance_target_variance:
          type: string
        billing_currency:
          $ref: '#/components/schemas/aurora.core.common.protos.Currency'
        booking_account:
          type: string
        collateral_currency:
          $ref: '#/components/schemas/aurora.core.common.protos.Currency'
        collateral_method:
          $ref: '#/components/schemas/aurora.core.consts.agreements.CollateralMethod'
        collateral_rate:
          description: Collateral Rate
          type: string
        collateral_type:
          $ref: '#/components/schemas/aurora.core.consts.agreements.CollateralType'
        counterparty_booking_account:
          type: string
        counterparty_id:
          description: >-
            The Provable assigned company_id of the counterparty in the
            agreement
          type: string
        created_at:
          description: >-
            Datetime that agreement was initially created - time in RFC3339 with
            millisecond precision
          type: string
        delivery_type:
          $ref: '#/components/schemas/aurora.core.consts.agreements.DeliveryType'
        dividend_required:
          type: string
        id:
          description: A unique reference for the agreement assigned by Provable Markets
          type: string
        pricing_currency:
          $ref: '#/components/schemas/aurora.core.common.protos.Currency'
        profit_center:
          type: string
        proposed_by_side:
          $ref: '#/components/schemas/aurora.core.consts.common.Side'
        proposer_user:
          description: The user who initially created the agreement
          type: string
        responder_user:
          description: The user who approved or rejected the agreement
          type: string
        rounding_rule:
          $ref: '#/components/schemas/aurora.core.consts.RoundingRule'
        rwa_bucket:
          type: string
        settlement_system:
          $ref: '#/components/schemas/aurora.core.consts.agreements.SettlementSystem'
        settlement_type:
          $ref: '#/components/schemas/aurora.core.consts.settlement.SettlementType'
        short_name:
          description: The short name your company has assigned to this agreement
          type: string
        side:
          $ref: '#/components/schemas/aurora.core.consts.common.Side'
        status:
          $ref: '#/components/schemas/aurora.core.consts.agreements.AgreementStatus'
        term_end_date:
          type: string
        term_start_date:
          type: string
        term_type:
          $ref: '#/components/schemas/aurora.core.consts.agreements.TermType'
        trade_type:
          type: string
        version:
          description: >-
            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.
          format: int64
          type: string
      required:
        - id
        - short_name
        - side
        - counterparty_id
        - settlement_type
        - rounding_rule
        - collateral_rate
        - status
        - proposer_user
        - proposed_by_side
        - version
        - collateral_type
        - pricing_currency
        - billing_currency
        - collateral_method
        - dividend_required
        - term_type
        - created_at
        - delivery_type
      type: object
    aurora.core.apiengine.agreementsv1.ApproveAgreementRequest:
      description: >-
        Approve-Agreement Request<br>Fields: id, short_name, balance_target,
        balance_target_variance, settlement_system, booking_account,
        profit_center
      properties:
        balance_target:
          description: >-
            Balance Target can be added by each party for their own purposes,
            not visible to the counterparty
          type: string
        balance_target_variance:
          description: >-
            Balance Target Variance can be added by each party for their own
            purposes, not visible to the counterparty
          type: string
        booking_account:
          description: Booking Account added by each party, visible to the counterparty
          type: string
        id:
          description: ID of the agreement
          type: string
        profit_center:
          type: string
        settlement_system:
          $ref: '#/components/schemas/aurora.core.consts.agreements.SettlementSystem'
        short_name:
          description: >-
            Agreements require a short name that can be used for both display in
            the order book and when creating new orders.

            Short names must be unique amongst your agreements and must be 25
            characters or less.

            Spaces are supported but not recommended.
          type: string
      required:
        - id
        - short_name
      type: object
    aurora.core.apiengine.agreementsv1.ApproveAgreementResponse:
      description: Approve-Agreement Response
      type: object
    aurora.core.apiengine.agreementsv1.CancelAgreementRequest:
      description: 'Cancel-Agreement Request<br>Fields: id'
      properties:
        id:
          description: The reference for the agreement to be closed
          type: string
      required:
        - id
      type: object
    aurora.core.apiengine.agreementsv1.CancelAgreementResponse:
      description: Cancel-Agreement Response
      type: object
    aurora.core.apiengine.agreementsv1.CreateAgreementRequest:
      description: >-
        Create-Agreement Request<br>Fields: short_name, counterparty_id,
        settlement_type, rounding_rule, collateral_rate, side, 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, booking_account, trade_type, profit_center,
        delivery_type
      properties:
        balance_target:
          description: >-
            Balance Target can be added by each party for their own purposes,
            not visible to the counterparty
          type: string
        balance_target_variance:
          description: >-
            Balance Target Variance can be added by each party for their own
            purposes, not visible to the counterparty
          type: string
        billing_currency:
          $ref: '#/components/schemas/aurora.core.common.protos.Currency'
        booking_account:
          type: string
        collateral_currency:
          $ref: '#/components/schemas/aurora.core.common.protos.Currency'
        collateral_method:
          $ref: '#/components/schemas/aurora.core.consts.agreements.CollateralMethod'
        collateral_rate:
          description: >-
            The Margin or Collateral rate to be used by both parties when
            calculating the contract price and value. (ie. 102%)
          type: string
        collateral_type:
          $ref: '#/components/schemas/aurora.core.consts.agreements.CollateralType'
        counterparty_id:
          description: >-
            This will be the Provable assigned company_id. See the Company
            endpoint for more details.
          type: string
        delivery_type:
          $ref: '#/components/schemas/aurora.core.consts.agreements.DeliveryType'
        dividend_required:
          type: string
        pricing_currency:
          $ref: '#/components/schemas/aurora.core.common.protos.Currency'
        profit_center:
          type: string
        rounding_rule:
          $ref: '#/components/schemas/aurora.core.consts.RoundingRule'
        rwa_bucket:
          type: string
        settlement_system:
          $ref: '#/components/schemas/aurora.core.consts.agreements.SettlementSystem'
        settlement_type:
          $ref: '#/components/schemas/aurora.core.consts.settlement.SettlementType'
        short_name:
          description: >-
            Agreements require a short name that can be used for both display in
            the order book and when creating new orders.

            Short names must be unique amongst your agreements and must be 25
            characters or less. Names are case sensitive.

            Spaces are supported but not recommended.
          type: string
        side:
          $ref: '#/components/schemas/aurora.core.consts.common.Side'
        term_end_date:
          type: string
        term_start_date:
          type: string
        term_type:
          $ref: '#/components/schemas/aurora.core.consts.agreements.TermType'
        trade_type:
          type: string
      required:
        - short_name
        - counterparty_id
        - settlement_type
        - rounding_rule
        - collateral_rate
        - side
        - collateral_type
        - pricing_currency
        - billing_currency
        - collateral_method
        - dividend_required
        - term_type
        - delivery_type
      type: object
    aurora.core.apiengine.agreementsv1.CreateAgreementResponse:
      description: 'Create-Agreement Response<br>Fields: agreement'
      properties:
        agreement:
          $ref: '#/components/schemas/aurora.core.apiengine.agreementsv1.Agreement'
      required:
        - agreement
      type: object
    aurora.core.apiengine.agreementsv1.GetAgreementRequest:
      description: 'Fields: id'
      properties:
        id:
          type: string
      required:
        - id
      type: object
    aurora.core.apiengine.agreementsv1.GetAgreementResponse:
      description: 'Fields: agreement'
      properties:
        agreement:
          $ref: '#/components/schemas/aurora.core.apiengine.agreementsv1.Agreement'
      required:
        - agreement
      type: object
    aurora.core.apiengine.agreementsv1.ListAgreementsRequest:
      description: >-
        List-Agreements Request<br>Fields: statuses, side, counterparty_ids,
        eligible_instrument, booking_accounts, counterparty_booking_accounts,
        trade_types, collateral_currencies, delivery_types
      properties:
        booking_accounts:
          items:
            type: string
          type: array
        collateral_currencies:
          items:
            $ref: '#/components/schemas/aurora.core.common.protos.Currency'
          type: array
        counterparty_booking_accounts:
          items:
            type: string
          type: array
        counterparty_ids:
          items:
            type: string
          type: array
        delivery_types:
          items:
            $ref: '#/components/schemas/aurora.core.consts.agreements.DeliveryType'
          type: array
        eligible_instrument:
          description: Cusip or Ticker of instrument
          type: string
        side:
          $ref: '#/components/schemas/aurora.core.consts.common.Side'
        statuses:
          description: The list of status of the agreements you wish to query.
          items:
            $ref: '#/components/schemas/aurora.core.consts.agreements.AgreementStatus'
          type: array
        trade_types:
          items:
            type: string
          type: array
      type: object
    aurora.core.apiengine.agreementsv1.ListAgreementsResponse:
      description: 'List-Agreements Response<br>Fields: agreements'
      properties:
        agreements:
          description: List of agreements
          items:
            $ref: '#/components/schemas/aurora.core.apiengine.agreementsv1.Agreement'
          type: array
      type: object
    aurora.core.apiengine.agreementsv1.ModifyAgreementRequest:
      description: >-
        Modify-Agreement Request<br>Fields: id, short_name, settlement_type,
        rounding_rule, collateral_rate, 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, settlement_system, rwa_bucket,
        booking_account, trade_type, profit_center, delivery_type
      properties:
        balance_target:
          type: string
        balance_target_variance:
          type: string
        billing_currency:
          $ref: '#/components/schemas/aurora.core.common.protos.Currency'
        booking_account:
          type: string
        collateral_currency:
          $ref: '#/components/schemas/aurora.core.common.protos.Currency'
        collateral_method:
          $ref: '#/components/schemas/aurora.core.consts.agreements.CollateralMethod'
        collateral_rate:
          description: Updated Margin / Collateral Rate
          type: string
        collateral_type:
          $ref: '#/components/schemas/aurora.core.consts.agreements.CollateralType'
        delivery_type:
          $ref: '#/components/schemas/aurora.core.consts.agreements.DeliveryType'
        dividend_required:
          type: string
        id:
          description: The reference for the agreement you wish to modify
          type: string
        pricing_currency:
          $ref: '#/components/schemas/aurora.core.common.protos.Currency'
        profit_center:
          type: string
        rounding_rule:
          $ref: '#/components/schemas/aurora.core.consts.RoundingRule'
        rwa_bucket:
          type: string
        settlement_system:
          $ref: '#/components/schemas/aurora.core.consts.agreements.SettlementSystem'
        settlement_type:
          $ref: '#/components/schemas/aurora.core.consts.settlement.SettlementType'
        short_name:
          description: >-
            Agreements require a short name that can be used for both display in
            the order book and when creating new orders. Short names must be
            unique amongst your agreements and must be 25 characters or less.
            Spaces are supported but not recommended.
          type: string
        term_end_date:
          type: string
        term_start_date:
          type: string
        term_type:
          $ref: '#/components/schemas/aurora.core.consts.agreements.TermType'
        trade_type:
          type: string
      required:
        - id
        - short_name
        - settlement_type
        - rounding_rule
        - collateral_rate
        - collateral_type
        - pricing_currency
        - billing_currency
        - collateral_method
        - dividend_required
        - term_type
        - delivery_type
      type: object
    aurora.core.apiengine.agreementsv1.ModifyAgreementResponse:
      description: 'Modify-Agreement Response<br>Fields: agreement'
      properties:
        agreement:
          $ref: '#/components/schemas/aurora.core.apiengine.agreementsv1.Agreement'
      required:
        - agreement
      type: object
    aurora.core.apiengine.agreementsv1.RejectAgreementRequest:
      description: 'Reject-Agreement Request<br>Fields: id'
      properties:
        id:
          description: ID of the agreement
          type: string
      required:
        - id
      type: object
    aurora.core.apiengine.agreementsv1.RejectAgreementResponse:
      description: Reject-Agreement Response
      type: object
    aurora.core.apiengine.executionsv1.AckExecutionsRequest:
      description: 'Fields: is_acknowledged, execution_ids'
      properties:
        execution_ids:
          description: executions to ack/unack
          items:
            type: string
          type: array
        is_acknowledged:
          description: ack or unack the executions
          type: boolean
      required:
        - is_acknowledged
      type: object
    aurora.core.apiengine.executionsv1.AckExecutionsResponse:
      type: object
    aurora.core.apiengine.executionsv1.CancelExecutionRecordsRequest:
      description: 'Fields: execution_ids'
      properties:
        execution_ids:
          items:
            type: string
          type: array
      type: object
    aurora.core.apiengine.executionsv1.CancelExecutionRecordsResponse:
      type: object
    aurora.core.apiengine.executionsv1.CustomExportAndAckExecutionRecordsRequest:
      description: 'Fields: type, execution_ids'
      properties:
        execution_ids:
          items:
            type: string
          type: array
        type:
          $ref: >-
            #/components/schemas/aurora.core.apiengine.executionsv1.ExecutionsReportType
      required:
        - type
      type: object
    aurora.core.apiengine.executionsv1.CustomExportAndAckExecutionRecordsResponse:
      description: 'Fields: content'
      properties:
        content:
          format: byte
          type: string
      required:
        - content
      type: object
    aurora.core.apiengine.executionsv1.Execution:
      description: >-
        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
      properties:
        agreement:
          $ref: '#/components/schemas/aurora.core.apiengine.agreementsv1.Agreement'
        cancel_reason:
          description: Reason of cancellation if status is cancelled
          type: string
        collateral_price:
          description: The collateral_rate adjusted price rounded up.
          type: string
        contra_status:
          description: Execution status of other side
          type: string
        contract_value:
          description: >-
            The contract value (calculated as Collateral Adjusted Price *
            Quantity)
          type: string
        counterparty_id:
          description: Company id of the counterparty
          type: string
        execution_quantity:
          description: Executed quantity
          format: int64
          type: string
        execution_time:
          description: >-
            date and time of the execution - time in RFC3339 with millisecond
            precision
          type: string
        fee:
          description: Rate as fee
          type: string
        id:
          description: A execution reference ID assigned by Provable Markets
          type: string
        instrument:
          $ref: '#/components/schemas/aurora.core.common.protos.PbInstrument'
        is_acknowledged:
          description: has the execution been acknowledged
          type: boolean
        order_created_by:
          description: Order created by user
          type: string
        order_id:
          description: Id of the order
          type: string
        order_last_updated_by:
          description: Order last updated by user
          type: string
        rebate:
          description: Rate as rebate
          type: string
        settlement_amount:
          description: Deprecated. Please use contract_value.
          type: string
        settlement_date:
          description: settlement date - date in YYYY-MM-DD format
          type: string
        settlement_price:
          description: Deprecated. Please use collateral_price.
          type: string
        side:
          $ref: '#/components/schemas/aurora.core.consts.common.Side'
        start_date:
          description: |-
            Start date
            deprecated
          type: string
        status:
          description: Execution status
          type: string
        trade_date:
          description: trade date - date in YYYY-MM-DD format
          type: string
        unit_price:
          description: Last prior day market price
          type: string
        updated_at:
          description: Last Updated - time in RFC3339 with millisecond precision
          type: string
      required:
        - 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
        - updated_at
        - order_created_by
        - order_last_updated_by
        - agreement
      type: object
    aurora.core.apiengine.executionsv1.ExecutionEvent:
      description: 'Fields: request_id, execution'
      properties:
        execution:
          $ref: '#/components/schemas/aurora.core.apiengine.executionsv1.Execution'
        request_id:
          description: Unique request identifier assigned to the event
          type: string
      required:
        - request_id
        - execution
      type: object
    aurora.core.apiengine.executionsv1.ExecutionsReportType:
      enum:
        - TYPE_0101
        - TYPE_7273
        - TYPE_ESEC
      type: string
    aurora.core.apiengine.executionsv1.FrontendExecution:
      description: >-
        Fields: exec_id, exec_time, order_display_id, cusip, side, company_id,
        counterparty_id, agreement_id, exec_qty, unit_price, collateral_price,
        fee, rebate, contract_value, settlement_type, collateral_rate,
        rounding_rule, collateral_type, trade_date, settlement_date,
        order_created_by, order_last_updated_by, trade_status, trade_id,
        end_date, cash_start_date, acknowledged_at, status, contra_status,
        cancel_reason, updated_at, pricing_currency, profit_center
      properties:
        acknowledged_at:
          description: >-
            Time the execution was booked and acknowledged by the trader - time
            in RFC3339 with millisecond precision
          type: string
        agreement_id:
          description: >-
            Aurora internal ID for the agreement related to the (partially)
            executed order
          type: string
        cancel_reason:
          description: Reason of cancellation if status is cancelled
          type: string
        cash_start_date:
          description: Cash start date if managed by Aurora; otherwise empty
          type: string
        collateral_price:
          description: >-
            collateral price of the execution including round and
            overcollateralization;
          type: string
        collateral_rate:
          description: Collateral rate
          type: string
        collateral_type:
          $ref: '#/components/schemas/aurora.core.consts.agreements.CollateralType'
        company_id:
          description: Owner of the order
          type: string
        contra_status:
          description: Execution status of other side
          type: string
        contract_value:
          description: Contract value
          type: string
        counterparty_id:
          description: Aurora internal ID for the counterparty company
          type: string
        cusip:
          description: The CUSIP of the instrument in the order
          type: string
        end_date:
          description: End date if managed by Aurora; otherwise empty
          type: string
        exec_id:
          description: Execution ID
          type: string
        exec_qty:
          description: Executed quantity
          format: int64
          type: string
        exec_time:
          description: Execution time - in RFC3339 with millisecond precision
          type: string
        fee:
          description: Rate as fee
          type: string
        order_created_by:
          description: >-
            Aurora internal ID of the user who created the (partially) matched
            order
          type: string
        order_display_id:
          description: Aurora Order Display ID of the order that was (partially) executed
          type: string
        order_last_updated_by:
          description: >-
            Aurora internal ID of the user who last amended the (partially)
            matched order
          type: string
        pricing_currency:
          $ref: '#/components/schemas/aurora.core.common.protos.Currency'
        profit_center:
          type: string
        rebate:
          description: Rate as rebate
          type: string
        rounding_rule:
          $ref: '#/components/schemas/aurora.core.consts.RoundingRule'
        settlement_date:
          description: Settlement date
          type: string
        settlement_type:
          $ref: '#/components/schemas/aurora.core.consts.settlement.SettlementType'
        side:
          $ref: '#/components/schemas/aurora.core.consts.common.Side'
        status:
          description: Execution status
          type: string
        trade_date:
          description: Trade date
          type: string
        trade_id:
          description: >-
            Aurora external ID of the contract, a.k.a. Contract ID if managed by
            Aurora; otherwise empty
          type: string
        trade_status:
          description: >-
            Status of the created contract, if managed by Aurora; otherwise
            empty
          format: int32
          type: integer
        unit_price:
          description: Unit price at time of execution
          type: string
        updated_at:
          description: Last Updated - time in RFC3339 with millisecond precision
          type: string
      required:
        - exec_id
        - exec_time
        - order_display_id
        - cusip
        - side
        - company_id
        - counterparty_id
        - agreement_id
        - exec_qty
        - unit_price
        - collateral_price
        - fee
        - rebate
        - contract_value
        - settlement_type
        - collateral_rate
        - rounding_rule
        - collateral_type
        - trade_date
        - settlement_date
        - order_created_by
        - order_last_updated_by
        - status
        - contra_status
        - updated_at
        - pricing_currency
      type: object
    aurora.core.apiengine.executionsv1.ListExecutionsRequest:
      description: >-
        Fields: side, agreement_id, instrument_id, instrument_id_type, since,
        until, is_acknowledged
      properties:
        agreement_id:
          description: Limit the execution list to a certain agreement
          type: string
        instrument_id:
          description: Limit the execution list to a security
          type: string
        instrument_id_type:
          $ref: '#/components/schemas/aurora.core.consts.oms.InstrumentIdType'
        is_acknowledged:
          description: optional filter by acknowledged status
          type: boolean
        side:
          $ref: '#/components/schemas/aurora.core.consts.common.Side'
        since:
          description: >-
            DateTime for query to start looking for executions - time in RFC3339
            with millisecond precision
          type: string
        until:
          description: >-
            DateTime for the end of the time window for which to search - time
            in RFC3339 with millisecond precision
          type: string
      required:
        - since
      type: object
    aurora.core.apiengine.executionsv1.ListExecutionsResponse:
      description: 'Fields: executions'
      properties:
        executions:
          items:
            $ref: '#/components/schemas/aurora.core.apiengine.executionsv1.Execution'
          type: array
      type: object
    aurora.core.apiengine.executionsv1.QueryExecutionRecordsFilter:
      description: 'Fields: instruments, is_acknowledged, execution_ids'
      properties:
        execution_ids:
          description: Limit the query specific executions
          items:
            type: string
          type: array
        instruments:
          description: CUSIP or ticker of instrument
          items:
            type: string
          type: array
        is_acknowledged:
          description: >-
            Limit the query to executions that are already or not-yet
            acknowledged
          type: boolean
      type: object
    aurora.core.apiengine.executionsv1.QueryExecutionRecordsRequest:
      description: 'Fields: request_id, page_limit, page_number, filter, sorts'
      properties:
        filter:
          $ref: >-
            #/components/schemas/aurora.core.apiengine.executionsv1.QueryExecutionRecordsFilter
        page_limit:
          description: >-
            Number of execution records per page; at most this many records will
            be returned
          format: int32
          type: integer
        page_number:
          description: Number of the page to be returned considering the page_size
          format: int32
          type: integer
        request_id:
          description: New unique identifier for the request, assigned by the user
          type: string
        sorts:
          description: List of sorting options
          items:
            $ref: >-
              #/components/schemas/aurora.core.apiengine.executionsv1.QueryExecutionRecordsSorting
          type: array
      required:
        - request_id
        - page_limit
        - page_number
      type: object
    aurora.core.apiengine.executionsv1.QueryExecutionRecordsResponse:
      description: 'Fields: request_id, total_count, exec_recs, users, instruments'
      properties:
        exec_recs:
          description: The list of Execution Records that the query returned
          items:
            $ref: >-
              #/components/schemas/aurora.core.apiengine.executionsv1.FrontendExecution
          type: array
        instruments:
          $ref: '#/components/schemas/aurora.core.common.protos.PbInstrumentInfo'
        request_id:
          description: The request_id provided in the original request
          type: string
        total_count:
          description: Total number of Execution Records returned
          format: int64
          type: string
        users:
          description: Users referenced in the Execution Records
          type: string
      required:
        - request_id
        - total_count
        - users
        - instruments
      type: object
    aurora.core.apiengine.executionsv1.QueryExecutionRecordsSortableField:
      enum:
        - INSTRUMENT
      type: string
    aurora.core.apiengine.executionsv1.QueryExecutionRecordsSorting:
      description: 'Fields: field, order'
      properties:
        field:
          $ref: >-
            #/components/schemas/aurora.core.apiengine.executionsv1.QueryExecutionRecordsSortableField
        order:
          $ref: '#/components/schemas/aurora.core.consts.query.SortOrder'
      required:
        - field
        - order
      type: object
    aurora.core.apiengine.omsv1.AgreementsFilter:
      description: >-
        Fields: ids, counterparty_ids, collateral_types, settlement_types,
        booking_accounts, counterparty_booking_accounts, trade_types,
        collateral_currencies, delivery_types
      properties:
        booking_accounts:
          items:
            type: string
          type: array
        collateral_currencies:
          items:
            $ref: '#/components/schemas/aurora.core.common.protos.Currency'
          type: array
        collateral_types:
          items:
            $ref: '#/components/schemas/aurora.core.consts.agreements.CollateralType'
          type: array
        counterparty_booking_accounts:
          items:
            type: string
          type: array
        counterparty_ids:
          items:
            type: string
          type: array
        delivery_types:
          items:
            $ref: '#/components/schemas/aurora.core.consts.agreements.DeliveryType'
          type: array
        ids:
          items:
            type: string
          type: array
        settlement_types:
          items:
            $ref: '#/components/schemas/aurora.core.consts.settlement.SettlementType'
          type: array
        trade_types:
          items:
            type: string
          type: array
      type: object
    aurora.core.apiengine.omsv1.BrokerCancelOrdersRequest:
      description: 'Fields: ids, email'
      properties:
        email:
          description: E-mail address for validation
          type: string
        ids:
          description: List of order ids to be canceled
          items:
            type: string
          type: array
      required:
        - email
      type: object
    aurora.core.apiengine.omsv1.BrokerCancelOrdersResponse:
      description: 'Fields: ids, errors'
      properties:
        errors:
          description: list of errors occurred while attempting to cancel the order.
          items:
            $ref: '#/components/schemas/aurora.core.apiengine.omsv1.CancelOrderError'
          type: array
        ids:
          description: >-
            list of order ids for which the cancellation request has been
            successfully received.
          items:
            type: string
          type: array
      type: object
    aurora.core.apiengine.omsv1.CancelAllOrdersRequest:
      type: object
    aurora.core.apiengine.omsv1.CancelAllOrdersResponse:
      description: 'Fields: total_count'
      properties:
        total_count:
          format: int32
          type: integer
      required:
        - total_count
      type: object
    aurora.core.apiengine.omsv1.CancelExecutionRecordsRequest:
      description: 'Fields: execution_ids'
      properties:
        execution_ids:
          items:
            type: string
          type: array
      type: object
    aurora.core.apiengine.omsv1.CancelExecutionRecordsResponse:
      type: object
    aurora.core.apiengine.omsv1.CancelOrderError:
      description: 'Fields: id, error'
      properties:
        error:
          description: Error when attempting to cancel the order
          type: string
        id:
          description: Unique identifier of the order to be canceled - optional
          type: string
      required:
        - id
        - error
      type: object
    aurora.core.apiengine.omsv1.CancelOrderRequest:
      description: 'Fields: id'
      properties:
        id:
          description: Unique identifier of the order to be cancelled
          type: string
      required:
        - id
      type: object
    aurora.core.apiengine.omsv1.CancelOrderResponse:
      description: 'Fields: id'
      properties:
        id:
          description: Provable Markets assigned order identifier for the order canceled
          type: string
      required:
        - id
      type: object
    aurora.core.apiengine.omsv1.CancelOrdersRequest:
      description: 'Fields: ids'
      properties:
        ids:
          description: List of order ids to be canceled
          items:
            type: string
          type: array
      type: object
    aurora.core.apiengine.omsv1.CancelOrdersResponse:
      description: 'Fields: ids, errors'
      properties:
        errors:
          description: list of errors occurred while attempting to cancel the order.
          items:
            $ref: '#/components/schemas/aurora.core.apiengine.omsv1.CancelOrderError'
          type: array
        ids:
          description: >-
            list of order ids for which the cancellation request has been
            successfully received.
          items:
            type: string
          type: array
      type: object
    aurora.core.apiengine.omsv1.CreateOrderRequest:
      description: >-
        Fields: version_reference, instrument_id, instrument_id_type, side,
        order_type, quantity, min_quantity, time_in_force, good_till_time,
        rate_limit, agreements_filter, active, order_intent, external_id,
        allow_odd_lots
      properties:
        active:
          description: All orders will be marked as “Active” by default or Inactive order.
          type: boolean
        agreements_filter:
          $ref: '#/components/schemas/aurora.core.apiengine.omsv1.AgreementsFilter'
        allow_odd_lots:
          description: All orders will allow odd lots by default
          type: boolean
        external_id:
          description: >-
            Customer internal id that will be reflected on the order and can be
            used to query the order
          type: string
        good_till_time:
          description: >-
            If time in force is “GOOD_TILL_TIME”, the date/time the order is to
            be canceled is required. Time in RFC3339 with millisecond precision
          type: string
        instrument_id:
          description: >-
            The ticker symbol or CUSIP of the security you intend to lend or
            borrow
          type: string
        instrument_id_type:
          $ref: '#/components/schemas/aurora.core.consts.oms.InstrumentIdType'
        min_quantity:
          description: >-
            The minimum quantity that the order can be matched against. If not
            specified the default will be 100.
          format: int64
          type: string
        order_intent:
          $ref: '#/components/schemas/aurora.core.consts.oms.OrderIntent'
        order_type:
          $ref: '#/components/schemas/aurora.core.consts.oms.OmsOrderType'
        quantity:
          description: The number of shares you intend to borrow or lend
          format: int64
          type: string
        rate_limit:
          $ref: '#/components/schemas/aurora.core.common.protos.RateLimit'
        side:
          $ref: '#/components/schemas/aurora.core.consts.common.Side'
        time_in_force:
          $ref: '#/components/schemas/aurora.core.consts.oms.OmsTimeInForceType'
        version_reference:
          description: >-
            An optional identifier provided by the user to help associate the
            order with any internal record keeping.

            When provided needs to be a unique value within the past 12 hours,

            if the same value is observed then the request will be rejected.
          type: string
      required:
        - instrument_id
        - instrument_id_type
        - side
        - order_type
        - quantity
        - time_in_force
        - order_intent
      type: object
    aurora.core.apiengine.omsv1.CreateOrderResponse:
      description: 'Fields: id'
      properties:
        id:
          description: Unique identifier assigned to this order by Provable Markets
          type: string
      required:
        - id
      type: object
    aurora.core.apiengine.omsv1.FrontendOrder:
      description: >-
        Fields: order_ref, client_order_ref, cusip, side, order_status,
        order_type, order_intent, time_in_force_type, good_till_time, quantity,
        min_quantity, anonymous, fee, rebate, agreement_ids, open_quantity,
        total_exec_qty, avg_exec_fee, avg_exec_rebate, created_at, updated_at,
        company_id, created_by, last_updated_by, top_of_book, firm_quantity,
        ioi_quantity, allow_odd_lots
      properties:
        agreement_ids:
          description: Agreement ids
          items:
            type: string
          type: array
        allow_odd_lots:
          description: Allow odd lots
          type: boolean
        anonymous:
          description: Anonymous order
          type: boolean
        avg_exec_fee:
          description: |-
            Average rate (expressed as fee) of executed quantity so far
            Optional, only specified if there have been executions
          type: string
        avg_exec_rebate:
          description: |-
            Average rate (expressed as rebate) of executed quantity so far
            Optional, only specified if there have been executions
          type: string
        client_order_ref:
          description: >-
            Last known Unique order identifier used to create or modify the
            order assigned by Aurora user
          type: string
        company_id:
          description: Owner of the order
          type: string
        created_at:
          description: Order created at - time in RFC3339 with millisecond precision
          type: string
        created_by:
          description: Created by user
          type: string
        cusip:
          description: CUSIP
          type: string
        fee:
          description: |-
            Rate limit, expressed as fee
            Optional for certain order types: IOI
            And not applicable for certain order types: Market
          type: string
        firm_quantity:
          description: The number of shares exposed as Firm order
          format: int64
          type: string
        good_till_time:
          description: >-
            Custom expiry time (only required / used when time
            time_in_force_type=CUSTOM_EXPIRY

            Should be in the future

            Will be clipped to the end of day if it's set to later than end of
            day

            Time in RFC3339 with millisecond precision
          type: string
        ioi_quantity:
          description: The number of shares exposed as IOI order
          format: int64
          type: string
        last_updated_by:
          description: Last updated by user
          type: string
        min_quantity:
          description: Minimum quantity of shares per execution
          format: int64
          type: string
        open_quantity:
          description: Total quantity still available for matching
          format: int64
          type: string
        order_intent:
          $ref: '#/components/schemas/aurora.core.consts.oms.OrderIntent'
        order_ref:
          description: >-
            Provable Markets assigned order identifier for the order event
            notification
          type: string
        order_status:
          $ref: '#/components/schemas/aurora.core.consts.oms.OmsOrderStatus'
        order_type:
          $ref: '#/components/schemas/aurora.core.consts.oms.OmsOrderType'
        quantity:
          description: The number of shares on the original order
          format: int64
          type: string
        rebate:
          description: >-
            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
          type: string
        side:
          $ref: '#/components/schemas/aurora.core.consts.common.Side'
        time_in_force_type:
          $ref: '#/components/schemas/aurora.core.consts.oms.OmsTimeInForceType'
        top_of_book:
          $ref: '#/components/schemas/aurora.core.apiengine.omsv1.TopOfBookFields'
        total_exec_qty:
          description: Total executed quantity so far
          format: int64
          type: string
        updated_at:
          description: >-
            Order was last changed at - time in RFC3339 with millisecond
            precision
          type: string
      required:
        - order_ref
        - client_order_ref
        - cusip
        - side
        - order_status
        - order_type
        - order_intent
        - time_in_force_type
        - quantity
        - min_quantity
        - anonymous
        - open_quantity
        - total_exec_qty
        - created_at
        - updated_at
        - company_id
        - created_by
        - last_updated_by
        - firm_quantity
        - ioi_quantity
        - allow_odd_lots
      type: object
    aurora.core.apiengine.omsv1.GetActiveOrderCountRequest:
      type: object
    aurora.core.apiengine.omsv1.GetActiveOrderCountResponse:
      description: 'Fields: count'
      properties:
        count:
          format: int32
          type: integer
      required:
        - count
      type: object
    aurora.core.apiengine.omsv1.GetOrderRequest:
      description: 'Fields: id'
      properties:
        id:
          description: Unique identifier of the order
          type: string
      required:
        - id
      type: object
    aurora.core.apiengine.omsv1.GetOrderResponse:
      description: 'Fields: order'
      properties:
        order:
          $ref: '#/components/schemas/aurora.core.apiengine.omsv1.Order'
      required:
        - order
      type: object
    aurora.core.apiengine.omsv1.ListOrdersRequest:
      description: >-
        Fields: instrument_id, instrument_id_type, side, since, order_status,
        ids
      properties:
        ids:
          description: list of ids to filter orders by
          items:
            type: string
          type: array
        instrument_id:
          type: string
        instrument_id_type:
          $ref: '#/components/schemas/aurora.core.consts.oms.InstrumentIdType'
        order_status:
          $ref: '#/components/schemas/aurora.core.consts.oms.OmsOrderStatus'
        side:
          $ref: '#/components/schemas/aurora.core.consts.common.Side'
        since:
          description: >-
            DateTime for query to start looking for orders - time in RFC3339
            with millisecond precision
          type: string
      type: object
    aurora.core.apiengine.omsv1.ListOrdersResponse:
      description: 'Fields: orders'
      properties:
        orders:
          description: Detail(s) of one or more orders returned by Aurora
          items:
            $ref: '#/components/schemas/aurora.core.apiengine.omsv1.Order'
          type: array
      type: object
    aurora.core.apiengine.omsv1.ModifyOrderRequest:
      description: >-
        Fields: id, current_version_reference, new_version_reference, quantity,
        min_quantity, rate_limit, agreements_filter, active, time_in_force,
        good_till_time, external_id
      properties:
        active:
          description: If true the order goes to matching venue
          type: boolean
        agreements_filter:
          $ref: '#/components/schemas/aurora.core.apiengine.omsv1.AgreementsFilter'
        current_version_reference:
          description: >-
            Used for version control, the user can provide the last known
            version_reference to ensure any modifications are applied to the
            intended version.
          type: string
        external_id:
          description: >-
            Customer internal id that will be reflected on the order and can be
            used to query the order
          type: string
        good_till_time:
          description: >-
            Specific expiry time - only used (and required) with tif=GTT - time
            in RFC3339 with millisecond precision
          type: string
        id:
          description: >-
            The Provable Markets assigned order identifier for the order to be
            modified
          type: string
        min_quantity:
          description: The updated minimum quantity that you want set on the order.
          format: int64
          type: string
        new_version_reference:
          description: |-
            A new identifier to be assigned to the order.
            When provided needs to be a unique value within the past 12 hours,
            if the same value is observed then the request will be rejected.
          type: string
        quantity:
          description: |-
            The updated quantity you want on the order.
            Note: This will replace the current quantity and is not a delta.
          format: int64
          type: string
        rate_limit:
          $ref: '#/components/schemas/aurora.core.common.protos.RateLimit'
        time_in_force:
          $ref: '#/components/schemas/aurora.core.consts.oms.OmsTimeInForceType'
      required:
        - id
      type: object
    aurora.core.apiengine.omsv1.ModifyOrderResponse:
      description: 'Fields: id'
      properties:
        id:
          description: Provable Markets assigned order identifier for the order modified
          type: string
      required:
        - id
      type: object
    aurora.core.apiengine.omsv1.Order:
      description: >-
        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
      properties:
        agreement_ids:
          description: agreements set on the order
          items:
            type: string
          type: array
        allow_odd_lots:
          description: Allow odd lots
          type: boolean
        avg_execution_fee:
          description: Average fee of executed quantity so far
          type: string
        avg_execution_rebate:
          description: Average rebate of executed quantity so far
          type: string
        created_at:
          description: Order created at - time in RFC3339 with millisecond precision
          type: string
        created_by:
          description: Created by user
          type: string
        executions:
          description: List of executions on this Order
          items:
            $ref: '#/components/schemas/aurora.core.apiengine.executionsv1.Execution'
          type: array
        external_id:
          description: Customer internal id of the order
          type: string
        fee:
          description: |-
            Rate limit, expressed as fee
            Optional for certain order types: IOI
            And not applicable for certain order types: Market
          type: string
        firm_quantity:
          description: The number of shares exposed as Firm order
          format: int64
          type: string
        good_till_time:
          description: >-
            The time the order will be canceled if populated. Time in RFC3339
            with millisecond precision
          type: string
        id:
          description: >-
            Provable Markets assigned order identifier for the order event
            notification
          type: string
        instrument:
          $ref: '#/components/schemas/aurora.core.common.protos.PbInstrument'
        ioi_quantity:
          description: The number of shares exposed as IOI order
          format: int64
          type: string
        last_updated_by:
          description: Last updated by user
          type: string
        min_quantity:
          description: The minimum quantity on the order.
          format: int64
          type: string
        open_quantity:
          description: The number of shares still open on the order
          format: int64
          type: string
        order_intent:
          $ref: '#/components/schemas/aurora.core.consts.oms.OrderIntent'
        order_status:
          $ref: '#/components/schemas/aurora.core.consts.oms.OmsOrderStatus'
        order_type:
          $ref: '#/components/schemas/aurora.core.consts.oms.OmsOrderType'
        quantity:
          description: The number of shares on the original order
          format: int64
          type: string
        rebate:
          description: >-
            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
          type: string
        side:
          $ref: '#/components/schemas/aurora.core.consts.common.Side'
        time_in_force:
          $ref: '#/components/schemas/aurora.core.consts.oms.OmsTimeInForceType'
        total_execution_quantity:
          description: Total shares executed on order so far
          format: int64
          type: string
        updated_at:
          description: >-
            Order was last changed at - time in RFC3339 with millisecond
            precision
          type: string
        version_reference:
          description: >-
            An identifier provided by the user to help associate with any
            internal references.
          type: string
      required:
        - id
        - version_reference
        - instrument
        - side
        - order_status
        - order_type
        - order_intent
        - time_in_force
        - quantity
        - min_quantity
        - open_quantity
        - total_execution_quantity
        - created_at
        - updated_at
        - created_by
        - last_updated_by
        - firm_quantity
        - ioi_quantity
        - allow_odd_lots
      type: object
    aurora.core.apiengine.omsv1.OrderCanceledEvent:
      description: 'Fields: request_id, order'
      properties:
        order:
          $ref: '#/components/schemas/aurora.core.apiengine.omsv1.Order'
        request_id:
          description: Unique request identifier assigned to the event
          type: string
      required:
        - request_id
        - order
      type: object
    aurora.core.apiengine.omsv1.OrderClosedEvent:
      description: 'Fields: request_id, order'
      properties:
        order:
          $ref: '#/components/schemas/aurora.core.apiengine.omsv1.Order'
        request_id:
          description: Unique request identifier assigned to the event
          type: string
      required:
        - request_id
        - order
      type: object
    aurora.core.apiengine.omsv1.OrderCreatedEvent:
      description: 'Fields: request_id, order'
      properties:
        order:
          $ref: '#/components/schemas/aurora.core.apiengine.omsv1.Order'
        request_id:
          description: Unique request identifier assigned to the event
          type: string
      required:
        - request_id
        - order
      type: object
    aurora.core.apiengine.omsv1.OrderExecutedEvent:
      description: 'Fields: request_id, execution, order'
      properties:
        execution:
          $ref: '#/components/schemas/aurora.core.apiengine.executionsv1.Execution'
        order:
          $ref: '#/components/schemas/aurora.core.apiengine.omsv1.Order'
        request_id:
          description: Unique request identifier assigned to the event
          type: string
      required:
        - request_id
        - execution
        - order
      type: object
    aurora.core.apiengine.omsv1.OrderExpiredEvent:
      description: 'Fields: request_id, order'
      properties:
        order:
          $ref: '#/components/schemas/aurora.core.apiengine.omsv1.Order'
        request_id:
          description: Unique request identifier assigned to the event
          type: string
      required:
        - request_id
        - order
      type: object
    aurora.core.apiengine.omsv1.OrderModifiedEvent:
      description: 'Fields: request_id, order'
      properties:
        order:
          $ref: '#/components/schemas/aurora.core.apiengine.omsv1.Order'
        request_id:
          description: Unique request identifier assigned to the event
          type: string
      required:
        - request_id
        - order
      type: object
    aurora.core.apiengine.omsv1.QueryOrdersFilter:
      description: >-
        Fields: offset_in_minutes_from_utc, show_all, order_ref,
        version_reference, ticker, cusip, security_name, security_type, side,
        order_status, has_executed, order_type, order_intent, company_id,
        agreement_ids, open_quantity, exec_quantity, total_quantity,
        min_quantity, fee, rebate, avg_execution_fee, avg_execution_rebate,
        created_at, created_by, updated_at, last_updated_by, unit_price,
        price_change, open_market_value, time_in_force, good_till_time,
        bo_quantity, bo_fee, bo_rebate, bb_quantity, bb_fee, bb_rebate,
        bbo_quantity, bbo_fee, bbo_rebate, bbo_spread_pct_rebate,
        bbo_spread_vs_fee, bbo_spread_vs_rebate, bbo_agreement_ids
      properties:
        agreement_ids:
          $ref: '#/components/schemas/aurora.core.consts.query.StringSetFilter'
        avg_execution_fee:
          $ref: '#/components/schemas/aurora.core.consts.query.DecimalFilter'
        avg_execution_rebate:
          $ref: '#/components/schemas/aurora.core.consts.query.DecimalFilter'
        bb_fee:
          $ref: '#/components/schemas/aurora.core.consts.query.DecimalFilter'
        bb_quantity:
          $ref: '#/components/schemas/aurora.core.consts.query.BigintFilter'
        bb_rebate:
          $ref: '#/components/schemas/aurora.core.consts.query.DecimalFilter'
        bbo_agreement_ids:
          $ref: '#/components/schemas/aurora.core.consts.query.StringSetFilter'
        bbo_fee:
          $ref: '#/components/schemas/aurora.core.consts.query.DecimalFilter'
        bbo_quantity:
          $ref: '#/components/schemas/aurora.core.consts.query.BigintFilter'
        bbo_rebate:
          $ref: '#/components/schemas/aurora.core.consts.query.DecimalFilter'
        bbo_spread_pct_rebate:
          $ref: '#/components/schemas/aurora.core.consts.query.DecimalFilter'
        bbo_spread_vs_fee:
          $ref: '#/components/schemas/aurora.core.consts.query.DecimalFilter'
        bbo_spread_vs_rebate:
          $ref: '#/components/schemas/aurora.core.consts.query.DecimalFilter'
        bo_fee:
          $ref: '#/components/schemas/aurora.core.consts.query.DecimalFilter'
        bo_quantity:
          $ref: '#/components/schemas/aurora.core.consts.query.BigintFilter'
        bo_rebate:
          $ref: '#/components/schemas/aurora.core.consts.query.DecimalFilter'
        company_id:
          $ref: '#/components/schemas/aurora.core.consts.query.StringFilter'
        created_at:
          $ref: '#/components/schemas/aurora.core.consts.query.DateFilter'
        created_by:
          $ref: '#/components/schemas/aurora.core.consts.query.StringFilter'
        cusip:
          $ref: '#/components/schemas/aurora.core.consts.query.StringFilter'
        exec_quantity:
          $ref: '#/components/schemas/aurora.core.consts.query.BigintFilter'
        fee:
          $ref: '#/components/schemas/aurora.core.consts.query.DecimalFilter'
        good_till_time:
          $ref: '#/components/schemas/aurora.core.consts.query.DateFilter'
        has_executed:
          description: Only return orders that are (partial) executed - optional
          type: boolean
        last_updated_by:
          $ref: '#/components/schemas/aurora.core.consts.query.StringFilter'
        min_quantity:
          $ref: '#/components/schemas/aurora.core.consts.query.BigintFilter'
        offset_in_minutes_from_utc:
          description: >-
            AgGrid provides the offset from UTC for the current browser session

            This must be used to shift the DateFilters to UTC and is therefore
            mandatory
          format: int32
          type: integer
        open_market_value:
          $ref: '#/components/schemas/aurora.core.consts.query.DecimalFilter'
        open_quantity:
          $ref: '#/components/schemas/aurora.core.consts.query.BigintFilter'
        order_intent:
          $ref: '#/components/schemas/aurora.core.consts.query.OrderIntentFilter'
        order_ref:
          $ref: '#/components/schemas/aurora.core.consts.query.StringFilter'
        order_status:
          $ref: '#/components/schemas/aurora.core.consts.query.OrderStatusSetFilter'
        order_type:
          $ref: '#/components/schemas/aurora.core.consts.query.OrderTypeFilter'
        price_change:
          $ref: '#/components/schemas/aurora.core.consts.query.DecimalFilter'
        rebate:
          $ref: '#/components/schemas/aurora.core.consts.query.DecimalFilter'
        security_name:
          $ref: '#/components/schemas/aurora.core.consts.query.StringFilter'
        security_type:
          $ref: '#/components/schemas/aurora.core.consts.query.StringFilter'
        show_all:
          description: Include expired orders?
          type: boolean
        side:
          $ref: '#/components/schemas/aurora.core.consts.query.SideFilter'
        ticker:
          $ref: '#/components/schemas/aurora.core.consts.query.StringFilter'
        time_in_force:
          $ref: '#/components/schemas/aurora.core.consts.query.TimeInForceFilter'
        total_quantity:
          $ref: '#/components/schemas/aurora.core.consts.query.BigintFilter'
        unit_price:
          $ref: '#/components/schemas/aurora.core.consts.query.DecimalFilter'
        updated_at:
          $ref: '#/components/schemas/aurora.core.consts.query.DateFilter'
        version_reference:
          $ref: '#/components/schemas/aurora.core.consts.query.StringFilter'
      required:
        - offset_in_minutes_from_utc
      type: object
    aurora.core.apiengine.omsv1.QueryOrdersRequest:
      description: 'Fields: filter, sorts, page_number, page_limit'
      properties:
        filter:
          $ref: '#/components/schemas/aurora.core.apiengine.omsv1.QueryOrdersFilter'
        page_limit:
          description: Number of orders per page
          format: int32
          type: integer
        page_number:
          description: Page number, 1 being the starting one
          format: int32
          type: integer
        sorts:
          description: List of sorting options
          items:
            $ref: '#/components/schemas/aurora.core.apiengine.omsv1.QueryOrdersSort'
          type: array
      type: object
    aurora.core.apiengine.omsv1.QueryOrdersResponse:
      description: 'Fields: request_id, instruments, agreements, orders, total_count'
      properties:
        agreements:
          $ref: '#/components/schemas/aurora.core.common.protos.PbAgreementInfo'
        instruments:
          $ref: '#/components/schemas/aurora.core.common.protos.PbInstrumentInfo'
        orders:
          description: List of OMS orders
          items:
            $ref: '#/components/schemas/aurora.core.apiengine.omsv1.FrontendOrder'
          type: array
        request_id:
          description: Unique request identifier assigned by Aurora user
          type: string
        total_count:
          description: Total number of orders
          format: int32
          type: integer
      required:
        - request_id
        - instruments
        - agreements
        - total_count
      type: object
    aurora.core.apiengine.omsv1.QueryOrdersSort:
      description: 'Fields: field, order'
      properties:
        field:
          $ref: '#/components/schemas/aurora.core.consts.query.SortableField'
        order:
          $ref: '#/components/schemas/aurora.core.consts.query.SortOrder'
      required:
        - field
        - order
      type: object
    aurora.core.apiengine.omsv1.SplitOrderRequest:
      description: 'Fields: id, quantity, rate_limit, agreement_ids'
      properties:
        agreement_ids:
          items:
            type: string
          type: array
        id:
          type: string
        quantity:
          format: int64
          type: string
        rate_limit:
          $ref: '#/components/schemas/aurora.core.common.protos.RateLimit'
      required:
        - id
        - quantity
        - rate_limit
      type: object
    aurora.core.apiengine.omsv1.SplitOrderResponse:
      description: 'Fields: id'
      properties:
        id:
          type: string
      required:
        - id
      type: object
    aurora.core.apiengine.omsv1.TopOfBookFields:
      description: >-
        Fields: bo_quantity, bo_fee, bo_rebate, bb_quantity, bb_fee, bb_rebate,
        bbo_quantity, bbo_fee, bbo_rebate, bbo_spread_pct_rebate,
        bbo_spread_vs_fee, bbo_spread_vs_rebate, bbo_agreement_ids
      properties:
        bb_fee:
          type: string
        bb_quantity:
          format: int64
          type: string
        bb_rebate:
          type: string
        bbo_agreement_ids:
          items:
            type: string
          type: array
        bbo_fee:
          type: string
        bbo_quantity:
          format: int64
          type: string
        bbo_rebate:
          type: string
        bbo_spread_pct_rebate:
          type: string
        bbo_spread_vs_fee:
          type: string
        bbo_spread_vs_rebate:
          type: string
        bo_fee:
          type: string
        bo_quantity:
          format: int64
          type: string
        bo_rebate:
          type: string
      type: object
    aurora.core.common.protos.Currency:
      enum:
        - USD
        - CAD
        - GBP
        - EUR
        - JPY
      type: string
    aurora.core.common.protos.ErrDetail:
      description: 'Fields: reason'
      properties:
        reason:
          type: string
      required:
        - reason
      type: object
    aurora.core.common.protos.PbActioningUser:
      description: 'Fields: user_identifier, user_type, public_identifier'
      properties:
        public_identifier:
          type: string
        user_identifier:
          type: string
        user_type:
          $ref: '#/components/schemas/aurora.core.common.protos.UserType'
      required:
        - user_identifier
        - user_type
        - public_identifier
      type: object
    aurora.core.common.protos.PbActioningUserWithSide:
      description: 'Fields: db_user_id, side, external_id'
      properties:
        db_user_id:
          type: string
        external_id:
          type: string
        side:
          $ref: '#/components/schemas/aurora.core.consts.common.Side'
      required:
        - db_user_id
        - side
      type: object
    aurora.core.common.protos.PbAgreementInfo:
      description: 'Fields: id, display_id, short_name'
      properties:
        display_id:
          type: string
        id:
          type: string
        short_name:
          type: string
      required:
        - id
        - display_id
        - short_name
      type: object
    aurora.core.common.protos.PbCompanyInfo:
      description: >-
        Fields: company_id, company_name, nscc_account_id, display_id,
        preferred_collateral_rate, cut_off_time, enabled_settlement_types,
        trading_permissions
      properties:
        company_id:
          type: string
        company_name:
          type: string
        cut_off_time:
          type: string
        display_id:
          type: string
        enabled_settlement_types:
          items:
            $ref: '#/components/schemas/aurora.core.consts.settlement.SettlementType'
          type: array
        nscc_account_id:
          type: string
        preferred_collateral_rate:
          type: string
        trading_permissions:
          $ref: '#/components/schemas/aurora.core.common.protos.PbTradingPermissions'
      required:
        - company_id
        - company_name
        - nscc_account_id
        - display_id
        - trading_permissions
      type: object
    aurora.core.common.protos.PbDate:
      description: 'Fields: year, month, day'
      properties:
        day:
          format: int32
          type: integer
        month:
          format: int32
          type: integer
        year:
          format: int32
          type: integer
      required:
        - year
        - month
        - day
      type: object
    aurora.core.common.protos.PbDecimal:
      description: 'Fields: sign, exponent, coefficient'
      properties:
        coefficient:
          format: byte
          type: string
        exponent:
          format: int32
          type: integer
        sign:
          format: int32
          type: integer
      required:
        - sign
        - exponent
        - coefficient
      type: object
    aurora.core.common.protos.PbInstrument:
      description: >-
        Instruments can be identified by their CUSIP or Ticker Symbol<br>Fields:
        cusip, ticker, name
      properties:
        cusip:
          description: CUSIP
          type: string
        name:
          description: Security name
          type: string
        ticker:
          description: Ticker
          type: string
      required:
        - cusip
        - ticker
        - name
      type: object
    aurora.core.common.protos.PbInstrumentInfo:
      description: >-
        Instrument details<br>Fields: cusip, ticker, name, security_type,
        last_close_price, cannot_trade_message, price_currency, id
      properties:
        cannot_trade_message:
          description: Reason why instruments is (temporarily) disabled from trading
          type: string
        cusip:
          description: >-
            A **CUSIP** number is a unique identification number assigned to
            stocks and registered bonds in the United States and Canada.

            It comprises nine characters and includes letters and numbers.

            Example: use `02079K305` for `Alphabet Inc` (formerly known as
            Google)
          type: string
        id:
          description: DB ID (not always provided)
          type: string
        last_close_price:
          description: Last close price (not always provided)
          type: string
        name:
          description: Name of the instrument
          type: string
        price_currency:
          $ref: '#/components/schemas/aurora.core.common.protos.Currency'
        security_type:
          description: Type of Security (Common Stock, Preferred Stock, ...)
          type: string
        ticker:
          description: >-
            A stock symbol (*ticker*) is an arrangement of characters (*usually
            letters*) representing publicly-traded securities on an exchange.

            When a company issues securities to the public marketplace, it
            selects an available symbol for its shares, often related to the
            company name.

            Example: use `AAPL` for `Apple Computers Inc.`
          type: string
      required:
        - cusip
        - ticker
        - name
      type: object
    aurora.core.common.protos.PbRateDetails:
      description: 'Fields: rate, benchmark'
      properties:
        benchmark:
          $ref: '#/components/schemas/aurora.core.consts.benchmark.Benchmark'
        rate:
          type: string
      required:
        - rate
      type: object
    aurora.core.common.protos.PbTradingPermissions:
      enum:
        - LENDER
        - BORROWER
        - LENDER_OR_BORROWER
        - DISABLED
      type: string
    aurora.core.common.protos.RateLimit:
      description: 'Fields: type, value'
      properties:
        type:
          $ref: '#/components/schemas/aurora.core.common.protos.RateType'
        value:
          type: string
      required:
        - type
        - value
      type: object
    aurora.core.common.protos.RateType:
      enum:
        - REBATE
        - FEE
      type: string
    aurora.core.common.protos.SettlementTransactionDetails:
      description: >-
        Fields: cusip, quantity, amount, status, recipient_of_message,
        deliverer, receiver, transaction_id, op_id
      properties:
        amount:
          $ref: '#/components/schemas/aurora.core.common.protos.PbDecimal'
        cusip:
          type: string
        deliverer:
          type: string
        op_id:
          description: >-
            aurora defined id, identifying the contract operation resulting in
            this DO/PO operation
          type: string
        quantity:
          format: int64
          type: string
        receiver:
          type: string
        recipient_of_message:
          type: string
        status:
          type: string
        transaction_id:
          description: received from DTCC, identifying this DO/PO operation
          type: string
      required:
        - cusip
        - quantity
        - amount
        - status
        - recipient_of_message
        - deliverer
        - receiver
        - transaction_id
      type: object
    aurora.core.common.protos.UserType:
      enum:
        - UNKNOWN_TYPE
        - SYSTEM
        - BOT_USER
        - TRADER
        - CONTRA
        - EXTERNAL_TRADER
      type: string
    aurora.core.consts.ContractStatus:
      description: possible states in the lifecycle of a contract
      enum:
        - NEW
        - PENDING
        - REJECTED
        - DROPPED
        - CANCELED
        - OPEN
        - CLOSED
        - TERMINATED
        - UNDER_CORP_ACTION
        - ROLL_PENDING
        - CANCEL_ROLL_PENDING
        - CANCEL_RETURN_PENDING
        - CANCEL_NEW_LOAN_PENDING
        - ERROR
      type: string
    aurora.core.consts.RoundingRule:
      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
      type: string
    aurora.core.consts.agreements.AgreementStatus:
      description: possible agreement status
      enum:
        - AGREEMENT_STATUS_UNSPECIFIED
        - DRAFT
        - ACTIVE
        - REJECTED
        - CANCELED
        - INACTIVE
      type: string
    aurora.core.consts.agreements.CollateralMethod:
      enum:
        - COLLATERAL_METHOD_UNSPECIFIED
        - PLEDGE
        - TITLE_TRANSFER
      type: string
    aurora.core.consts.agreements.CollateralType:
      enum:
        - COLLATERAL_TYPE_UNSPECIFIED
        - CASH
        - NON_CASH_UST
        - NON_CASH_EQ
        - NON_CASH_JGB
      type: string
    aurora.core.consts.agreements.DeliveryType:
      enum:
        - DELIVERY_TYPE_UNSPECIFIED
        - DVP
        - FOP
      type: string
    aurora.core.consts.agreements.SettlementSystem:
      enum:
        - SETTLEMENT_SYSTEM_UNSPECIFIED
        - PROVABLE_MARKET
        - LOANET
        - LOANET_SFT
        - SPIRE
        - PROP
      type: string
    aurora.core.consts.agreements.TermType:
      enum:
        - TERM_TYPE_UNSPECIFIED
        - NONE
        - FIXED
        - EVERGREEN
        - ONE_DAY
        - BULLET
      type: string
    aurora.core.consts.benchmark.Benchmark:
      description: possible rate benchmarks
      enum:
        - OBFR
        - EFFR
        - SOFR
        - BGCR
        - TGCR
        - IORB
      type: string
    aurora.core.consts.common.Side:
      enum:
        - BORROW
        - LOAN
      type: string
    aurora.core.consts.oms.InstrumentIdType:
      enum:
        - CUSIP
        - TICKER
      type: string
    aurora.core.consts.oms.OmsOrderStatus:
      enum:
        - OPEN
        - FILLED
        - CANCELED
        - EXPIRED
        - TERMINATED
        - HELD
        - FORCE_CANCELED
      type: string
    aurora.core.consts.oms.OmsOrderType:
      enum:
        - LIMIT
      type: string
    aurora.core.consts.oms.OmsTimeInForceType:
      enum:
        - DAY
        - GOOD_TILL_CANCEL
        - IMMEDIATE_OR_CANCEL
        - FILL_OR_KILL
        - GOOD_TILL_TIME
      type: string
    aurora.core.consts.oms.OrderIntent:
      enum:
        - FIRM
        - IOI
      type: string
    aurora.core.consts.oms.RoutingStatus:
      description: deprecated
      enum:
        - ROUTED
        - UNROUTED
        - PENDING
      type: string
    aurora.core.consts.query.BigintFilter:
      description: 'Fields: type, filter, filter_to'
      properties:
        filter:
          format: int64
          type: string
        filter_to:
          format: int64
          type: string
        type:
          type: string
      required:
        - type
        - filter
      type: object
    aurora.core.consts.query.BooleanFilter:
      description: 'Fields: type, filter'
      properties:
        filter:
          type: boolean
        type:
          type: string
      required:
        - type
        - filter
      type: object
    aurora.core.consts.query.DateFilter:
      description: 'Fields: type, date_from, date_to'
      properties:
        date_from:
          type: string
        date_to:
          type: string
        type:
          type: string
      required:
        - type
      type: object
    aurora.core.consts.query.DecimalFilter:
      description: 'Fields: type, filter, filter_to'
      properties:
        filter:
          type: string
        filter_to:
          type: string
        type:
          type: string
      required:
        - type
        - filter
      type: object
    aurora.core.consts.query.OrderIntentFilter:
      description: 'Fields: type, filter'
      properties:
        filter:
          $ref: '#/components/schemas/aurora.core.consts.oms.OrderIntent'
        type:
          type: string
      required:
        - type
        - filter
      type: object
    aurora.core.consts.query.OrderStatusFilterField:
      description: 'Fields: order_status, has_executed'
      properties:
        has_executed:
          type: boolean
        order_status:
          $ref: '#/components/schemas/aurora.core.consts.oms.OmsOrderStatus'
      required:
        - order_status
      type: object
    aurora.core.consts.query.OrderStatusSetFilter:
      description: 'Fields: type, values'
      properties:
        type:
          type: string
        values:
          items:
            $ref: >-
              #/components/schemas/aurora.core.consts.query.OrderStatusFilterField
          type: array
      required:
        - type
      type: object
    aurora.core.consts.query.OrderTypeFilter:
      description: 'Fields: type, filter'
      properties:
        filter:
          $ref: '#/components/schemas/aurora.core.consts.oms.OmsOrderType'
        type:
          type: string
      required:
        - type
        - filter
      type: object
    aurora.core.consts.query.RoutingStatusFilter:
      description: 'Fields: type, filter'
      properties:
        filter:
          $ref: '#/components/schemas/aurora.core.consts.oms.RoutingStatus'
        type:
          type: string
      required:
        - type
        - filter
      type: object
    aurora.core.consts.query.SideFilter:
      description: 'Fields: type, filter'
      properties:
        filter:
          $ref: '#/components/schemas/aurora.core.consts.common.Side'
        type:
          type: string
      required:
        - type
        - filter
      type: object
    aurora.core.consts.query.SortOrder:
      enum:
        - ASC
        - DESC
      type: string
    aurora.core.consts.query.SortableField:
      enum:
        - STATUS
        - CREATED_AT
        - CREATED_BY
        - UPDATED_AT
        - LAST_UPDATED_BY
        - SIDE
        - ROUTING_STATUS
        - INSTRUMENT_TICKER
        - INSTRUMENT_CUSIP
        - OPEN_QUANTITY
        - FILLED_QUANTITY
        - TOTAL_QUANTITY
        - FEE
        - REBATE
        - AVG_EXEC_FEE
        - AVG_EXEC_REBATE
        - TYPE
        - TIME_IN_FORCE
        - MIN_QUANTITY
        - COMPANY_NAME
        - SECURITY_NAME
        - SECURITY_TYPE
        - GOOD_TILL_TIME
        - AGREEMENTS
        - UNIT_PRICE
        - PRICE_CHANGE
        - OPEN_MARKET_VALUE
        - ORDER_REF
        - BO_QUANTITY
        - BO_FEE
        - BO_REBATE
        - BB_QUANTITY
        - BB_FEE
        - BB_REBATE
        - BBO_QUANTITY
        - BBO_FEE
        - BBO_REBATE
        - BBO_SPREAD_PCT_REBATE
        - BBO_SPREAD_VS_FEE
        - BBO_SPREAD_VS_REBATE
        - BBO_AGREEMENT
      type: string
    aurora.core.consts.query.StringFilter:
      description: 'Fields: type, filter, filter_to'
      properties:
        filter:
          type: string
        filter_to:
          type: string
        type:
          type: string
      required:
        - type
        - filter
      type: object
    aurora.core.consts.query.StringSetFilter:
      description: 'Fields: values'
      properties:
        values:
          items:
            type: string
          type: array
      type: object
    aurora.core.consts.query.TimeInForceFilter:
      description: 'Fields: type, filter'
      properties:
        filter:
          $ref: '#/components/schemas/aurora.core.consts.oms.OmsTimeInForceType'
        type:
          type: string
      required:
        - type
        - filter
      type: object
    aurora.core.consts.settlement.SettlementType:
      enum:
        - NSCC
        - BILATERAL
      type: string
    google.protobuf.Empty:
      description: >-
        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);

        }
      type: object
    aurora.core.apiengine.reportingv1.CompanyReportItem:
      description: >-
        Fields: report_type, report_name, last_delivery_time,
        last_download_time, last_delivery_success, last_delivery_error,
        recurring
      properties:
        last_delivery_error:
          type: string
        last_delivery_success:
          type: boolean
        last_delivery_time:
          format: date-time
          type: string
        last_download_time:
          format: date-time
          type: string
        recurring:
          type: boolean
        report_name:
          type: string
        report_type:
          type: string
      required:
        - report_type
        - report_name
        - last_delivery_success
        - last_delivery_error
        - recurring
      type: object
    aurora.core.apiengine.reportingv1.ListCompanyReportsRequest:
      description: 'Fields: company_id'
      properties:
        company_id:
          type: string
      required:
        - company_id
      type: object
    aurora.core.apiengine.reportingv1.ListCompanyReportsResponse:
      description: 'Fields: reports'
      properties:
        reports:
          items:
            $ref: >-
              #/components/schemas/aurora.core.apiengine.reportingv1.CompanyReportItem
          type: array
      type: object
    google.protobuf.Timestamp:
      description: >-
        A Timestamp represents a point in time independent of any time zone or
        local

        calendar, encoded as a count of seconds and fractions of seconds at

        nanosecond resolution. The count is relative to an epoch at UTC midnight
        on

        January 1, 1970, in the proleptic Gregorian calendar which extends the

        Gregorian calendar backwards to year one.


        All minutes are 60 seconds long. Leap seconds are "smeared" so that no
        leap

        second table is needed for interpretation, using a [24-hour linear

        smear](https://developers.google.com/time/smear).


        The range is from 0001-01-01T00:00:00Z to
        9999-12-31T23:59:59.999999999Z. By

        restricting to that range, we ensure that we can convert to and from
        [RFC

        3339](https://www.ietf.org/rfc/rfc3339.txt) date strings.


        # Examples


        Example 1: Compute Timestamp from POSIX `time()`.


        Timestamp timestamp;

        timestamp.set_seconds(time(NULL));

        timestamp.set_nanos(0);


        Example 2: Compute Timestamp from POSIX `gettimeofday()`.


        struct timeval tv;

        gettimeofday(&tv, NULL);


        Timestamp timestamp;

        timestamp.set_seconds(tv.tv_sec);

        timestamp.set_nanos(tv.tv_usec * 1000);


        Example 3: Compute Timestamp from Win32 `GetSystemTimeAsFileTime()`.


        FILETIME ft;

        GetSystemTimeAsFileTime(&ft);

        UINT64 ticks = (((UINT64)ft.dwHighDateTime) << 32) | ft.dwLowDateTime;


        // A Windows tick is 100 nanoseconds. Windows epoch 1601-01-01T00:00:00Z

        // is 11644473600 seconds before Unix epoch 1970-01-01T00:00:00Z.

        Timestamp timestamp;

        timestamp.set_seconds((INT64) ((ticks / 10000000) - 11644473600LL));

        timestamp.set_nanos((INT32) ((ticks % 10000000) * 100));


        Example 4: Compute Timestamp from Java `System.currentTimeMillis()`.


        long millis = System.currentTimeMillis();


        Timestamp timestamp = Timestamp.newBuilder().setSeconds(millis / 1000)

        .setNanos((int) ((millis % 1000) * 1000000)).build();


        Example 5: Compute Timestamp from Java `Instant.now()`.


        Instant now = Instant.now();


        Timestamp timestamp =

        Timestamp.newBuilder().setSeconds(now.getEpochSecond())

        .setNanos(now.getNano()).build();


        Example 6: Compute Timestamp from current time in Python.


        timestamp = Timestamp()

        timestamp.GetCurrentTime()


        # JSON Mapping


        In JSON format, the Timestamp type is encoded as a string in the

        [RFC 3339](https://www.ietf.org/rfc/rfc3339.txt) format. That is, the

        format is "{year}-{month}-{day}T{hour}:{min}:{sec}[.{frac_sec}]Z"

        where {year} is always expressed using four digits while {month}, {day},

        {hour}, {min}, and {sec} are zero-padded to two digits each. The
        fractional

        seconds, which can go up to 9 digits (i.e. up to 1 nanosecond
        resolution),

        are optional. The "Z" suffix indicates the timezone ("UTC"); the
        timezone

        is required. A proto3 JSON serializer should always use UTC (as
        indicated by

        "Z") when printing the Timestamp type and a proto3 JSON parser should be

        able to accept both UTC and other timezones (as indicated by an offset).


        For example, "2017-01-15T01:30:15.01Z" encodes 15.01 seconds past

        01:30 UTC on January 15, 2017.


        In JavaScript, one can convert a Date object to this format using the

        standard

        [toISOString()](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date/toISOString)

        method. In Python, a standard `datetime.datetime` object can be
        converted

        to this format using

        [`strftime`](https://docs.python.org/2/library/time.html#time.strftime)
        with

        the time format spec '%Y-%m-%dT%H:%M:%S.%fZ'. Likewise, in Java, one can
        use

        the Joda Time's [`ISODateTimeFormat.dateTime()`](

        http://joda-time.sourceforge.net/apidocs/org/joda/time/format/ISODateTimeFormat.html#dateTime()

        ) to obtain a formatter capable of generating timestamps in this
        format.<br>Fields: seconds, nanos
      properties:
        nanos:
          description: >-
            Non-negative fractions of a second at nanosecond resolution.
            Negative

            second values with fractions must still have non-negative nanos
            values

            that count forward in time. Must be from 0 to 999,999,999

            inclusive.
          format: int32
          type: integer
        seconds:
          description: |-
            Represents seconds of UTC time since Unix epoch
            1970-01-01T00:00:00Z. Must be from 0001-01-01T00:00:00Z to
            9999-12-31T23:59:59Z inclusive.
          format: int64
          type: string
      required:
        - seconds
        - nanos
      type: object
    aurora.core.apiengine.contractsv1.AcceptAwaitingContractReturnRequest:
      description: 'Fields: request_id, id'
      properties:
        id:
          description: >-
            Return identifier (persistent identifier inside Aurora system for
            the return)
          type: string
        request_id:
          description: >-
            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.
          type: string
      required:
        - id
      type: object
    aurora.core.apiengine.contractsv1.AcceptAwaitingContractReturnResponse:
      description: 'Fields: id'
      properties:
        id:
          description: >-
            Return identifier (persistent identifier inside Aurora system for
            the return)
          type: string
      required:
        - id
      type: object
    aurora.core.apiengine.contractsv1.BuyIn:
      description: 'Fields: id, contract_id, quantity, price, status'
      properties:
        contract_id:
          description: Contract identifier (persistent identifier inside Aurora system)
          type: string
        id:
          description: >-
            Buy-in identifier (persistent identifier inside Aurora system for
            the return)
          type: string
        price:
          description: Average price of the shares bought-in
          type: string
        quantity:
          description: Amount of shares being bought-in
          format: int64
          type: string
        status:
          $ref: >-
            #/components/schemas/aurora.core.consts.contractbuyin.ContractBuyInStatus
      required:
        - id
        - contract_id
        - quantity
        - price
        - status
      type: object
    aurora.core.apiengine.contractsv1.BuyInContractRequest:
      description: 'Fields: request_id, id, quantity, avg_price_per_share'
      properties:
        avg_price_per_share:
          description: Average price per share for buy-in
          type: string
        id:
          description: >-
            Contract identifier (persistent contract identifier inside Aurora
            system)
          type: string
        quantity:
          description: Amount of shares to buy-in
          format: int64
          type: string
        request_id:
          description: >-
            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.
          type: string
      required:
        - id
        - quantity
        - avg_price_per_share
      type: object
    aurora.core.apiengine.contractsv1.BuyInContractResponse:
      description: 'Returns current status of the `BuyIn` request<br>Fields: buyin'
      properties:
        buyin:
          $ref: '#/components/schemas/aurora.core.apiengine.contractsv1.BuyIn'
      required:
        - buyin
      type: object
    aurora.core.apiengine.contractsv1.CancelAllPendingReturnsRequest:
      description: 'Fields: request_id, contract_id'
      properties:
        contract_id:
          description: >-
            Contract identifier (persistent contract identifier inside Aurora
            system)
          type: string
        request_id:
          description: >-
            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.
          type: string
      required:
        - contract_id
      type: object
    aurora.core.apiengine.contractsv1.CancelAllPendingReturnsResponse:
      description: 'Fields: contract_id'
      properties:
        contract_id:
          description: >-
            Contract identifier (persistent contract identifier inside Aurora
            system)
          type: string
      required:
        - contract_id
      type: object
    aurora.core.apiengine.contractsv1.CancelAllRecallsRequest:
      description: 'Fields: request_id, id'
      properties:
        id:
          description: Contract identifier (persistent identifier inside Aurora system)
          type: string
        request_id:
          description: >-
            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.
          type: string
      required:
        - id
      type: object
    aurora.core.apiengine.contractsv1.CancelAllRecallsResponse:
      description: 'Fields: id'
      properties:
        id:
          description: >-
            Contract identifier (persistent contract identifier inside Aurora
            system)
          type: string
      required:
        - id
      type: object
    aurora.core.apiengine.contractsv1.CancelAwaitingContractReturnRequest:
      description: 'Fields: request_id, id'
      properties:
        id:
          description: >-
            Return identifier (persistent identifier inside Aurora system for
            the return)
          type: string
        request_id:
          description: >-
            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.
          type: string
      required:
        - id
      type: object
    aurora.core.apiengine.contractsv1.CancelAwaitingContractReturnResponse:
      description: 'Fields: id'
      properties:
        id:
          description: >-
            Return identifier (persistent identifier inside Aurora system for
            the return)
          type: string
      required:
        - id
      type: object
    aurora.core.apiengine.contractsv1.CancelContractRequest:
      description: 'Fields: request_id, id'
      properties:
        id:
          description: Contract identifier (persistent identifier inside Aurora system)
          type: string
        request_id:
          description: User populated id of this request
          type: string
      required:
        - id
      type: object
    aurora.core.apiengine.contractsv1.CancelContractResponse:
      description: 'Fields: id'
      properties:
        id:
          description: Contract identifier (persistent identifier inside Aurora system)
          type: string
      required:
        - id
      type: object
    aurora.core.apiengine.contractsv1.CancelRecallContractRequest:
      description: 'Fields: request_id, id, contract_id'
      properties:
        contract_id:
          description: Contract identifier (persistent identifier inside Aurora system)
          type: string
        id:
          description: >-
            Identifier of the recall to cancel (persistent identifier inside
            Aurora system)
          type: string
        request_id:
          description: >-
            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.
          type: string
      required:
        - id
        - contract_id
      type: object
    aurora.core.apiengine.contractsv1.CancelRecallContractResponse:
      description: 'Fields: recall'
      properties:
        recall:
          $ref: '#/components/schemas/aurora.core.apiengine.contractsv1.Recall'
      required:
        - recall
      type: object
    aurora.core.apiengine.contractsv1.CancelSinglePendingReturnRequest:
      description: 'Fields: request_id, contract_id, id'
      properties:
        contract_id:
          description: Contract identifier (persistent contract id inside Aurora system)
          type: string
        id:
          description: >-
            Return identifier to be canceled (persistent identifier inside
            Aurora system for the return)
          type: string
        request_id:
          description: >-
            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.
          type: string
      required:
        - contract_id
        - id
      type: object
    aurora.core.apiengine.contractsv1.CancelSinglePendingReturnResponse:
      description: 'Fields: contract_id, id'
      properties:
        contract_id:
          description: Contract identifier (persistent contract id inside Aurora system)
          type: string
        id:
          description: >-
            Return identifier which is canceled (persistent identifier inside
            Aurora system for the return)
          type: string
      required:
        - contract_id
        - id
      type: object
    aurora.core.apiengine.contractsv1.Contract:
      description: >-
        Current status of the contract according to Aurora<br>Fields: id,
        settlement_type, settlement_id, instrument, side, counterparty_id,
        status, quantity, rate_details, collateral_rate, rounding_rule,
        interest_due_amount, market_value, contract_value,
        contract_value_adjustment, created_at, settlement_date,
        recalled_quantity, returned_quantity, agreement_id, unit_price,
        last_quantity, last_market_value, last_contract_value, collateral_price
      properties:
        agreement_id:
          description: Id of the agreement associated with this contract
          type: string
        collateral_price:
          description: The collateral_rate adjusted price rounded up.
          type: string
        collateral_rate:
          description: Collateral rate of the contract
          type: string
        contract_value:
          description: Value of the contract
          type: string
        contract_value_adjustment:
          description: Change in value of the contract
          type: string
        counterparty_id:
          description: Counterparty ID
          type: string
        created_at:
          description: >-
            Time of contract creation- time in RFC3339 with millisecond
            precision
          type: string
        id:
          description: Contract identifier (persistent identifier inside Aurora system)
          type: string
        instrument:
          $ref: '#/components/schemas/aurora.core.common.protos.PbInstrument'
        interest_due_amount:
          description: Daily interest amount of the contract
          type: string
        last_contract_value:
          description: >-
            Value of the contract before the last operation that adjusted this
            value
          type: string
        last_market_value:
          description: >-
            Market value of the contract before the last operation that adjusted
            this value
          type: string
        last_quantity:
          description: >-
            Quantity of the contract before the last operation that adjusted
            this value
          format: int64
          type: string
        market_value:
          description: Market value of the contract
          type: string
        quantity:
          description: Total quantity of the contract
          format: int64
          type: string
        rate_details:
          $ref: '#/components/schemas/aurora.core.common.protos.PbRateDetails'
        recalled_quantity:
          description: Total quantity currently recalled
          format: int64
          type: string
        returned_quantity:
          description: Total quantity that has been returned
          format: int64
          type: string
        rounding_rule:
          $ref: '#/components/schemas/aurora.core.consts.RoundingRule'
        settlement_date:
          description: Settlement date of SFT (if exists)
          type: string
        settlement_id:
          description: |-
            Settlement Type specific identifier
            ie. DTCC reference id for SFT
          type: string
        settlement_type:
          $ref: '#/components/schemas/aurora.core.consts.settlement.SettlementType'
        side:
          $ref: '#/components/schemas/aurora.core.consts.common.Side'
        status:
          $ref: '#/components/schemas/aurora.core.consts.ContractStatus'
        unit_price:
          description: Last prior day market price
          type: string
      required:
        - id
        - settlement_type
        - settlement_id
        - instrument
        - side
        - counterparty_id
        - status
        - quantity
        - rate_details
        - collateral_rate
        - rounding_rule
        - interest_due_amount
        - market_value
        - contract_value
        - contract_value_adjustment
        - created_at
        - settlement_date
        - recalled_quantity
        - returned_quantity
        - unit_price
        - last_quantity
        - last_market_value
        - last_contract_value
        - collateral_price
      type: object
    aurora.core.apiengine.contractsv1.ContractHistoryEvent:
      description: 'Fields: event_id, event_type, event_time, initiator, contract_state'
      properties:
        contract_state:
          $ref: >-
            #/components/schemas/aurora.core.apiengine.contractsv1.ContractHistoryState
        event_id:
          description: Unique identifier of the event
          type: string
        event_time:
          description: Event timestamp - in RFC3339 with millisecond precision
          type: string
        event_type:
          $ref: >-
            #/components/schemas/aurora.core.consts.contracthistory.ContractHistoryEventType
        initiator:
          description: Event initiator
          type: string
      required:
        - event_id
        - event_type
        - event_time
        - initiator
        - contract_state
      type: object
    aurora.core.apiengine.contractsv1.ContractHistoryState:
      description: >-
        Fields: id, settlement_type, instrument, side, counterparty_id,
        total_quantity, open_quantity, unit_price, rate_details, contract_value,
        interest_due_amount, market_value, market_value_adjustment,
        contract_value_adjustment, open_quantity_change, settlement_id,
        settlement_date, collateral_rate, agreement_id, status, rounding_rule,
        recalled_quantity, returned_quantity, created_at
      properties:
        agreement_id:
          description: Id of the agreement associated with this contract
          type: string
        collateral_rate:
          description: Collateral rate of the contract
          type: string
        contract_value:
          description: Value of the contract at the time of the event
          type: string
        contract_value_adjustment:
          description: The change in the value of the contract as effect of the event
          type: string
        counterparty_id:
          description: Counterparty ID
          type: string
        created_at:
          description: Time of contract creation - in RFC3339 with millisecond precision
          type: string
        id:
          description: Contract identifier (persistent identifier inside Aurora system)
          type: string
        instrument:
          $ref: '#/components/schemas/aurora.core.common.protos.PbInstrument'
        interest_due_amount:
          description: Daily interest amount of the contract at the time of the event
          type: string
        market_value:
          description: Market value of the contract at the time of the event
          type: string
        market_value_adjustment:
          description: >-
            The change in the Market value of the contract as effect of the
            event
          type: string
        open_quantity:
          description: Open quantity of the contract at the time of the event
          format: int64
          type: string
        open_quantity_change:
          description: >-
            The change in the open quantity of the contract as effect of the
            event
          format: int64
          type: string
        rate_details:
          $ref: '#/components/schemas/aurora.core.common.protos.PbRateDetails'
        recalled_quantity:
          description: Total quantity currently recalled
          format: int64
          type: string
        returned_quantity:
          description: Total quantity that has been returned
          format: int64
          type: string
        rounding_rule:
          $ref: '#/components/schemas/aurora.core.consts.RoundingRule'
        settlement_date:
          description: Settlement date of SFT (if exists)
          type: string
        settlement_id:
          description: |-
            Settlement Type specific identifier
            ie. DTCC reference id for SFT
          type: string
        settlement_type:
          $ref: '#/components/schemas/aurora.core.consts.settlement.SettlementType'
        side:
          $ref: '#/components/schemas/aurora.core.consts.common.Side'
        status:
          $ref: '#/components/schemas/aurora.core.consts.ContractStatus'
        total_quantity:
          description: >-
            Original total quantity of the contract (that it originally had
            before any returns)
          format: int64
          type: string
        unit_price:
          description: Last prior day market price
          type: string
      required:
        - id
        - settlement_type
        - instrument
        - side
        - counterparty_id
        - total_quantity
        - open_quantity
        - unit_price
        - rate_details
        - contract_value
        - interest_due_amount
        - market_value
        - market_value_adjustment
        - contract_value_adjustment
        - open_quantity_change
        - settlement_id
        - settlement_date
        - collateral_rate
        - status
        - rounding_rule
        - recalled_quantity
        - returned_quantity
        - created_at
      type: object
    aurora.core.apiengine.contractsv1.ContractReturn:
      description: 'Fields: id, contract_id, quantity, status'
      properties:
        contract_id:
          description: Contract identifier (persistent identifier inside Aurora system)
          type: string
        id:
          description: >-
            Return identifier (persistent identifier inside Aurora system for
            the return)
          type: string
        quantity:
          description: Amount of shares being returned
          format: int64
          type: string
        status:
          $ref: >-
            #/components/schemas/aurora.core.consts.contractreturn.ContractReturnStatus
      required:
        - id
        - contract_id
        - quantity
        - status
      type: object
    aurora.core.apiengine.contractsv1.CreateRateModificationRequest:
      description: 'Fields: request_id, contract_id, rate_details'
      properties:
        contract_id:
          description: Contract identifier (persistent identifier inside Aurora system)
          type: string
        rate_details:
          $ref: '#/components/schemas/aurora.core.common.protos.PbRateDetails'
        request_id:
          description: User populated id of this request
          type: string
      required:
        - contract_id
        - rate_details
      type: object
    aurora.core.apiengine.contractsv1.CreateRateModificationResponse:
      description: 'Fields: id, status, contract_id, rate_details'
      properties:
        contract_id:
          description: Contract identifier (persistent identifier inside Aurora system)
          type: string
        id:
          description: Id of rate_modification that was created
          type: string
        rate_details:
          $ref: '#/components/schemas/aurora.core.common.protos.PbRateDetails'
        status:
          $ref: >-
            #/components/schemas/aurora.core.consts.contractratemodification.ContractRateModificationStatus
      required:
        - id
        - status
        - contract_id
        - rate_details
      type: object
    aurora.core.apiengine.contractsv1.GetContractRequest:
      description: 'Fields: contract_id'
      properties:
        contract_id:
          description: Contract identifier (persistent identifier inside Aurora system)
          type: string
      required:
        - contract_id
      type: object
    aurora.core.apiengine.contractsv1.GetContractResponse:
      description: 'Fields: contract'
      properties:
        contract:
          $ref: '#/components/schemas/aurora.core.apiengine.contractsv1.Contract'
      required:
        - contract
      type: object
    aurora.core.apiengine.contractsv1.ListContractHistoryFilter:
      description: >-
        ListContractHistoryFilter specifies the filters applied to the returned
        events

        Multiple filters can be set and are combined to create a
        subset<br>Fields: event_types, event_time_start, event_time_end,
        instruments, counterparties, contracts, side, initiator_kind,
        initiator_id, open_quantity, contract_value, open_quantity_change,
        settlement_types, rate, rate_amount, ticker, unit_price,
        contract_value_adjustment, settlement_date_start, settlement_date_end,
        market_value, cusip
      properties:
        contract_value:
          $ref: '#/components/schemas/aurora.core.consts.query.DecimalFilter'
        contract_value_adjustment:
          $ref: '#/components/schemas/aurora.core.consts.query.DecimalFilter'
        contracts:
          description: |-
            Filter to get a subset of events for the specified contracts
            All contracts are included when not specified
          items:
            type: string
          type: array
        counterparties:
          description: >-
            Filter to get a subset of events only for contracts with the
            specified counterparties

            All counterparties are included when not specified
          items:
            type: string
          type: array
        cusip:
          description: >-
            Filter to get a subset of events for contracts with the specified
            CUSIP
          type: string
        event_time_end:
          description: >-
            Timestamp to get all events before the specified time - in RFC3339
            with millisecond precision
          type: string
        event_time_start:
          description: >-
            Timestamp to get all events since the specified time - in RFC3339
            with millisecond precision
          type: string
        event_types:
          description: |-
            Filter to get a subset of event types
            All event types are included when not specified
          items:
            $ref: >-
              #/components/schemas/aurora.core.consts.contracthistory.ContractHistoryEventType
          type: array
        initiator_id:
          description: >-
            Filter to get a subset of events which were initiated by a specific
            actor

            All initiators are included when not specified
          type: string
        initiator_kind:
          $ref: >-
            #/components/schemas/aurora.core.consts.contracthistory.ContractHistoryEventInitiatorKind
        instruments:
          description: >-
            Filter to get a subset of events only for contracts for the
            specified instruments (ticker or CUSIP)

            All instruments are included when not specified
          items:
            type: string
          type: array
        market_value:
          $ref: '#/components/schemas/aurora.core.consts.query.DecimalFilter'
        open_quantity:
          $ref: '#/components/schemas/aurora.core.consts.query.BigintFilter'
        open_quantity_change:
          $ref: '#/components/schemas/aurora.core.consts.query.BigintFilter'
        rate:
          $ref: '#/components/schemas/aurora.core.consts.query.DecimalFilter'
        rate_amount:
          $ref: '#/components/schemas/aurora.core.consts.query.DecimalFilter'
        settlement_date_end:
          type: string
        settlement_date_start:
          description: >-
            Filter to get a subset of events for contracts with settlement date
            in the specified range - YYYY-MM-DD format
          type: string
        settlement_types:
          description: >-
            Filter to get a subset of events for contracts with the specified
            settlement types

            All settlement types are included when not specified
          items:
            $ref: '#/components/schemas/aurora.core.consts.settlement.SettlementType'
          type: array
        side:
          $ref: '#/components/schemas/aurora.core.consts.common.Side'
        ticker:
          description: >-
            Filter to get a subset of events for contracts with the specified
            ticker
          type: string
        unit_price:
          $ref: '#/components/schemas/aurora.core.consts.query.DecimalFilter'
      type: object
    aurora.core.apiengine.contractsv1.ListContractHistoryRequest:
      description: 'Fields: filter, sorts, page_number, page_limit'
      properties:
        filter:
          $ref: >-
            #/components/schemas/aurora.core.apiengine.contractsv1.ListContractHistoryFilter
        page_limit:
          description: Number of events to fetch per page (max=1000)
          format: int32
          type: integer
        page_number:
          description: Page number to fetch, starting from 1
          format: int32
          type: integer
        sorts:
          description: Sorting options, multiple can be specified
          items:
            $ref: >-
              #/components/schemas/aurora.core.apiengine.contractsv1.ListContractHistorySort
          type: array
      required:
        - page_number
        - page_limit
      type: object
    aurora.core.apiengine.contractsv1.ListContractHistoryResponse:
      description: 'Fields: events, total_entries'
      properties:
        events:
          description: List of events
          items:
            $ref: >-
              #/components/schemas/aurora.core.apiengine.contractsv1.ContractHistoryEvent
          type: array
        total_entries:
          description: Total number of events
          format: int64
          type: string
      required:
        - total_entries
      type: object
    aurora.core.apiengine.contractsv1.ListContractHistorySort:
      description: 'Fields: field, order'
      properties:
        field:
          $ref: >-
            #/components/schemas/aurora.core.consts.contracthistory.ContractHistorySortableField
        order:
          $ref: '#/components/schemas/aurora.core.consts.query.SortOrder'
      required:
        - field
        - order
      type: object
    aurora.core.apiengine.contractsv1.ListContractsRequest:
      description: >-
        Fields: status_filter, id, start_date, end_date, side, counterparty_ids,
        instrument, created_at_start, created_at_end, page_number, page_limit
      properties:
        counterparty_ids:
          description: Counterparty ID filter - optional
          items:
            type: string
          type: array
        created_at_end:
          description: >-
            Filter contracts created before time - in RFC3339 with millisecond
            precision - optional
          type: string
        created_at_start:
          description: >-
            Filter contracts created after time - in RFC3339 with millisecond
            precision - optional
          type: string
        end_date:
          description: >-
            Date until contracts created (inclusive, YYYY-MM-DD) filter -
            optional
          type: string
        id:
          description: >-
            Contract identifier (persistent contract identifier inside Aurora
            system) filter - optional
          type: string
        instrument:
          description: Instrument (CUSIP or Ticker) filter - optional
          type: string
        page_limit:
          description: Number of contracts to fetch per page (max=1000)
          format: int32
          type: integer
        page_number:
          description: Page number to fetch, starting from 1
          format: int32
          type: integer
        side:
          $ref: '#/components/schemas/aurora.core.consts.common.Side'
        start_date:
          description: >-
            Date after contracts created (inclusive, YYYY-MM-DD) filter -
            optional
          type: string
        status_filter:
          $ref: >-
            #/components/schemas/aurora.core.apiengine.contractsv1.ListContractsStatusFilter
      required:
        - page_number
        - page_limit
      type: object
    aurora.core.apiengine.contractsv1.ListContractsResponse:
      description: 'Fields: contracts, total_count'
      properties:
        contracts:
          description: Current details of the contract(s)
          items:
            $ref: '#/components/schemas/aurora.core.apiengine.contractsv1.Contract'
          type: array
        total_count:
          description: Total number of contracts
          format: int64
          type: string
      required:
        - total_count
      type: object
    aurora.core.apiengine.contractsv1.ListContractsStatusFilter:
      enum:
        - OPEN
        - CLOSED
      type: string
    aurora.core.apiengine.contractsv1.ListRateModificationsRequest:
      description: 'Fields: request_id, id, contract_id, instrument, side, counterparty_ids'
      properties:
        contract_id:
          description: >-
            Filter by Contract identifier (persistent identifier inside Aurora
            system) - optional
          type: string
        counterparty_ids:
          description: Filter by Counterparty IDs - optional
          items:
            type: string
          type: array
        id:
          description: >-
            Filter by Id of the rate_modification (assigned by Aurora) -
            optional
          type: string
        instrument:
          description: Filter by Instrument (CUSIP or Ticker) - optional
          type: string
        request_id:
          description: User populated id of this request
          type: string
        side:
          $ref: '#/components/schemas/aurora.core.consts.common.Side'
      type: object
    aurora.core.apiengine.contractsv1.ListRateModificationsResponse:
      description: 'Fields: rate_modifications, total_count'
      properties:
        rate_modifications:
          description: Details of the rate_modification(s)
          items:
            $ref: >-
              #/components/schemas/aurora.core.apiengine.contractsv1.RateModificationDetails
          type: array
        total_count:
          description: Total number of rate_modifications
          format: int64
          type: string
      required:
        - total_count
      type: object
    aurora.core.apiengine.contractsv1.ListRecallsRequest:
      description: 'Fields: request_id, contract_id, id, instrument'
      properties:
        contract_id:
          description: >-
            Contract identifier (persistent identifier inside Aurora system) -
            optional
          type: string
        id:
          description: >-
            Recall id (persistent recall identifier inside Aurora system) -
            optional
          type: string
        instrument:
          description: Instrument (CUSIP or Ticker) - optional
          type: string
        request_id:
          description: >-
            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.
          type: string
      type: object
    aurora.core.apiengine.contractsv1.ListRecallsResponse:
      description: 'Fields: recalls, total_count'
      properties:
        recalls:
          description: Details of the recall(s)
          items:
            $ref: '#/components/schemas/aurora.core.apiengine.contractsv1.Recall'
          type: array
        total_count:
          description: Total number of recalls
          format: int64
          type: string
      required:
        - total_count
      type: object
    aurora.core.apiengine.contractsv1.RateModificationDetails:
      description: >-
        Fields: id, contract_id, status, rate, original_rate,
        initiator_company_id
      properties:
        contract_id:
          description: Contract identifier (persistent identifier inside Aurora system)
          type: string
        id:
          description: Id of the rate_modification assigned by Aurora
          type: string
        initiator_company_id:
          description: Company ID that initiated this rate modification
          type: string
        original_rate:
          $ref: '#/components/schemas/aurora.core.common.protos.PbRateDetails'
        rate:
          $ref: '#/components/schemas/aurora.core.common.protos.PbRateDetails'
        status:
          $ref: >-
            #/components/schemas/aurora.core.consts.contractratemodification.ContractRateModificationStatus
      required:
        - id
        - contract_id
        - status
        - rate
        - original_rate
        - initiator_company_id
      type: object
    aurora.core.apiengine.contractsv1.Recall:
      description: >-
        Fields: id, contract_id, recall_status, quantity,
        allowed_execution_date, initiator_company_id
      properties:
        allowed_execution_date:
          description: allowed buy-in execution date
          type: string
        contract_id:
          description: Contract identifier (persistent identifier inside Aurora system)
          type: string
        id:
          description: Recall identifier (persistent identifier inside Aurora system)
          type: string
        initiator_company_id:
          description: Company ID that initiated this recall (always the lender)
          type: string
        quantity:
          description: Number of shares recalled
          format: int64
          type: string
        recall_status:
          $ref: >-
            #/components/schemas/aurora.core.consts.contractrecall.ContractRecallStatus
      required:
        - id
        - contract_id
        - recall_status
        - quantity
        - initiator_company_id
      type: object
    aurora.core.apiengine.contractsv1.RecallContractRequest:
      description: 'Fields: request_id, contract_id, quantity'
      properties:
        contract_id:
          description: Contract identifier (persistent identifier inside Aurora system)
          type: string
        quantity:
          description: Amount of shares to recall
          format: int64
          type: string
        request_id:
          description: >-
            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.
          type: string
      required:
        - contract_id
        - quantity
      type: object
    aurora.core.apiengine.contractsv1.RecallContractResponse:
      description: 'Fields: recall'
      properties:
        recall:
          $ref: '#/components/schemas/aurora.core.apiengine.contractsv1.Recall'
      required:
        - recall
      type: object
    aurora.core.apiengine.contractsv1.RejectAwaitingContractReturnRequest:
      description: 'Fields: request_id, id'
      properties:
        id:
          description: >-
            Return identifier (persistent identifier inside Aurora system for
            the return)
          type: string
        request_id:
          description: >-
            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.
          type: string
      required:
        - id
      type: object
    aurora.core.apiengine.contractsv1.RejectAwaitingContractReturnResponse:
      description: 'Fields: id'
      properties:
        id:
          description: >-
            Return identifier (persistent identifier inside Aurora system for
            the return)
          type: string
      required:
        - id
      type: object
    aurora.core.apiengine.contractsv1.ReturnContractRequest:
      description: 'Fields: request_id, contract_id, quantity'
      properties:
        contract_id:
          description: >-
            Contract identifier (persistent contract identifier inside Aurora
            system)
          type: string
        quantity:
          description: Amount of shares to return
          format: int64
          type: string
        request_id:
          description: >-
            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.
          type: string
      required:
        - contract_id
        - quantity
      type: object
    aurora.core.apiengine.contractsv1.ReturnContractResponse:
      description: 'Fields: contract_id, contract_return'
      properties:
        contract_id:
          description: Contract identifier (persistent identifier inside Aurora system)
          type: string
        contract_return:
          $ref: >-
            #/components/schemas/aurora.core.apiengine.contractsv1.ContractReturn
      required:
        - contract_id
        - contract_return
      type: object
    aurora.core.apiengine.contractsv1.UpdateRateModificationRequest:
      description: 'Fields: request_id, id'
      properties:
        id:
          description: Id of rate_modification that is to be modified
          type: string
        request_id:
          description: User populated id of this request
          type: string
      required:
        - id
      type: object
    aurora.core.apiengine.contractsv1.UpdateRateModificationResponse:
      description: 'Fields: id, status'
      properties:
        id:
          description: Id of rate_modification that was created
          type: string
        status:
          $ref: >-
            #/components/schemas/aurora.core.consts.contractratemodification.ContractRateModificationStatus
      required:
        - id
        - status
      type: object
    aurora.core.consts.contractbuyin.ContractBuyInRejectReason:
      enum:
        - NONE
        - OUTSIDE_SUPPORTED_HOURS
        - UNSUPPORTED_MESSAGE_DETAILS
        - UNKNOWN_EXECID_NOT_YOUR_LOAN
        - LOAN_INELIGIBLE
        - INVALID_BUYIN_QTY
        - OTHER
      type: string
    aurora.core.consts.contractbuyin.ContractBuyInStatus:
      description: 'ContractBuyInStatus : the state a Buy-In is in now'
      enum:
        - PENDING
        - ACCEPTED
        - REJECTED
      type: string
    aurora.core.consts.contracthistory.ContractHistoryEventInitiatorKind:
      enum:
        - SYSTEM
        - BOT
        - TRADER
        - CONTRA
      type: string
    aurora.core.consts.contracthistory.ContractHistoryEventType:
      enum:
        - CREATED
        - PENDING
        - CANCEL_PENDING
        - DO_PENDING
        - MADE
        - DROPPED
        - REJECTED
        - CANCEL_REJECTED
        - CANCELLED
        - RECALLED
        - RECALL_REJECTED
        - RECALL_CANCELED
        - ROLLED
        - ROLL_PENDING
        - ROLL_PD_PENDING
        - ROLL_PD_MADE
        - RETURNED
        - RETURN_PENDING
        - PARTIALLY_RETURNED
        - RETURN_CANCELED
        - RETURN_FAILED
        - RETURN_REJECTED
        - TERMINATED
        - BUY_IN
        - BUY_IN_PENDING
        - BUY_IN_CANCELLED
        - BUY_IN_REJECTED
        - BUY_IN_PO_MADE
        - BUY_IN_PO_FAILED
        - RENEGOTIATED
        - RENEGOTIATION_CANCELED
        - RENEGOTIATION_REJECTED
        - RENEGOTIATION_EXPIRED
        - CORPORATE_ACTION
        - MARKED_TO_MARKET
        - MARK_TO_MARKET_PO_FAILED
        - MARK_TO_MARKET_PO_MADE
        - DAILY_INTEREST_AMOUNT
        - DAILY_INTEREST_PO_FAILED
        - DAILY_INTEREST_PO_MADE
        - FLOATING_RATE_RECALCULATED
        - RETURN_PROPOSED
        - RETURN_PROPOSAL_ACCEPTED
        - RETURN_PROPOSAL_REJECTED
        - RETURN_PROPOSAL_CANCELED
        - RETURN_PROPOSAL_DROPPED
        - RETURN_CANCEL_REJECTED
      type: string
    aurora.core.consts.contracthistory.ContractHistorySortableField:
      enum:
        - EVENT_TYPE
        - EVENT_TIME
        - OPEN_QUANTITY
        - COUNTERPARTY
        - INSTRUMENT_TICKER
        - INSTRUMENT_CUSIP
        - RATE
        - RATE_AMOUNT
        - SETTLEMENT_AMOUNT
        - SETTLEMENT_TYPE
        - SETTLEMENT_AMOUNT_CHANGE
        - OPEN_QUANTITY_CHANGE
        - INITIATOR
        - SIDE
      type: string
    aurora.core.consts.contractratemodification.ContractRateModificationStatus:
      description: Different stages of a rate renegotiation
      enum:
        - PROPOSED
        - ACCEPTED
        - FINALIZED
        - REJECTED
        - CANCELED
        - DROPPED
        - EXPIRED
      type: string
    aurora.core.consts.contractrecall.ContractRecallRejectReason:
      enum:
        - NONE
        - OUTSIDE_SUPPORTED_HOURS
        - UNSUPPORTED_MESSAGE_DETAILS
        - UNKNOWN_LOAN_RECALL
        - LOAN_INELIGIBLE
        - INVALID_LOAN_RECALL_QTY
        - UNKNOWN_LOAN_ID
        - OTHER
      type: string
    aurora.core.consts.contractrecall.ContractRecallStatus:
      description: 'ContractRecallStatus : the state a Recall is in now'
      enum:
        - NEW
        - OPEN
        - PARTIALLY_RETURNED
        - FULLY_RETURNED
        - PENDING_CANCEL
        - CANCELED
        - REJECTED
        - PENDING_AMEND
      type: string
    aurora.core.consts.contractreturn.ContractReturnRejectReason:
      description: possible reasons for returns to be rejected
      enum:
        - NONE
        - OUTSIDE_SUPPORTED_HOURS
        - UNSUPPORTED_MESSAGE_DETAILS
        - UNKNOWN_LOAN_ID
        - INELIGIBLE
        - OTHER
      type: string
    aurora.core.consts.contractreturn.ContractReturnStatus:
      enum:
        - RETURN_PENDING
        - RETURN_COMPLETED
        - RETURN_REJECTED
        - PENDING_CANCEL
        - CANCELED
        - DROPPED
        - RETURN_PENDING_LENDERS_APPROVAL
        - RETURN_REJECTED_BY_LENDER
      type: string
    aurora.core.apiengine.contractsv1.CancelContractAcceptedEvent:
      description: 'Fields: request_id, contract'
      properties:
        contract:
          $ref: '#/components/schemas/aurora.core.apiengine.contractsv1.Contract'
        request_id:
          description: User populated id of this request
          type: string
      required:
        - request_id
        - contract
      type: object
    aurora.core.apiengine.contractsv1.CancelContractRejectedEvent:
      description: 'Fields: request_id, contract'
      properties:
        contract:
          $ref: '#/components/schemas/aurora.core.apiengine.contractsv1.Contract'
        request_id:
          description: User populated id of this request
          type: string
      required:
        - request_id
        - contract
      type: object
    aurora.core.apiengine.contractsv1.ContractBuyInAcceptedEvent:
      description: 'Fields: request_id, contract, buyin'
      properties:
        buyin:
          $ref: '#/components/schemas/aurora.core.apiengine.contractsv1.BuyIn'
        contract:
          $ref: '#/components/schemas/aurora.core.apiengine.contractsv1.Contract'
        request_id:
          description: User populated id of the request this response is for
          type: string
      required:
        - request_id
        - contract
        - buyin
      type: object
    aurora.core.apiengine.contractsv1.ContractBuyInExecutedEvent:
      description: 'Fields: request_id, contract, buyin'
      properties:
        buyin:
          $ref: '#/components/schemas/aurora.core.apiengine.contractsv1.BuyIn'
        contract:
          $ref: '#/components/schemas/aurora.core.apiengine.contractsv1.Contract'
        request_id:
          description: User populated id of the request this response is for
          type: string
      required:
        - request_id
        - contract
        - buyin
      type: object
    aurora.core.apiengine.contractsv1.ContractBuyInRejectedEvent:
      description: 'Fields: request_id, contract, buyin, reject_reason, reject_text'
      properties:
        buyin:
          $ref: '#/components/schemas/aurora.core.apiengine.contractsv1.BuyIn'
        contract:
          $ref: '#/components/schemas/aurora.core.apiengine.contractsv1.Contract'
        reject_reason:
          $ref: >-
            #/components/schemas/aurora.core.consts.contractbuyin.ContractBuyInRejectReason
        reject_text:
          description: >-
            Further explanation why the buyin was rejected (outside the window
            for buyin instructions)
          type: string
        request_id:
          description: User populated id of the request this response is for
          type: string
      required:
        - request_id
        - contract
        - buyin
        - reject_reason
        - reject_text
      type: object
    aurora.core.apiengine.contractsv1.ContractCreatedEvent:
      description: >-
        Contract has been created (ContractStatus is 'New')<br>Fields:
        request_id, contract
      properties:
        contract:
          $ref: '#/components/schemas/aurora.core.apiengine.contractsv1.Contract'
        request_id:
          description: User populated id of this request
          type: string
      required:
        - request_id
        - contract
      type: object
    aurora.core.apiengine.contractsv1.ContractDroppedEvent:
      description: 'Fields: request_id, contract'
      properties:
        contract:
          $ref: '#/components/schemas/aurora.core.apiengine.contractsv1.Contract'
        request_id:
          description: User populated id of this request
          type: string
      required:
        - request_id
        - contract
      type: object
    aurora.core.apiengine.contractsv1.ContractMadeEvent:
      description: >-
        Contract has been approved by the DTCC (ContractStatus is now
        'Open')<br>Fields: request_id, contract
      properties:
        contract:
          $ref: '#/components/schemas/aurora.core.apiengine.contractsv1.Contract'
        request_id:
          description: User populated id of this request
          type: string
      required:
        - request_id
        - contract
      type: object
    aurora.core.apiengine.contractsv1.ContractPendingEvent:
      description: >-
        Contract created and waiting for a Delivery Order (ContractStatus is
        'Pending')<br>Fields: request_id, contract
      properties:
        contract:
          $ref: '#/components/schemas/aurora.core.apiengine.contractsv1.Contract'
        request_id:
          description: User populated id of this request
          type: string
      required:
        - request_id
        - contract
      type: object
    aurora.core.apiengine.contractsv1.ContractRateModificationAcceptedEvent:
      description: >-
        Fields: request_id, contract_id, id, proposed_rate, original_rate,
        status
      properties:
        contract_id:
          description: Contract identifier (persistent identifier inside Aurora system)
          type: string
        id:
          description: Id of the rate_modification assigned by Aurora
          type: string
        original_rate:
          $ref: '#/components/schemas/aurora.core.common.protos.PbRateDetails'
        proposed_rate:
          $ref: '#/components/schemas/aurora.core.common.protos.PbRateDetails'
        request_id:
          description: User populated id of the original rate_modification request
          type: string
        status:
          $ref: >-
            #/components/schemas/aurora.core.consts.contractratemodification.ContractRateModificationStatus
      required:
        - request_id
        - contract_id
        - id
        - proposed_rate
        - original_rate
        - status
      type: object
    aurora.core.apiengine.contractsv1.ContractRateModificationAutoCanceledEvent:
      description: >-
        Fields: request_id, contract_id, id, proposed_rate, original_rate,
        status
      properties:
        contract_id:
          description: Contract identifier (persistent identifier inside Aurora system)
          type: string
        id:
          description: Id of the rate_modification assigned by Aurora
          type: string
        original_rate:
          $ref: '#/components/schemas/aurora.core.common.protos.PbRateDetails'
        proposed_rate:
          $ref: '#/components/schemas/aurora.core.common.protos.PbRateDetails'
        request_id:
          description: User populated id of the original rate_modification request
          type: string
        status:
          $ref: >-
            #/components/schemas/aurora.core.consts.contractratemodification.ContractRateModificationStatus
      required:
        - request_id
        - contract_id
        - id
        - proposed_rate
        - original_rate
        - status
      type: object
    aurora.core.apiengine.contractsv1.ContractRateModificationCanceledEvent:
      description: >-
        Fields: request_id, contract_id, id, proposed_rate, original_rate,
        status
      properties:
        contract_id:
          description: Contract identifier (persistent identifier inside Aurora system)
          type: string
        id:
          description: Id of the rate_modification assigned by Aurora
          type: string
        original_rate:
          $ref: '#/components/schemas/aurora.core.common.protos.PbRateDetails'
        proposed_rate:
          $ref: '#/components/schemas/aurora.core.common.protos.PbRateDetails'
        request_id:
          description: User populated id of the original rate_modification request
          type: string
        status:
          $ref: >-
            #/components/schemas/aurora.core.consts.contractratemodification.ContractRateModificationStatus
      required:
        - request_id
        - contract_id
        - id
        - proposed_rate
        - original_rate
        - status
      type: object
    aurora.core.apiengine.contractsv1.ContractRateModificationExecutedEvent:
      description: 'Fields: request_id, contract'
      properties:
        contract:
          $ref: '#/components/schemas/aurora.core.apiengine.contractsv1.Contract'
        request_id:
          description: User populated id of this request
          type: string
      required:
        - request_id
        - contract
      type: object
    aurora.core.apiengine.contractsv1.ContractRateModificationExpiredEvent:
      description: >-
        Fields: request_id, contract_id, id, proposed_rate, original_rate,
        status
      properties:
        contract_id:
          description: Contract identifier (persistent identifier inside Aurora system)
          type: string
        id:
          description: Id of the rate_modification assigned by Aurora
          type: string
        original_rate:
          $ref: '#/components/schemas/aurora.core.common.protos.PbRateDetails'
        proposed_rate:
          $ref: '#/components/schemas/aurora.core.common.protos.PbRateDetails'
        request_id:
          description: User populated id of the original rate_modification request
          type: string
        status:
          $ref: >-
            #/components/schemas/aurora.core.consts.contractratemodification.ContractRateModificationStatus
      required:
        - request_id
        - contract_id
        - id
        - proposed_rate
        - original_rate
        - status
      type: object
    aurora.core.apiengine.contractsv1.ContractRateModificationOpenedEvent:
      description: >-
        Fields: request_id, contract_id, id, proposed_rate, original_rate,
        status
      properties:
        contract_id:
          description: Contract identifier (persistent identifier inside Aurora system)
          type: string
        id:
          description: Id of the rate_modification assigned by Aurora
          type: string
        original_rate:
          $ref: '#/components/schemas/aurora.core.common.protos.PbRateDetails'
        proposed_rate:
          $ref: '#/components/schemas/aurora.core.common.protos.PbRateDetails'
        request_id:
          description: User populated id of the original rate_modification request
          type: string
        status:
          $ref: >-
            #/components/schemas/aurora.core.consts.contractratemodification.ContractRateModificationStatus
      required:
        - request_id
        - contract_id
        - id
        - proposed_rate
        - original_rate
        - status
      type: object
    aurora.core.apiengine.contractsv1.ContractRateModificationRejectedEvent:
      description: >-
        Fields: request_id, contract_id, id, proposed_rate, original_rate,
        status
      properties:
        contract_id:
          description: Contract identifier (persistent identifier inside Aurora system)
          type: string
        id:
          description: Id of the rate_modification assigned by Aurora
          type: string
        original_rate:
          $ref: '#/components/schemas/aurora.core.common.protos.PbRateDetails'
        proposed_rate:
          $ref: '#/components/schemas/aurora.core.common.protos.PbRateDetails'
        request_id:
          description: User populated id of the original rate_modification request
          type: string
        status:
          $ref: >-
            #/components/schemas/aurora.core.consts.contractratemodification.ContractRateModificationStatus
      required:
        - request_id
        - contract_id
        - id
        - proposed_rate
        - original_rate
        - status
      type: object
    aurora.core.apiengine.contractsv1.ContractRecallCancelRejectedEvent:
      description: 'Fields: request_id, contract, recall, reject_reason, reject_text'
      properties:
        contract:
          $ref: '#/components/schemas/aurora.core.apiengine.contractsv1.Contract'
        recall:
          $ref: '#/components/schemas/aurora.core.apiengine.contractsv1.Recall'
        reject_reason:
          $ref: >-
            #/components/schemas/aurora.core.consts.contractcancelrecall.ContractCancelRecallRejectReason
        reject_text:
          description: >-
            Further explanation why the recall was not canceled (outside the
            window for cancel instructions)
          type: string
        request_id:
          description: User populated id of the request this response is for
          type: string
      required:
        - request_id
        - contract
        - recall
        - reject_reason
        - reject_text
      type: object
    aurora.core.apiengine.contractsv1.ContractRecallCanceledEvent:
      description: 'Fields: request_id, contract, recall'
      properties:
        contract:
          $ref: '#/components/schemas/aurora.core.apiengine.contractsv1.Contract'
        recall:
          $ref: '#/components/schemas/aurora.core.apiengine.contractsv1.Recall'
        request_id:
          description: User populated id of the request this response is for
          type: string
      required:
        - request_id
        - contract
        - recall
      type: object
    aurora.core.apiengine.contractsv1.ContractRecallExecutedEvent:
      description: 'Fields: request_id, contract, recall'
      properties:
        contract:
          $ref: '#/components/schemas/aurora.core.apiengine.contractsv1.Contract'
        recall:
          $ref: '#/components/schemas/aurora.core.apiengine.contractsv1.Recall'
        request_id:
          description: User populated id of the request this response is for
          type: string
      required:
        - request_id
        - contract
        - recall
      type: object
    aurora.core.apiengine.contractsv1.ContractRecallOpenedEvent:
      description: 'Fields: request_id, contract, recall'
      properties:
        contract:
          $ref: '#/components/schemas/aurora.core.apiengine.contractsv1.Contract'
        recall:
          $ref: '#/components/schemas/aurora.core.apiengine.contractsv1.Recall'
        request_id:
          description: User populated id of the request this response is for
          type: string
      required:
        - request_id
        - contract
        - recall
      type: object
    aurora.core.apiengine.contractsv1.ContractRecallRejectedEvent:
      description: 'Fields: request_id, contract, recall, reject_reason, reject_text'
      properties:
        contract:
          $ref: '#/components/schemas/aurora.core.apiengine.contractsv1.Contract'
        recall:
          $ref: '#/components/schemas/aurora.core.apiengine.contractsv1.Recall'
        reject_reason:
          $ref: >-
            #/components/schemas/aurora.core.consts.contractrecall.ContractRecallRejectReason
        reject_text:
          description: >-
            Further explanation why the recall was rejected (outside the window
            for recall instructions)
          type: string
        request_id:
          description: User populated id of the request this response is for
          type: string
      required:
        - request_id
        - contract
        - recall
        - reject_reason
        - reject_text
      type: object
    aurora.core.apiengine.contractsv1.ContractRecallUpdatedEvent:
      description: 'Fields: request_id, contract, recall'
      properties:
        contract:
          $ref: '#/components/schemas/aurora.core.apiengine.contractsv1.Contract'
        recall:
          $ref: '#/components/schemas/aurora.core.apiengine.contractsv1.Recall'
        request_id:
          description: User populated id of the request this response is for
          type: string
      required:
        - request_id
        - contract
        - recall
      type: object
    aurora.core.apiengine.contractsv1.ContractRejectedEvent:
      description: 'Fields: request_id, contract'
      properties:
        contract:
          $ref: '#/components/schemas/aurora.core.apiengine.contractsv1.Contract'
        request_id:
          description: User populated id of this request
          type: string
      required:
        - request_id
        - contract
      type: object
    aurora.core.apiengine.contractsv1.ContractReturnAcceptedByLenderEvent:
      description: 'Fields: request_id, return_id, contract_id, accepted_quantity'
      properties:
        accepted_quantity:
          description: return quantity accepted by lender
          format: int64
          type: string
        contract_id:
          description: Contract identifier (persistent identifier inside Aurora system)
          type: string
        request_id:
          description: User populated id of the request this response is for
          type: string
        return_id:
          description: >-
            accepted by lender contract return identifier (persistent identifier
            inside Aurora system)
          type: string
      required:
        - request_id
        - return_id
        - contract_id
        - accepted_quantity
      type: object
    aurora.core.apiengine.contractsv1.ContractReturnCancelAcceptedEvent:
      description: 'Fields: request_id, contract, contract_return'
      properties:
        contract:
          $ref: '#/components/schemas/aurora.core.apiengine.contractsv1.Contract'
        contract_return:
          $ref: >-
            #/components/schemas/aurora.core.apiengine.contractsv1.ContractReturn
        request_id:
          description: User populated id of this request
          type: string
      required:
        - request_id
        - contract
        - contract_return
      type: object
    aurora.core.apiengine.contractsv1.ContractReturnCancelRejectedEvent:
      description: >-
        Fields: request_id, contract, contract_return, reject_text,
        reject_reason
      properties:
        contract:
          $ref: '#/components/schemas/aurora.core.apiengine.contractsv1.Contract'
        contract_return:
          $ref: >-
            #/components/schemas/aurora.core.apiengine.contractsv1.ContractReturn
        reject_reason:
          $ref: >-
            #/components/schemas/aurora.core.consts.contractcancelreturn.ContractCancelReturnRejectReason
        reject_text:
          description: reason text why the return was rejected
          type: string
        request_id:
          description: User populated id of this request
          type: string
      required:
        - request_id
        - contract
        - contract_return
        - reject_text
        - reject_reason
      type: object
    aurora.core.apiengine.contractsv1.ContractReturnCanceledByBorrowerEvent:
      description: 'Fields: request_id, return_id, contract_id, canceled_quantity'
      properties:
        canceled_quantity:
          description: return quantity canceled by borrower
          format: int64
          type: string
        contract_id:
          description: Contract identifier (persistent identifier inside Aurora system)
          type: string
        request_id:
          description: User populated id of the request this response is for
          type: string
        return_id:
          description: >-
            canceled by borrower contract return identifier (persistent
            identifier inside Aurora system)
          type: string
      required:
        - request_id
        - return_id
        - contract_id
        - canceled_quantity
      type: object
    aurora.core.apiengine.contractsv1.ContractReturnDroppedEvent:
      description: 'Fields: request_id, return_id, contract_id, dropped_quantity'
      properties:
        contract_id:
          description: Contract identifier (persistent identifier inside Aurora system)
          type: string
        dropped_quantity:
          description: return quantity dropped
          format: int64
          type: string
        request_id:
          description: User populated id of the request this response is for
          type: string
        return_id:
          description: >-
            dropped contract return identifier (persistent identifier inside
            Aurora system)
          type: string
      required:
        - request_id
        - return_id
        - contract_id
        - dropped_quantity
      type: object
    aurora.core.apiengine.contractsv1.ContractReturnExecutedEvent:
      description: 'Fields: request_id, contract, contract_return'
      properties:
        contract:
          $ref: '#/components/schemas/aurora.core.apiengine.contractsv1.Contract'
        contract_return:
          $ref: >-
            #/components/schemas/aurora.core.apiengine.contractsv1.ContractReturn
        request_id:
          description: User populated id of this request
          type: string
      required:
        - request_id
        - contract
        - contract_return
      type: object
    aurora.core.apiengine.contractsv1.ContractReturnFailedEvent:
      description: 'Fields: request_id, contract, contract_return'
      properties:
        contract:
          $ref: '#/components/schemas/aurora.core.apiengine.contractsv1.Contract'
        contract_return:
          $ref: >-
            #/components/schemas/aurora.core.apiengine.contractsv1.ContractReturn
        request_id:
          description: User populated id of this request
          type: string
      required:
        - request_id
        - contract
        - contract_return
      type: object
    aurora.core.apiengine.contractsv1.ContractReturnPendingEvent:
      description: 'Fields: request_id, contract, contract_return'
      properties:
        contract:
          $ref: '#/components/schemas/aurora.core.apiengine.contractsv1.Contract'
        contract_return:
          $ref: >-
            #/components/schemas/aurora.core.apiengine.contractsv1.ContractReturn
        request_id:
          description: User populated id of this request
          type: string
      required:
        - request_id
        - contract
        - contract_return
      type: object
    aurora.core.apiengine.contractsv1.ContractReturnPendingLenderApprovalEvent:
      description: 'Fields: request_id, return_id, contract_id, return_quantity'
      properties:
        contract_id:
          description: Contract identifier (persistent identifier inside Aurora system)
          type: string
        request_id:
          description: User populated id of the request this response is for
          type: string
        return_id:
          description: >-
            Awaiting approval contract return identifier (persistent identifier
            inside Aurora system)
          type: string
        return_quantity:
          description: return quantity pending approval
          format: int64
          type: string
      required:
        - request_id
        - return_id
        - contract_id
        - return_quantity
      type: object
    aurora.core.apiengine.contractsv1.ContractReturnRejectedByLenderEvent:
      description: 'Fields: request_id, return_id, contract_id, rejected_quantity'
      properties:
        contract_id:
          description: Contract identifier (persistent identifier inside Aurora system)
          type: string
        rejected_quantity:
          description: return quantity rejected by lender
          format: int64
          type: string
        request_id:
          description: User populated id of the request this response is for
          type: string
        return_id:
          description: >-
            rejected by lender contract return identifier (persistent identifier
            inside Aurora system)
          type: string
      required:
        - request_id
        - return_id
        - contract_id
        - rejected_quantity
      type: object
    aurora.core.apiengine.contractsv1.ContractReturnRejectedEvent:
      description: >-
        Fields: request_id, contract, contract_return, reject_text,
        reject_reason
      properties:
        contract:
          $ref: '#/components/schemas/aurora.core.apiengine.contractsv1.Contract'
        contract_return:
          $ref: >-
            #/components/schemas/aurora.core.apiengine.contractsv1.ContractReturn
        reject_reason:
          $ref: >-
            #/components/schemas/aurora.core.consts.contractreturn.ContractReturnRejectReason
        reject_text:
          description: reason text why the return was rejected
          type: string
        request_id:
          description: User populated id of this request
          type: string
      required:
        - request_id
        - contract
        - contract_return
        - reject_text
        - reject_reason
      type: object
    aurora.core.apiengine.contractsv1.ContractRolledEvent:
      description: 'Fields: request_id, contract'
      properties:
        contract:
          $ref: '#/components/schemas/aurora.core.apiengine.contractsv1.Contract'
        request_id:
          description: User populated id of this request
          type: string
      required:
        - request_id
        - contract
      type: object
    aurora.core.consts.contractcancelrecall.ContractCancelRecallRejectReason:
      enum:
        - NONE
        - OUTSIDE_SUPPORTED_HOURS
        - UNSUPPORTED_MESSAGE_DETAILS
        - UNKNOWN_LOAN_RECALL
        - LOAN_INELIGIBLE
        - INVALID_LOAN_RECALL_QTY
        - UNKNOWN_LOAN_ID
        - OTHER
      type: string
    aurora.core.consts.contractcancelreturn.ContractCancelReturnRejectReason:
      description: possible reasons for cancellations to be rejected
      enum:
        - NONE
        - OUTSIDE_SUPPORTED_HOURS
        - UNSUPPORTED_MESSAGE_DETAILS
        - UNKNOWN_LOAN_ID
        - INELIGIBLE
        - OTHER
      type: string
    aurora.core.apiengine.commonv1.EventCategory:
      description: >-
        Available categories of unsolicited messages customer is interested to
        receive
      enum:
        - CONTRACTS
        - ORDERS
        - CONTRACT_REQUESTS
        - MARKETPLACE
        - EXECUTIONS
      type: string
    aurora.core.apiengine.contractrequestsv1.AcceptContractRequestRequest:
      description: 'Fields: display_id, comment, side'
      properties:
        comment:
          type: string
        display_id:
          type: string
        side:
          $ref: '#/components/schemas/aurora.core.consts.common.Side'
      required:
        - display_id
        - side
      type: object
    aurora.core.apiengine.contractrequestsv1.CancelContractRequestRequest:
      description: 'Fields: display_id, comment, side'
      properties:
        comment:
          type: string
        display_id:
          type: string
        side:
          $ref: '#/components/schemas/aurora.core.consts.common.Side'
      required:
        - display_id
        - side
      type: object
    aurora.core.apiengine.contractrequestsv1.ContractRequestAcceptedEvent:
      description: 'Fields: request_id, display_id, status'
      properties:
        display_id:
          description: Display id (persistent contract request id inside Aurora system)
          type: string
        request_id:
          description: User populated id of the request this response is for
          type: string
        status:
          $ref: >-
            #/components/schemas/aurora.core.consts.contractrequest.ContractRequestStatus
      required:
        - request_id
        - display_id
        - status
      type: object
    aurora.core.apiengine.contractrequestsv1.ContractRequestCanceledEvent:
      description: 'Fields: request_id, display_id, status'
      properties:
        display_id:
          description: Display id (persistent contract request id inside Aurora system)
          type: string
        request_id:
          description: User populated id of the request this response is for
          type: string
        status:
          $ref: >-
            #/components/schemas/aurora.core.consts.contractrequest.ContractRequestStatus
      required:
        - request_id
        - display_id
        - status
      type: object
    aurora.core.apiengine.contractrequestsv1.ContractRequestDeclinedEvent:
      description: 'Fields: request_id, display_id, status'
      properties:
        display_id:
          description: Display id (persistent contract request id inside Aurora system)
          type: string
        request_id:
          description: User populated id of the request this response is for
          type: string
        status:
          $ref: >-
            #/components/schemas/aurora.core.consts.contractrequest.ContractRequestStatus
      required:
        - request_id
        - display_id
        - status
      type: object
    aurora.core.apiengine.contractrequestsv1.ContractRequestOpenedEvent:
      description: 'Fields: request_id, contract_request'
      properties:
        contract_request:
          $ref: >-
            #/components/schemas/aurora.core.apiengine.contractrequestsv1.ContractRequestResponse
        request_id:
          description: User populated id of the request this response is for
          type: string
      required:
        - request_id
        - contract_request
      type: object
    aurora.core.apiengine.contractrequestsv1.ContractRequestResponse:
      description: >-
        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
      properties:
        collateral_rate:
          description: Collateral rate of the contract
          type: string
        comment:
          description: Comment given on Accept, Decline or Cancel that is echoed back
          type: string
        contract_display_id:
          description: >-
            Human readable Id of contract resulting for this contract request
            action
          type: string
        contract_id:
          description: Id of contract resulting for this contract request action
          type: string
        counterparty_id:
          description: Counterparty ID
          type: string
        display_id:
          description: Display id (persistent contract request id inside Aurora system)
          type: string
        instrument:
          $ref: '#/components/schemas/aurora.core.common.protos.PbInstrument'
        is_pre_established:
          description: Pre-established contract flag
          type: boolean
        quantity:
          description: Quantity of shares
          format: int64
          type: string
        rate_details:
          $ref: '#/components/schemas/aurora.core.common.protos.PbRateDetails'
        request_id:
          description: User populated id of the request this response is for
          type: string
        rounding_rule:
          $ref: '#/components/schemas/aurora.core.consts.RoundingRule'
        settlement_type:
          $ref: '#/components/schemas/aurora.core.consts.settlement.SettlementType'
        side:
          $ref: '#/components/schemas/aurora.core.consts.common.Side'
        status:
          $ref: >-
            #/components/schemas/aurora.core.consts.contractrequest.ContractRequestStatus
      required:
        - request_id
        - side
        - counterparty_id
        - quantity
        - rounding_rule
        - display_id
        - status
        - rate_details
        - collateral_rate
        - instrument
        - is_pre_established
        - settlement_type
      type: object
    aurora.core.apiengine.contractrequestsv1.DeclineContractRequestRequest:
      description: 'Fields: display_id, comment, side'
      properties:
        comment:
          type: string
        display_id:
          type: string
        side:
          $ref: '#/components/schemas/aurora.core.consts.common.Side'
      required:
        - display_id
        - side
      type: object
    aurora.core.apiengine.contractrequestsv1.QueryContractRequestsRequest:
      description: >-
        Fields: instrument, contract_request_id, counterparty_ids, side,
        is_pre_established
      properties:
        contract_request_id:
          description: User populated id of a previous request - optional
          type: string
        counterparty_ids:
          description: Counterparty ID - optional
          items:
            type: string
          type: array
        instrument:
          description: Instrument (CUSIP or Ticker) - optional
          type: string
        is_pre_established:
          description: Preestablished contract flag
          type: boolean
        side:
          $ref: '#/components/schemas/aurora.core.consts.common.Side'
      required:
        - is_pre_established
      type: object
    aurora.core.apiengine.contractrequestsv1.QueryContractRequestsResponse:
      description: 'Fields: number_of_contracts, contract_requests'
      properties:
        contract_requests:
          description: Details of the contract requests
          items:
            $ref: >-
              #/components/schemas/aurora.core.apiengine.contractrequestsv1.ContractRequestResponse
          type: array
        number_of_contracts:
          description: Total number of contracts in the response
          format: int64
          type: string
      type: object
    aurora.core.apiengine.contractrequestsv1.SubmitContractRequestRequest:
      description: >-
        Fields: request_id, instrument, quantity, rate_details, collateral_rate,
        rounding_rule, is_pre_established, side, counterparty_id,
        settlement_type
      properties:
        collateral_rate:
          description: Collateral rate of contract
          type: string
        counterparty_id:
          description: Counterparty ID
          type: string
        instrument:
          description: Instrument (CUSIP or Ticker)
          type: string
        is_pre_established:
          description: Preestablished contract flag
          type: boolean
        quantity:
          description: Quantity of shares
          format: int64
          type: string
        rate_details:
          $ref: '#/components/schemas/aurora.core.common.protos.PbRateDetails'
        request_id:
          description: User populated id of this request
          type: string
        rounding_rule:
          $ref: '#/components/schemas/aurora.core.consts.RoundingRule'
        settlement_type:
          $ref: '#/components/schemas/aurora.core.consts.settlement.SettlementType'
        side:
          $ref: '#/components/schemas/aurora.core.consts.common.Side'
      required:
        - request_id
        - instrument
        - quantity
        - rate_details
        - collateral_rate
        - rounding_rule
        - is_pre_established
        - side
        - counterparty_id
      type: object
    aurora.core.consts.contractrequest.ContractRequestStatus:
      description: possible states in the lifecycle of a contract request
      enum:
        - PENDING
        - ACCEPTED
        - REJECTED
        - EXPIRED
        - CANCELED
        - AUTOMATCHED
      type: string
    aurora.core.apiengine.instrumentsv1.Instrument:
      description: >-
        Fields: name, ticker, cusip, settlement_eligibility,
        marketplace_eligible, trade_management_eligible, security_type
      properties:
        cusip:
          type: string
        marketplace_eligible:
          type: boolean
        name:
          type: string
        security_type:
          $ref: '#/components/schemas/aurora.core.consts.instruments.SecurityType'
        settlement_eligibility:
          items:
            $ref: '#/components/schemas/aurora.core.consts.settlement.SettlementType'
          type: array
        ticker:
          type: string
        trade_management_eligible:
          type: boolean
      required:
        - name
        - ticker
        - cusip
        - marketplace_eligible
        - trade_management_eligible
        - security_type
      type: object
    aurora.core.apiengine.instrumentsv1.ListInstrumentsRequest:
      description: >-
        Fields: tickers, cusips, settlement_eligibility, marketplace_eligible,
        trade_management_eligible, security_types
      properties:
        cusips:
          items:
            type: string
          type: array
        marketplace_eligible:
          type: boolean
        security_types:
          items:
            $ref: '#/components/schemas/aurora.core.consts.instruments.SecurityType'
          type: array
        settlement_eligibility:
          items:
            $ref: '#/components/schemas/aurora.core.consts.settlement.SettlementType'
          type: array
        tickers:
          items:
            type: string
          type: array
        trade_management_eligible:
          type: boolean
      type: object
    aurora.core.apiengine.instrumentsv1.ListInstrumentsResponse:
      description: 'Fields: instruments'
      properties:
        instruments:
          items:
            $ref: >-
              #/components/schemas/aurora.core.apiengine.instrumentsv1.Instrument
          type: array
      type: object
    aurora.core.consts.instruments.SecurityType:
      enum:
        - SECURITY_TYPE_UNSPECIFIED
        - CS
        - PFD
        - WARRANT
        - RIGHT
        - BOND
        - ETF
        - ETN
        - ETV
        - SP
        - ADRC
        - ADRP
        - ADRW
        - ADRR
        - FUND
        - BASKET
        - UNIT
        - LT
        - OS
        - GDR
        - OTHER
        - NYRS
        - AGEN
        - EQLK
        - ETS
      type: string
    aurora.core.apiengine.venuev1.BookOrder:
      description: >-
        single order in the depth-of-book<br>Fields: side, quantity, fee,
        rebate, min_execution_quantity, order_type, agreement_ids, cusip,
        ticker, company_id, market_value, root_client_order_ref,
        client_order_ref, active, order_intent
      properties:
        active:
          description: Active
          type: boolean
        agreement_ids:
          description: agreements that the order can be matched under
          items:
            type: string
          type: array
        client_order_ref:
          description: Client order referenchanged
          type: string
        company_id:
          description: Company ID for the order
          type: string
        cusip:
          description: Cusip of the instrument
          type: string
        fee:
          description: Rate for the order expressed as fee
          type: string
        market_value:
          description: Market value
          type: string
        min_execution_quantity:
          description: Minimum quantity of shares per execution - optional, defaults to 100
          format: int64
          type: string
        order_intent:
          $ref: '#/components/schemas/aurora.core.consts.oms.OrderIntent'
        order_type:
          $ref: '#/components/schemas/aurora.core.consts.oms.OmsOrderType'
        quantity:
          description: Requested quantity of shares
          format: int64
          type: string
        rebate:
          description: Rate for the order expressed as rebate
          type: string
        root_client_order_ref:
          description: Root client order reference
          type: string
        side:
          $ref: '#/components/schemas/aurora.core.consts.common.Side'
        ticker:
          description: Ticker of the instrument
          type: string
      required:
        - side
        - quantity
        - order_type
        - cusip
        - ticker
        - company_id
        - market_value
        - root_client_order_ref
        - client_order_ref
        - active
        - order_intent
      type: object
    aurora.core.apiengine.venuev1.ExportMarketplaceRequest:
      description: >-
        Fields: borrow_filter, lend_filter, trade_intention, rate_type,
        is_excel_sheet
      properties:
        borrow_filter:
          $ref: >-
            #/components/schemas/aurora.core.apiengine.venuev1.QueryMarketplaceFilter
        is_excel_sheet:
          description: Export as CSV or XLSX
          type: boolean
        lend_filter:
          $ref: >-
            #/components/schemas/aurora.core.apiengine.venuev1.QueryMarketplaceFilter
        rate_type:
          $ref: '#/components/schemas/aurora.core.common.protos.RateType'
        trade_intention:
          $ref: '#/components/schemas/aurora.core.consts.common.Side'
      required:
        - trade_intention
      type: object
    aurora.core.apiengine.venuev1.ExportMarketplaceResponse:
      description: 'Fields: content'
      properties:
        content:
          description: file content
          format: byte
          type: string
      required:
        - content
      type: object
    aurora.core.apiengine.venuev1.ListChildOrdersRequest:
      description: 'Fields: parent_id'
      properties:
        parent_id:
          type: string
      required:
        - parent_id
      type: object
    aurora.core.apiengine.venuev1.ListChildOrdersResponse:
      description: 'Fields: orders'
      properties:
        orders:
          items:
            $ref: >-
              #/components/schemas/aurora.core.apiengine.venuev1.VenueOrderForOms
          type: array
      type: object
    aurora.core.apiengine.venuev1.Order:
      description: >-
        Fields: id, side, quantity, instrument, fee, rebate, min_quantity,
        order_type, agreement_ids, company_id, order_intent, created_at,
        updated_at
      properties:
        agreement_ids:
          description: agreements that the order can be matched under
          items:
            type: string
          type: array
        company_id:
          description: Company ID for the order
          type: string
        created_at:
          description: >-
            time at which order was created - time in RFC3339 with millisecond
            precision
          type: string
        fee:
          description: Fee
          type: string
        id:
          description: reference of the order
          type: string
        instrument:
          $ref: '#/components/schemas/aurora.core.common.protos.PbInstrument'
        min_quantity:
          description: Minimum quantity of shares per execution
          format: int64
          type: string
        order_intent:
          $ref: '#/components/schemas/aurora.core.consts.oms.OrderIntent'
        order_type:
          $ref: '#/components/schemas/aurora.core.consts.oms.OmsOrderType'
        quantity:
          description: Requested quantity of shares
          format: int64
          type: string
        rebate:
          description: Rebate
          type: string
        side:
          $ref: '#/components/schemas/aurora.core.consts.common.Side'
        updated_at:
          description: >-
            time at which order was last updated at - time in RFC3339 with
            millisecond precision
          type: string
      required:
        - id
        - side
        - quantity
        - instrument
        - min_quantity
        - order_type
        - company_id
        - order_intent
        - created_at
        - updated_at
      type: object
    aurora.core.apiengine.venuev1.OrderAddedEvent:
      description: 'Fields: request_id, order'
      properties:
        order:
          $ref: '#/components/schemas/aurora.core.apiengine.venuev1.Order'
        request_id:
          description: Unique request identifier assigned to the event
          type: string
      required:
        - request_id
        - order
      type: object
    aurora.core.apiengine.venuev1.OrderDetailed:
      description: >-
        Fields: id, side, quantity, instrument, fee, rebate, min_quantity,
        order_type, agreements, company_id, order_intent, created_at, updated_at
      properties:
        agreements:
          description: agreements that the order can be matched under
          items:
            $ref: '#/components/schemas/aurora.core.apiengine.agreementsv1.Agreement'
          type: array
        company_id:
          description: Company ID for the order
          type: string
        created_at:
          description: >-
            time at which order was created - time in RFC3339 with millisecond
            precision
          type: string
        fee:
          description: Fee
          type: string
        id:
          description: reference of the order
          type: string
        instrument:
          $ref: '#/components/schemas/aurora.core.common.protos.PbInstrument'
        min_quantity:
          description: Minimum quantity of shares per execution
          format: int64
          type: string
        order_intent:
          $ref: '#/components/schemas/aurora.core.consts.oms.OrderIntent'
        order_type:
          $ref: '#/components/schemas/aurora.core.consts.oms.OmsOrderType'
        quantity:
          description: Requested quantity of shares
          format: int64
          type: string
        rebate:
          description: Rebate
          type: string
        side:
          $ref: '#/components/schemas/aurora.core.consts.common.Side'
        updated_at:
          description: >-
            time at which order was last updated at - time in RFC3339 with
            millisecond precision
          type: string
      required:
        - id
        - side
        - quantity
        - instrument
        - min_quantity
        - order_type
        - company_id
        - order_intent
        - created_at
        - updated_at
      type: object
    aurora.core.apiengine.venuev1.OrderRemovedEvent:
      description: 'Fields: request_id, order'
      properties:
        order:
          $ref: '#/components/schemas/aurora.core.apiengine.venuev1.Order'
        request_id:
          description: Unique request identifier assigned to the event
          type: string
      required:
        - request_id
        - order
      type: object
    aurora.core.apiengine.venuev1.QueryMarketplaceFilter:
      description: >-
        Fields: instruments, order_type, minimum_quantity, maximum_quantity,
        minimum_rebate, maximum_rebate, minimum_fee, maximum_fee,
        minimum_min_execution_quantity, maximum_min_execution_quantity,
        agreement_ids, counterparty_ids, settlement_type, rate_type, own_orders,
        order_intent
      properties:
        agreement_ids:
          description: optionally restrict query to orders with agreement
          items:
            type: string
          type: array
        counterparty_ids:
          description: optionally restrict query to orders with counterparty
          items:
            type: string
          type: array
        instruments:
          description: Cusip or Ticker of the queried instruments
          items:
            type: string
          type: array
        maximum_fee:
          description: optionally restrict query to orders with maximum requested fee
          type: string
        maximum_min_execution_quantity:
          description: >-
            optionally restrict query to orders with a maximum execution
            quantity
          format: int64
          type: string
        maximum_quantity:
          description: >-
            optionally restrict query to orders with a maximum requested
            quantity
          format: int64
          type: string
        maximum_rebate:
          description: optionally restrict query to orders with maximum requested rebate
          type: string
        minimum_fee:
          description: optionally restrict query to orders with minimum requested fee
          type: string
        minimum_min_execution_quantity:
          description: >-
            optionally restrict query to orders with a minimum execution
            quantity
          format: int64
          type: string
        minimum_quantity:
          description: >-
            optionally restrict query to orders with a minimum requested
            quantity
          format: int64
          type: string
        minimum_rebate:
          description: optionally restrict query to orders with minimum requested rebate
          type: string
        order_intent:
          $ref: '#/components/schemas/aurora.core.consts.oms.OrderIntent'
        order_type:
          $ref: '#/components/schemas/aurora.core.consts.oms.OmsOrderType'
        own_orders:
          description: optionally restrict query to include own orders or not
          type: boolean
        rate_type:
          $ref: '#/components/schemas/aurora.core.common.protos.RateType'
        settlement_type:
          $ref: '#/components/schemas/aurora.core.consts.settlement.SettlementType'
      type: object
    aurora.core.apiengine.venuev1.QueryMarketplaceInstrument:
      description: 'Fields: instrument, order_count'
      properties:
        instrument:
          $ref: '#/components/schemas/aurora.core.common.protos.PbInstrumentInfo'
        order_count:
          description: Number of orders for the instrument
          format: int64
          type: string
      required:
        - instrument
        - order_count
      type: object
    aurora.core.apiengine.venuev1.QueryMarketplaceInstrumentsRequest:
      description: >-
        Fields: borrow_filter, lend_filter, trade_intention, own_instruments,
        counterparty_instruments, watchlist_display_id
      properties:
        borrow_filter:
          $ref: >-
            #/components/schemas/aurora.core.apiengine.venuev1.QueryMarketplaceFilter
        counterparty_instruments:
          description: show instruments that counterparties have orders for
          type: boolean
        lend_filter:
          $ref: >-
            #/components/schemas/aurora.core.apiengine.venuev1.QueryMarketplaceFilter
        own_instruments:
          description: show instruments that the user has orders for
          type: boolean
        trade_intention:
          $ref: '#/components/schemas/aurora.core.consts.common.Side'
        watchlist_display_id:
          description: optionally restrict query to instruments with watchlist
          type: string
      required:
        - trade_intention
      type: object
    aurora.core.apiengine.venuev1.QueryMarketplaceInstrumentsResponse:
      description: 'Fields: instruments'
      properties:
        instruments:
          items:
            $ref: >-
              #/components/schemas/aurora.core.apiengine.venuev1.QueryMarketplaceInstrument
          type: array
      type: object
    aurora.core.apiengine.venuev1.QueryMarketplaceItem:
      description: 'Fields: borrow_order, lend_order'
      properties:
        borrow_order:
          $ref: '#/components/schemas/aurora.core.apiengine.venuev1.BookOrder'
        lend_order:
          $ref: '#/components/schemas/aurora.core.apiengine.venuev1.BookOrder'
      type: object
    aurora.core.apiengine.venuev1.QueryMarketplaceRequest:
      description: >-
        Fields: borrow_filter, lend_filter, trade_intention, page_number,
        page_limit
      properties:
        borrow_filter:
          $ref: >-
            #/components/schemas/aurora.core.apiengine.venuev1.QueryMarketplaceFilter
        lend_filter:
          $ref: >-
            #/components/schemas/aurora.core.apiengine.venuev1.QueryMarketplaceFilter
        page_limit:
          description: Number of orders per page
          format: int32
          type: integer
        page_number:
          description: Page number, 1 being the starting one
          format: int32
          type: integer
        trade_intention:
          $ref: '#/components/schemas/aurora.core.consts.common.Side'
      required:
        - trade_intention
      type: object
    aurora.core.apiengine.venuev1.QueryMarketplaceResponse:
      description: 'Fields: items, instruments, companies, agreements'
      properties:
        agreements:
          $ref: '#/components/schemas/aurora.core.common.protos.PbAgreementInfo'
        companies:
          $ref: '#/components/schemas/aurora.core.common.protos.PbCompanyInfo'
        instruments:
          $ref: '#/components/schemas/aurora.core.common.protos.PbInstrumentInfo'
        items:
          description: List of borrow and lend order pairs
          items:
            $ref: >-
              #/components/schemas/aurora.core.apiengine.venuev1.QueryMarketplaceItem
          type: array
      required:
        - instruments
        - companies
        - agreements
      type: object
    aurora.core.apiengine.venuev1.QueryOrderBookDetailedRequest:
      description: >-
        Fields: instrument, side, order_type, minimum_quantity,
        maximum_quantity, rate_type, minimum_fee, maximum_fee, minimum_rebate,
        maximum_rebate, minimum_min_execution_quantity,
        maximum_min_execution_quantity, agreement_ids, company_ids, page_number,
        page_limit
      properties:
        agreement_ids:
          description: optionally restrict query to orders with specific agreements
          items:
            type: string
          type: array
        company_ids:
          description: optionally restrict query to orders created by a set of companies
          items:
            type: string
          type: array
        instrument:
          description: Cusip or Ticker of the queried instrument
          type: string
        maximum_fee:
          description: optionally restrict query to orders with maximum requested fee
          type: string
        maximum_min_execution_quantity:
          description: >-
            optionally restrict query to orders with a maximum requested
            quantity
          format: int64
          type: string
        maximum_quantity:
          description: >-
            optionally restrict query to orders with a maximum requested
            quantity
          format: int64
          type: string
        maximum_rebate:
          description: optionally restrict query to orders with maximum requested rebate
          type: string
        minimum_fee:
          description: optionally restrict query to orders with minimum requested fee
          type: string
        minimum_min_execution_quantity:
          description: >-
            optionally restrict query to orders with a minimum requested
            quantity
          format: int64
          type: string
        minimum_quantity:
          description: >-
            optionally restrict query to orders with a minimum requested
            quantity
          format: int64
          type: string
        minimum_rebate:
          description: optionally restrict query to orders with minimum requested rebate
          type: string
        order_type:
          $ref: '#/components/schemas/aurora.core.consts.oms.OmsOrderType'
        page_limit:
          description: >-
            Number of orders per page (max 20,000). Required if page_number is
            set. Defaults to 1,000 if not set.
          format: int32
          type: integer
        page_number:
          description: >-
            Page number, 1 being the starting one. Required if page_limit is
            set.
          format: int32
          type: integer
        rate_type:
          $ref: '#/components/schemas/aurora.core.common.protos.RateType'
        side:
          $ref: '#/components/schemas/aurora.core.consts.common.Side'
      type: object
    aurora.core.apiengine.venuev1.QueryOrderBookDetailedResponse:
      description: 'Fields: orders'
      properties:
        orders:
          items:
            $ref: '#/components/schemas/aurora.core.apiengine.venuev1.OrderDetailed'
          type: array
      type: object
    aurora.core.apiengine.venuev1.QueryOrderBookRequest:
      description: >-
        Fields: instruments, side, order_type, minimum_quantity,
        maximum_quantity, rate_type, minimum_fee, maximum_fee, minimum_rebate,
        maximum_rebate, minimum_min_execution_quantity,
        maximum_min_execution_quantity, agreement_ids, company_ids, page_number,
        page_limit
      properties:
        agreement_ids:
          description: optionally restrict query to orders with specific agreements
          items:
            type: string
          type: array
        company_ids:
          description: optionally restrict query to orders created by a set of companies
          items:
            type: string
          type: array
        instruments:
          description: Cusip or Ticker of the queried instruments
          items:
            type: string
          type: array
        maximum_fee:
          description: optionally restrict query to orders with maximum requested fee
          type: string
        maximum_min_execution_quantity:
          description: >-
            optionally restrict query to orders with a maximum min execution
            quantity
          format: int64
          type: string
        maximum_quantity:
          description: >-
            optionally restrict query to orders with a maximum requested
            quantity
          format: int64
          type: string
        maximum_rebate:
          description: optionally restrict query to orders with maximum requested rebate
          type: string
        minimum_fee:
          description: optionally restrict query to orders with minimum requested fee
          type: string
        minimum_min_execution_quantity:
          description: >-
            optionally restrict query to orders with a minimum min execution
            quantity
          format: int64
          type: string
        minimum_quantity:
          description: >-
            optionally restrict query to orders with a minimum requested
            quantity
          format: int64
          type: string
        minimum_rebate:
          description: optionally restrict query to orders with minimum requested rebate
          type: string
        order_type:
          $ref: '#/components/schemas/aurora.core.consts.oms.OmsOrderType'
        page_limit:
          description: >-
            Number of orders per page (max 20,000). Required if page_number is
            set. Defaults to 1,000 if not set.
          format: int32
          type: integer
        page_number:
          description: >-
            Page number, 1 being the starting one. Required if page_limit is
            set.
          format: int32
          type: integer
        rate_type:
          $ref: '#/components/schemas/aurora.core.common.protos.RateType'
        side:
          $ref: '#/components/schemas/aurora.core.consts.common.Side'
      type: object
    aurora.core.apiengine.venuev1.QueryOrderBookResponse:
      description: 'Fields: orders'
      properties:
        orders:
          items:
            $ref: '#/components/schemas/aurora.core.apiengine.venuev1.Order'
          type: array
      type: object
    aurora.core.apiengine.venuev1.VenueOrderForOms:
      description: >-
        Venue order for OMS<br>Fields: id, cusip, ticker, client_order_ref,
        company_id, agreement_ids, side, total_quantity, open_quantity,
        min_execution_quantity, fee, rebate, time_in_force, good_till_time,
        order_type, order_status, created_at, updated_at,
        total_execution_quantity, order_intent
      properties:
        agreement_ids:
          description: agreements that the order can be matched under
          items:
            type: string
          type: array
        client_order_ref:
          description: oms identifier of this order
          type: string
        company_id:
          description: Company ID owning  the order
          type: string
        created_at:
          description: Order created at - time in RFC3339 with millisecond precision
          type: string
        cusip:
          description: Cusip of the instrument
          type: string
        fee:
          description: Rate for the order expressed as fee
          type: string
        good_till_time:
          description: The time the order will be canceled if populated.
          type: string
        id:
          description: >-
            Provable Markets assigned order identifier for the order event
            notification
          type: string
        min_execution_quantity:
          description: Minimum quantity of shares per execution - optional, defaults to 100
          format: int64
          type: string
        open_quantity:
          description: remaining quantity of shares
          format: int64
          type: string
        order_intent:
          $ref: '#/components/schemas/aurora.core.consts.oms.OrderIntent'
        order_status:
          $ref: '#/components/schemas/aurora.core.consts.oms.OmsOrderStatus'
        order_type:
          $ref: '#/components/schemas/aurora.core.consts.oms.OmsOrderType'
        rebate:
          description: Rate for the order expressed as rebate
          type: string
        side:
          $ref: '#/components/schemas/aurora.core.consts.common.Side'
        ticker:
          description: Ticker of the instrument
          type: string
        time_in_force:
          description: Time In Force type (e.g. day, gtc, fok, ioc)
          type: string
        total_execution_quantity:
          description: shares executed on order so far
          format: int64
          type: string
        total_quantity:
          description: Requested quantity of shares
          format: int64
          type: string
        updated_at:
          description: >-
            Order was last changed at - time in RFC3339 with millisecond
            precision
          type: string
      required:
        - id
        - cusip
        - ticker
        - client_order_ref
        - company_id
        - side
        - total_quantity
        - open_quantity
        - time_in_force
        - order_type
        - order_status
        - created_at
        - updated_at
        - total_execution_quantity
        - order_intent
      type: object
    aurora.core.apiengine.uicustomizationv1.CreateConfigRequest:
      description: 'Fields: name, visibility, config, position'
      properties:
        config:
          $ref: '#/components/schemas/google.protobuf.Struct'
        name:
          description: >-
            Configurations are grouped by a name, typically the name of the page
            like `orderbook`, `open_positions`, ...
          type: string
        position:
          description: >-
            Display order of the config, the user can drag configs around to
            reorder them
          format: int32
          type: integer
        visibility:
          $ref: '#/components/schemas/aurora.core.consts.uiconfig.UIConfigVisibility'
      required:
        - name
        - visibility
        - config
        - position
      type: object
    aurora.core.apiengine.uicustomizationv1.CreateConfigResponse:
      description: 'Fields: config_id'
      properties:
        config_id:
          type: string
      required:
        - config_id
      type: object
    aurora.core.apiengine.uicustomizationv1.DeleteConfigRequest:
      description: 'Fields: config_id'
      properties:
        config_id:
          type: string
      required:
        - config_id
      type: object
    aurora.core.apiengine.uicustomizationv1.DeleteConfigResponse:
      type: object
    aurora.core.apiengine.uicustomizationv1.GetConfigsByNameRequest:
      description: 'Fields: name'
      properties:
        name:
          description: >-
            Configurations are grouped by a name, typically the name of the page
            like `orderbook`, `open_positions`, ...
          type: string
      required:
        - name
      type: object
    aurora.core.apiengine.uicustomizationv1.GetConfigsByNameResponse:
      description: 'Fields: configs'
      properties:
        configs:
          items:
            $ref: >-
              #/components/schemas/aurora.core.apiengine.uicustomizationv1.UIConfig
          type: array
      type: object
    aurora.core.apiengine.uicustomizationv1.ModifyConfigRequest:
      description: 'Fields: config_id, visibility, config'
      properties:
        config:
          $ref: '#/components/schemas/google.protobuf.Struct'
        config_id:
          type: string
        visibility:
          $ref: '#/components/schemas/aurora.core.consts.uiconfig.UIConfigVisibility'
      required:
        - config_id
        - visibility
        - config
      type: object
    aurora.core.apiengine.uicustomizationv1.ModifyConfigResponse:
      type: object
    aurora.core.apiengine.uicustomizationv1.MoveConfigRequest:
      description: 'Fields: config_id, new_position'
      properties:
        config_id:
          type: string
        new_position:
          format: int32
          type: integer
      required:
        - config_id
        - new_position
      type: object
    aurora.core.apiengine.uicustomizationv1.MoveConfigResponse:
      type: object
    aurora.core.apiengine.uicustomizationv1.UIConfig:
      description: 'Fields: id, name, visibility, config, position, is_owner'
      properties:
        config:
          $ref: '#/components/schemas/google.protobuf.Struct'
        id:
          description: Config identifier
          type: string
        is_owner:
          description: >-
            The user can be the owner of the configuration but the configuration
            can also be shared by a colleague
          type: boolean
        name:
          description: >-
            Configurations are grouped by a name, typically the name of the page
            like `orderbook`, `open_positions`, ...
          type: string
        position:
          description: >-
            Display order of the config, the user can drag configs around to
            reorder them
          format: int32
          type: integer
        visibility:
          $ref: '#/components/schemas/aurora.core.consts.uiconfig.UIConfigVisibility'
      required:
        - id
        - name
        - visibility
        - config
        - position
        - is_owner
      type: object
    aurora.core.consts.uiconfig.UIConfigVisibility:
      enum:
        - PRIVATE
        - READONLY
        - READWRITE
      type: string
    google.protobuf.ListValue:
      description: |-
        `ListValue` is a wrapper around a repeated field of values.

        The JSON representation for `ListValue` is JSON array.<br>Fields: values
      properties:
        values:
          description: Repeated field of dynamically typed values.
          items:
            $ref: '#/components/schemas/google.protobuf.Value'
          type: array
      type: object
    google.protobuf.NullValue:
      description: >-
        `NullValue` is a singleton enumeration to represent the null value for
        the

        `Value` type union.


        The JSON representation for `NullValue` is JSON `null`.
      enum:
        - NULL_VALUE
      type: string
    google.protobuf.Struct:
      description: |-
        `Struct` represents a structured data value, consisting of fields
        which map to dynamically typed values. In some languages, `Struct`
        might be supported by a native representation. For example, in
        scripting languages like JS a struct is represented as an
        object. The details of that representation are described together
        with the proto support for the language.

        The JSON representation for `Struct` is JSON object.<br>Fields: fields
      properties:
        fields:
          $ref: '#/components/schemas/google.protobuf.Value'
      required:
        - fields
      type: object
    google.protobuf.Value:
      description: >-
        `Value` represents a dynamically typed value which can be either

        null, a number, a string, a boolean, a recursive struct value, or a

        list of values. A producer of value is expected to set one of these

        variants. Absence of any variant indicates an error.


        The JSON representation for `Value` is JSON value.<br>Fields:
        null_value, number_value, string_value, bool_value, struct_value,
        list_value
      properties:
        bool_value:
          description: Represents a boolean value.
          type: boolean
        list_value:
          $ref: '#/components/schemas/google.protobuf.ListValue'
        null_value:
          $ref: '#/components/schemas/google.protobuf.NullValue'
        number_value:
          description: Represents a double value.
          format: double
          type: number
        string_value:
          description: Represents a string value.
          type: string
        struct_value:
          $ref: '#/components/schemas/google.protobuf.Struct'
      required:
        - null_value
        - number_value
        - string_value
        - bool_value
        - struct_value
        - list_value
      type: object
    aurora.core.apiengine.loginv1.ConfirmIdentityRequest:
      description: 'Fields: secret'
      properties:
        secret:
          type: string
      required:
        - secret
      type: object
    aurora.core.apiengine.loginv1.ConfirmIdentityResponse:
      type: object
    aurora.core.apiengine.loginv1.LoginWithApiCredentialsRequest:
      description: 'Fields: client_id, secret'
      properties:
        client_id:
          type: string
        secret:
          type: string
      required:
        - client_id
        - secret
      type: object
    aurora.core.apiengine.loginv1.LoginWithApiCredentialsResponse:
      description: 'Fields: access_token'
      properties:
        access_token:
          description: access token with a TTL of 1 week
          type: string
      required:
        - access_token
      type: object
    aurora.core.apiengine.loginv1.LoginWithSAMLTicketRequest:
      description: 'Fields: ticket'
      properties:
        ticket:
          type: string
      required:
        - ticket
      type: object
    aurora.core.apiengine.loginv1.LoginWithSAMLTicketResponse:
      description: 'Fields: access_token, refresh_token'
      properties:
        access_token:
          type: string
        refresh_token:
          type: string
      required:
        - access_token
        - refresh_token
      type: object
    aurora.core.apiengine.loginv1.LoginWithUserCredentialsRequest:
      description: 'Fields: email, password, otp_code'
      properties:
        email:
          type: string
        otp_code:
          type: string
        password:
          type: string
      required:
        - email
        - password
      type: object
    aurora.core.apiengine.loginv1.LoginWithUserCredentialsResponse:
      description: 'Fields: access_token, refresh_token'
      properties:
        access_token:
          type: string
        refresh_token:
          type: string
      required:
        - access_token
        - refresh_token
      type: object
    aurora.core.apiengine.loginv1.RefreshTokenRequest:
      description: 'Fields: token'
      properties:
        token:
          type: string
      required:
        - token
      type: object
    aurora.core.apiengine.loginv1.RefreshTokenResponse:
      description: 'Fields: access_token, refresh_token'
      properties:
        access_token:
          type: string
        refresh_token:
          type: string
      required:
        - access_token
        - refresh_token
      type: object
    aurora.core.apiengine.companiesv1.Company:
      description: 'Fields: id, name'
      properties:
        id:
          type: string
        name:
          type: string
      required:
        - id
        - name
      type: object
    aurora.core.apiengine.companiesv1.ListCompaniesRequest:
      type: object
    aurora.core.apiengine.companiesv1.ListCompaniesResponse:
      description: 'Fields: companies'
      properties:
        companies:
          items:
            $ref: '#/components/schemas/aurora.core.apiengine.companiesv1.Company'
          type: array
      type: object
    aurora.core.apiengine.companiesv1.ListCompanyDetailsRequest:
      type: object
    aurora.core.apiengine.companiesv1.ListCompanyDetailsResponse:
      description: 'Fields: companies'
      properties:
        companies:
          items:
            $ref: '#/components/schemas/aurora.core.common.protos.PbCompanyInfo'
          type: array
      type: object
  securitySchemes:
    Bearer:
      in: header
      name: Authorization
      type: apiKey
openapi: 3.0.3
paths:
  /aurora.core.apiengine.omsv1.OmsEventsService/OrderCanceled:
    post:
      description: >-
        <p style="font-family:monospace;color:#777;font-size:14px;padding:0 0
        4px 0"><b>PATH:</b>
        /aurora.core.apiengine.omsv1.OmsEventsService/OrderCanceled</p>

          
      operationId: OrderCanceled
      requestBody:
        content:
          application/json:
            schema:
              $ref: >-
                #/components/schemas/aurora.core.apiengine.omsv1.OrderCanceledEvent
        required: true
        x-originalParamName: body
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/google.protobuf.Empty'
          description: A successful response
      security:
        - Bearer: []
      summary: OrderCanceled
      tags:
        - OmsEventsService
  /aurora.core.apiengine.omsv1.OmsEventsService/OrderClosed:
    post:
      description: >-
        <p style="font-family:monospace;color:#777;font-size:14px;padding:0 0
        4px 0"><b>PATH:</b>
        /aurora.core.apiengine.omsv1.OmsEventsService/OrderClosed</p>

          
      operationId: OrderClosed
      requestBody:
        content:
          application/json:
            schema:
              $ref: >-
                #/components/schemas/aurora.core.apiengine.omsv1.OrderClosedEvent
        required: true
        x-originalParamName: body
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/google.protobuf.Empty'
          description: A successful response
      security:
        - Bearer: []
      summary: OrderClosed
      tags:
        - OmsEventsService
  /aurora.core.apiengine.omsv1.OmsEventsService/OrderCreated:
    post:
      description: >-
        <p style="font-family:monospace;color:#777;font-size:14px;padding:0 0
        4px 0"><b>PATH:</b>
        /aurora.core.apiengine.omsv1.OmsEventsService/OrderCreated</p>

          
      operationId: OrderCreated
      requestBody:
        content:
          application/json:
            schema:
              $ref: >-
                #/components/schemas/aurora.core.apiengine.omsv1.OrderCreatedEvent
        required: true
        x-originalParamName: body
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/google.protobuf.Empty'
          description: A successful response
      security:
        - Bearer: []
      summary: OrderCreated
      tags:
        - OmsEventsService
  /aurora.core.apiengine.omsv1.OmsEventsService/OrderExecuted:
    post:
      description: >-
        <p style="font-family:monospace;color:#777;font-size:14px;padding:0 0
        4px 0"><b>PATH:</b>
        /aurora.core.apiengine.omsv1.OmsEventsService/OrderExecuted</p>

          
      operationId: OrderExecuted
      requestBody:
        content:
          application/json:
            schema:
              $ref: >-
                #/components/schemas/aurora.core.apiengine.omsv1.OrderExecutedEvent
        required: true
        x-originalParamName: body
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/google.protobuf.Empty'
          description: A successful response
      security:
        - Bearer: []
      summary: OrderExecuted
      tags:
        - OmsEventsService
  /aurora.core.apiengine.omsv1.OmsEventsService/OrderExpired:
    post:
      description: >-
        <p style="font-family:monospace;color:#777;font-size:14px;padding:0 0
        4px 0"><b>PATH:</b>
        /aurora.core.apiengine.omsv1.OmsEventsService/OrderExpired</p>

          
      operationId: OrderExpired
      requestBody:
        content:
          application/json:
            schema:
              $ref: >-
                #/components/schemas/aurora.core.apiengine.omsv1.OrderExpiredEvent
        required: true
        x-originalParamName: body
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/google.protobuf.Empty'
          description: A successful response
      security:
        - Bearer: []
      summary: OrderExpired
      tags:
        - OmsEventsService
  /aurora.core.apiengine.omsv1.OmsEventsService/OrderModified:
    post:
      description: >-
        <p style="font-family:monospace;color:#777;font-size:14px;padding:0 0
        4px 0"><b>PATH:</b>
        /aurora.core.apiengine.omsv1.OmsEventsService/OrderModified</p>

          
      operationId: OrderModified
      requestBody:
        content:
          application/json:
            schema:
              $ref: >-
                #/components/schemas/aurora.core.apiengine.omsv1.OrderModifiedEvent
        required: true
        x-originalParamName: body
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/google.protobuf.Empty'
          description: A successful response
      security:
        - Bearer: []
      summary: OrderModified
      tags:
        - OmsEventsService
  /aurora.core.apiengine.omsv1.OmsService/CancelOrder:
    post:
      description: >-
        <p style="font-family:monospace;color:#777;font-size:14px;padding:0 0
        4px 0"><b>PATH:</b>
        /aurora.core.apiengine.omsv1.OmsService/CancelOrder</p>

          
      operationId: CancelOrder
      requestBody:
        content:
          application/json:
            schema:
              $ref: >-
                #/components/schemas/aurora.core.apiengine.omsv1.CancelOrderRequest
        required: true
        x-originalParamName: body
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/aurora.core.apiengine.omsv1.CancelOrderResponse
          description: A successful response
      security:
        - Bearer: []
      summary: CancelOrder
      tags:
        - OmsService
  /aurora.core.apiengine.omsv1.OmsService/CreateOrder:
    post:
      description: >-
        <p style="font-family:monospace;color:#777;font-size:14px;padding:0 0
        4px 0"><b>PATH:</b>
        /aurora.core.apiengine.omsv1.OmsService/CreateOrder</p>

          
      operationId: CreateOrder
      requestBody:
        content:
          application/json:
            schema:
              $ref: >-
                #/components/schemas/aurora.core.apiengine.omsv1.CreateOrderRequest
        required: true
        x-originalParamName: body
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/aurora.core.apiengine.omsv1.CreateOrderResponse
          description: A successful response
      security:
        - Bearer: []
      summary: CreateOrder
      tags:
        - OmsService
  /aurora.core.apiengine.omsv1.OmsService/GetOrder:
    post:
      description: >-
        <p style="font-family:monospace;color:#777;font-size:14px;padding:0 0
        4px 0"><b>PATH:</b> /aurora.core.apiengine.omsv1.OmsService/GetOrder</p>

          
      operationId: GetOrder
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/aurora.core.apiengine.omsv1.GetOrderRequest'
        required: true
        x-originalParamName: body
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/aurora.core.apiengine.omsv1.GetOrderResponse
          description: A successful response
      security:
        - Bearer: []
      summary: GetOrder
      tags:
        - OmsService
  /aurora.core.apiengine.omsv1.OmsService/ListOrders:
    post:
      description: >-
        <p style="font-family:monospace;color:#777;font-size:14px;padding:0 0
        4px 0"><b>PATH:</b>
        /aurora.core.apiengine.omsv1.OmsService/ListOrders</p>

          
      operationId: ListOrders
      requestBody:
        content:
          application/json:
            schema:
              $ref: >-
                #/components/schemas/aurora.core.apiengine.omsv1.ListOrdersRequest
        required: true
        x-originalParamName: body
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/aurora.core.apiengine.omsv1.ListOrdersResponse
          description: A successful response
      security:
        - Bearer: []
      summary: ListOrders
      tags:
        - OmsService
  /aurora.core.apiengine.omsv1.OmsService/ModifyOrder:
    post:
      description: >-
        <p style="font-family:monospace;color:#777;font-size:14px;padding:0 0
        4px 0"><b>PATH:</b>
        /aurora.core.apiengine.omsv1.OmsService/ModifyOrder</p>

          
      operationId: ModifyOrder
      requestBody:
        content:
          application/json:
            schema:
              $ref: >-
                #/components/schemas/aurora.core.apiengine.omsv1.ModifyOrderRequest
        required: true
        x-originalParamName: body
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/aurora.core.apiengine.omsv1.ModifyOrderResponse
          description: A successful response
      security:
        - Bearer: []
      summary: ModifyOrder
      tags:
        - OmsService
  /aurora.core.apiengine.reportingv1.ReportingService/ListCompanyReports:
    post:
      description: >-
        <p style="font-family:monospace;color:#777;font-size:14px;padding:0 0
        4px 0"><b>PATH:</b>
        /aurora.core.apiengine.reportingv1.ReportingService/ListCompanyReports</p>

          
      operationId: ListCompanyReports
      requestBody:
        content:
          application/json:
            schema:
              $ref: >-
                #/components/schemas/aurora.core.apiengine.reportingv1.ListCompanyReportsRequest
        required: true
        x-originalParamName: body
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/aurora.core.apiengine.reportingv1.ListCompanyReportsResponse
          description: A successful response
      security:
        - Bearer: []
      summary: ListCompanyReports
      tags:
        - ReportingService
  /aurora.core.apiengine.contractsv1.ContractService/AcceptAwaitingContractReturn:
    post:
      description: >-
        <p style="font-family:monospace;color:#777;font-size:14px;padding:0 0
        4px 0"><b>PATH:</b>
        /aurora.core.apiengine.contractsv1.ContractService/AcceptAwaitingContractReturn</p>

          
      operationId: AcceptAwaitingContractReturn
      requestBody:
        content:
          application/json:
            schema:
              $ref: >-
                #/components/schemas/aurora.core.apiengine.contractsv1.AcceptAwaitingContractReturnRequest
        required: true
        x-originalParamName: body
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/aurora.core.apiengine.contractsv1.AcceptAwaitingContractReturnResponse
          description: A successful response
      security:
        - Bearer: []
      summary: AcceptAwaitingContractReturn
      tags:
        - ContractService
  /aurora.core.apiengine.contractsv1.ContractService/AcceptRateModification:
    post:
      description: >-
        <p style="font-family:monospace;color:#777;font-size:14px;padding:0 0
        4px 0"><b>PATH:</b>
        /aurora.core.apiengine.contractsv1.ContractService/AcceptRateModification</p>

          
      operationId: AcceptRateModification
      requestBody:
        content:
          application/json:
            schema:
              $ref: >-
                #/components/schemas/aurora.core.apiengine.contractsv1.UpdateRateModificationRequest
        required: true
        x-originalParamName: body
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/aurora.core.apiengine.contractsv1.UpdateRateModificationResponse
          description: A successful response
      security:
        - Bearer: []
      summary: AcceptRateModification
      tags:
        - ContractService
  /aurora.core.apiengine.contractsv1.ContractService/BuyInContract:
    post:
      description: >-
        <p style="font-family:monospace;color:#777;font-size:14px;padding:0 0
        4px 0"><b>PATH:</b>
        /aurora.core.apiengine.contractsv1.ContractService/BuyInContract</p>

          ### 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.
      operationId: BuyInContract
      requestBody:
        content:
          application/json:
            schema:
              $ref: >-
                #/components/schemas/aurora.core.apiengine.contractsv1.BuyInContractRequest
        required: true
        x-originalParamName: body
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/aurora.core.apiengine.contractsv1.BuyInContractResponse
          description: >-
            A successful response<br>Returns current status of the `BuyIn`
            request
      security:
        - Bearer: []
      summary: BuyInContract
      tags:
        - ContractService
  /aurora.core.apiengine.contractsv1.ContractService/CancelAllPendingReturns:
    post:
      description: >-
        <p style="font-family:monospace;color:#777;font-size:14px;padding:0 0
        4px 0"><b>PATH:</b>
        /aurora.core.apiengine.contractsv1.ContractService/CancelAllPendingReturns</p>

          
      operationId: CancelAllPendingReturns
      requestBody:
        content:
          application/json:
            schema:
              $ref: >-
                #/components/schemas/aurora.core.apiengine.contractsv1.CancelAllPendingReturnsRequest
        required: true
        x-originalParamName: body
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/aurora.core.apiengine.contractsv1.CancelAllPendingReturnsResponse
          description: A successful response
      security:
        - Bearer: []
      summary: CancelAllPendingReturns
      tags:
        - ContractService
  /aurora.core.apiengine.contractsv1.ContractService/CancelAllRecalls:
    post:
      description: >-
        <p style="font-family:monospace;color:#777;font-size:14px;padding:0 0
        4px 0"><b>PATH:</b>
        /aurora.core.apiengine.contractsv1.ContractService/CancelAllRecalls</p>

          
      operationId: CancelAllRecalls
      requestBody:
        content:
          application/json:
            schema:
              $ref: >-
                #/components/schemas/aurora.core.apiengine.contractsv1.CancelAllRecallsRequest
        required: true
        x-originalParamName: body
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/aurora.core.apiengine.contractsv1.CancelAllRecallsResponse
          description: A successful response
      security:
        - Bearer: []
      summary: CancelAllRecalls
      tags:
        - ContractService
  /aurora.core.apiengine.contractsv1.ContractService/CancelAwaitingContractReturn:
    post:
      description: >-
        <p style="font-family:monospace;color:#777;font-size:14px;padding:0 0
        4px 0"><b>PATH:</b>
        /aurora.core.apiengine.contractsv1.ContractService/CancelAwaitingContractReturn</p>

          
      operationId: CancelAwaitingContractReturn
      requestBody:
        content:
          application/json:
            schema:
              $ref: >-
                #/components/schemas/aurora.core.apiengine.contractsv1.CancelAwaitingContractReturnRequest
        required: true
        x-originalParamName: body
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/aurora.core.apiengine.contractsv1.CancelAwaitingContractReturnResponse
          description: A successful response
      security:
        - Bearer: []
      summary: CancelAwaitingContractReturn
      tags:
        - ContractService
  /aurora.core.apiengine.contractsv1.ContractService/CancelContract:
    post:
      description: >-
        <p style="font-family:monospace;color:#777;font-size:14px;padding:0 0
        4px 0"><b>PATH:</b>
        /aurora.core.apiengine.contractsv1.ContractService/CancelContract</p>

          CancelContract can be use to cancel a Pending Contract
      operationId: CancelContract
      requestBody:
        content:
          application/json:
            schema:
              $ref: >-
                #/components/schemas/aurora.core.apiengine.contractsv1.CancelContractRequest
        required: true
        x-originalParamName: body
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/aurora.core.apiengine.contractsv1.CancelContractResponse
          description: A successful response
      security:
        - Bearer: []
      summary: CancelContract
      tags:
        - ContractService
  /aurora.core.apiengine.contractsv1.ContractService/CancelRateModification:
    post:
      description: >-
        <p style="font-family:monospace;color:#777;font-size:14px;padding:0 0
        4px 0"><b>PATH:</b>
        /aurora.core.apiengine.contractsv1.ContractService/CancelRateModification</p>

          
      operationId: CancelRateModification
      requestBody:
        content:
          application/json:
            schema:
              $ref: >-
                #/components/schemas/aurora.core.apiengine.contractsv1.UpdateRateModificationRequest
        required: true
        x-originalParamName: body
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/aurora.core.apiengine.contractsv1.UpdateRateModificationResponse
          description: A successful response
      security:
        - Bearer: []
      summary: CancelRateModification
      tags:
        - ContractService
  /aurora.core.apiengine.contractsv1.ContractService/CancelRecallContract:
    post:
      description: >-
        <p style="font-family:monospace;color:#777;font-size:14px;padding:0 0
        4px 0"><b>PATH:</b>
        /aurora.core.apiengine.contractsv1.ContractService/CancelRecallContract</p>

          
      operationId: CancelRecallContract
      requestBody:
        content:
          application/json:
            schema:
              $ref: >-
                #/components/schemas/aurora.core.apiengine.contractsv1.CancelRecallContractRequest
        required: true
        x-originalParamName: body
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/aurora.core.apiengine.contractsv1.CancelRecallContractResponse
          description: A successful response
      security:
        - Bearer: []
      summary: CancelRecallContract
      tags:
        - ContractService
  /aurora.core.apiengine.contractsv1.ContractService/CancelSinglePendingReturn:
    post:
      description: >-
        <p style="font-family:monospace;color:#777;font-size:14px;padding:0 0
        4px 0"><b>PATH:</b>
        /aurora.core.apiengine.contractsv1.ContractService/CancelSinglePendingReturn</p>

          
      operationId: CancelSinglePendingReturn
      requestBody:
        content:
          application/json:
            schema:
              $ref: >-
                #/components/schemas/aurora.core.apiengine.contractsv1.CancelSinglePendingReturnRequest
        required: true
        x-originalParamName: body
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/aurora.core.apiengine.contractsv1.CancelSinglePendingReturnResponse
          description: A successful response
      security:
        - Bearer: []
      summary: CancelSinglePendingReturn
      tags:
        - ContractService
  /aurora.core.apiengine.contractsv1.ContractService/CreateRateModification:
    post:
      description: >-
        <p style="font-family:monospace;color:#777;font-size:14px;padding:0 0
        4px 0"><b>PATH:</b>
        /aurora.core.apiengine.contractsv1.ContractService/CreateRateModification</p>

          
      operationId: CreateRateModification
      requestBody:
        content:
          application/json:
            schema:
              $ref: >-
                #/components/schemas/aurora.core.apiengine.contractsv1.CreateRateModificationRequest
        required: true
        x-originalParamName: body
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/aurora.core.apiengine.contractsv1.CreateRateModificationResponse
          description: A successful response
      security:
        - Bearer: []
      summary: CreateRateModification
      tags:
        - ContractService
  /aurora.core.apiengine.contractsv1.ContractService/GetContract:
    post:
      description: >-
        <p style="font-family:monospace;color:#777;font-size:14px;padding:0 0
        4px 0"><b>PATH:</b>
        /aurora.core.apiengine.contractsv1.ContractService/GetContract</p>

          
      operationId: GetContract
      requestBody:
        content:
          application/json:
            schema:
              $ref: >-
                #/components/schemas/aurora.core.apiengine.contractsv1.GetContractRequest
        required: true
        x-originalParamName: body
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/aurora.core.apiengine.contractsv1.GetContractResponse
          description: A successful response
      security:
        - Bearer: []
      summary: GetContract
      tags:
        - ContractService
  /aurora.core.apiengine.contractsv1.ContractService/ListContractHistory:
    post:
      description: >-
        <p style="font-family:monospace;color:#777;font-size:14px;padding:0 0
        4px 0"><b>PATH:</b>
        /aurora.core.apiengine.contractsv1.ContractService/ListContractHistory</p>

          ListContractHistory provides a way to query contract events
        This can be used to get the full history of everything that has happened
        to a contract

        or for example to get all the returns that happened on a specific date
        or for a specific instrument
      operationId: ListContractHistory
      requestBody:
        content:
          application/json:
            schema:
              $ref: >-
                #/components/schemas/aurora.core.apiengine.contractsv1.ListContractHistoryRequest
        required: true
        x-originalParamName: body
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/aurora.core.apiengine.contractsv1.ListContractHistoryResponse
          description: A successful response
      security:
        - Bearer: []
      summary: ListContractHistory
      tags:
        - ContractService
  /aurora.core.apiengine.contractsv1.ContractService/ListContracts:
    post:
      description: >-
        <p style="font-family:monospace;color:#777;font-size:14px;padding:0 0
        4px 0"><b>PATH:</b>
        /aurora.core.apiengine.contractsv1.ContractService/ListContracts</p>

          
      operationId: ListContracts
      requestBody:
        content:
          application/json:
            schema:
              $ref: >-
                #/components/schemas/aurora.core.apiengine.contractsv1.ListContractsRequest
        required: true
        x-originalParamName: body
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/aurora.core.apiengine.contractsv1.ListContractsResponse
          description: A successful response
      security:
        - Bearer: []
      summary: ListContracts
      tags:
        - ContractService
  /aurora.core.apiengine.contractsv1.ContractService/ListRateModifications:
    post:
      description: >-
        <p style="font-family:monospace;color:#777;font-size:14px;padding:0 0
        4px 0"><b>PATH:</b>
        /aurora.core.apiengine.contractsv1.ContractService/ListRateModifications</p>

          
      operationId: ListRateModifications
      requestBody:
        content:
          application/json:
            schema:
              $ref: >-
                #/components/schemas/aurora.core.apiengine.contractsv1.ListRateModificationsRequest
        required: true
        x-originalParamName: body
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/aurora.core.apiengine.contractsv1.ListRateModificationsResponse
          description: A successful response
      security:
        - Bearer: []
      summary: ListRateModifications
      tags:
        - ContractService
  /aurora.core.apiengine.contractsv1.ContractService/ListRecalls:
    post:
      description: >-
        <p style="font-family:monospace;color:#777;font-size:14px;padding:0 0
        4px 0"><b>PATH:</b>
        /aurora.core.apiengine.contractsv1.ContractService/ListRecalls</p>

          
      operationId: ListRecalls
      requestBody:
        content:
          application/json:
            schema:
              $ref: >-
                #/components/schemas/aurora.core.apiengine.contractsv1.ListRecallsRequest
        required: true
        x-originalParamName: body
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/aurora.core.apiengine.contractsv1.ListRecallsResponse
          description: A successful response
      security:
        - Bearer: []
      summary: ListRecalls
      tags:
        - ContractService
  /aurora.core.apiengine.contractsv1.ContractService/RecallContract:
    post:
      description: >-
        <p style="font-family:monospace;color:#777;font-size:14px;padding:0 0
        4px 0"><b>PATH:</b>
        /aurora.core.apiengine.contractsv1.ContractService/RecallContract</p>

          
      operationId: RecallContract
      requestBody:
        content:
          application/json:
            schema:
              $ref: >-
                #/components/schemas/aurora.core.apiengine.contractsv1.RecallContractRequest
        required: true
        x-originalParamName: body
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/aurora.core.apiengine.contractsv1.RecallContractResponse
          description: A successful response
      security:
        - Bearer: []
      summary: RecallContract
      tags:
        - ContractService
  /aurora.core.apiengine.contractsv1.ContractService/RejectAwaitingContractReturn:
    post:
      description: >-
        <p style="font-family:monospace;color:#777;font-size:14px;padding:0 0
        4px 0"><b>PATH:</b>
        /aurora.core.apiengine.contractsv1.ContractService/RejectAwaitingContractReturn</p>

          
      operationId: RejectAwaitingContractReturn
      requestBody:
        content:
          application/json:
            schema:
              $ref: >-
                #/components/schemas/aurora.core.apiengine.contractsv1.RejectAwaitingContractReturnRequest
        required: true
        x-originalParamName: body
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/aurora.core.apiengine.contractsv1.RejectAwaitingContractReturnResponse
          description: A successful response
      security:
        - Bearer: []
      summary: RejectAwaitingContractReturn
      tags:
        - ContractService
  /aurora.core.apiengine.contractsv1.ContractService/RejectRateModification:
    post:
      description: >-
        <p style="font-family:monospace;color:#777;font-size:14px;padding:0 0
        4px 0"><b>PATH:</b>
        /aurora.core.apiengine.contractsv1.ContractService/RejectRateModification</p>

          
      operationId: RejectRateModification
      requestBody:
        content:
          application/json:
            schema:
              $ref: >-
                #/components/schemas/aurora.core.apiengine.contractsv1.UpdateRateModificationRequest
        required: true
        x-originalParamName: body
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/aurora.core.apiengine.contractsv1.UpdateRateModificationResponse
          description: A successful response
      security:
        - Bearer: []
      summary: RejectRateModification
      tags:
        - ContractService
  /aurora.core.apiengine.contractsv1.ContractService/ReturnContract:
    post:
      description: >-
        <p style="font-family:monospace;color:#777;font-size:14px;padding:0 0
        4px 0"><b>PATH:</b>
        /aurora.core.apiengine.contractsv1.ContractService/ReturnContract</p>

          
      operationId: ReturnContract
      requestBody:
        content:
          application/json:
            schema:
              $ref: >-
                #/components/schemas/aurora.core.apiengine.contractsv1.ReturnContractRequest
        required: true
        x-originalParamName: body
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/aurora.core.apiengine.contractsv1.ReturnContractResponse
          description: A successful response
      security:
        - Bearer: []
      summary: ReturnContract
      tags:
        - ContractService
  /aurora.core.apiengine.contractsv1.ContractEventsService/CancelContractAccepted:
    post:
      description: >-
        <p style="font-family:monospace;color:#777;font-size:14px;padding:0 0
        4px 0"><b>PATH:</b>
        /aurora.core.apiengine.contractsv1.ContractEventsService/CancelContractAccepted</p>

          
      operationId: CancelContractAccepted
      requestBody:
        content:
          application/json:
            schema:
              $ref: >-
                #/components/schemas/aurora.core.apiengine.contractsv1.CancelContractAcceptedEvent
        required: true
        x-originalParamName: body
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/google.protobuf.Empty'
          description: A successful response
      security:
        - Bearer: []
      summary: CancelContractAccepted
      tags:
        - ContractEventsService
  /aurora.core.apiengine.contractsv1.ContractEventsService/CancelContractRejected:
    post:
      description: >-
        <p style="font-family:monospace;color:#777;font-size:14px;padding:0 0
        4px 0"><b>PATH:</b>
        /aurora.core.apiengine.contractsv1.ContractEventsService/CancelContractRejected</p>

          
      operationId: CancelContractRejected
      requestBody:
        content:
          application/json:
            schema:
              $ref: >-
                #/components/schemas/aurora.core.apiengine.contractsv1.CancelContractRejectedEvent
        required: true
        x-originalParamName: body
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/google.protobuf.Empty'
          description: A successful response
      security:
        - Bearer: []
      summary: CancelContractRejected
      tags:
        - ContractEventsService
  /aurora.core.apiengine.contractsv1.ContractEventsService/ContractBuyInAccepted:
    post:
      description: >-
        <p style="font-family:monospace;color:#777;font-size:14px;padding:0 0
        4px 0"><b>PATH:</b>
        /aurora.core.apiengine.contractsv1.ContractEventsService/ContractBuyInAccepted</p>

          
      operationId: ContractBuyInAccepted
      requestBody:
        content:
          application/json:
            schema:
              $ref: >-
                #/components/schemas/aurora.core.apiengine.contractsv1.ContractBuyInAcceptedEvent
        required: true
        x-originalParamName: body
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/google.protobuf.Empty'
          description: A successful response
      security:
        - Bearer: []
      summary: ContractBuyInAccepted
      tags:
        - ContractEventsService
  /aurora.core.apiengine.contractsv1.ContractEventsService/ContractBuyInExecuted:
    post:
      description: >-
        <p style="font-family:monospace;color:#777;font-size:14px;padding:0 0
        4px 0"><b>PATH:</b>
        /aurora.core.apiengine.contractsv1.ContractEventsService/ContractBuyInExecuted</p>

          
      operationId: ContractBuyInExecuted
      requestBody:
        content:
          application/json:
            schema:
              $ref: >-
                #/components/schemas/aurora.core.apiengine.contractsv1.ContractBuyInExecutedEvent
        required: true
        x-originalParamName: body
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/google.protobuf.Empty'
          description: A successful response
      security:
        - Bearer: []
      summary: ContractBuyInExecuted
      tags:
        - ContractEventsService
  /aurora.core.apiengine.contractsv1.ContractEventsService/ContractBuyInRejected:
    post:
      description: >-
        <p style="font-family:monospace;color:#777;font-size:14px;padding:0 0
        4px 0"><b>PATH:</b>
        /aurora.core.apiengine.contractsv1.ContractEventsService/ContractBuyInRejected</p>

          
      operationId: ContractBuyInRejected
      requestBody:
        content:
          application/json:
            schema:
              $ref: >-
                #/components/schemas/aurora.core.apiengine.contractsv1.ContractBuyInRejectedEvent
        required: true
        x-originalParamName: body
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/google.protobuf.Empty'
          description: A successful response
      security:
        - Bearer: []
      summary: ContractBuyInRejected
      tags:
        - ContractEventsService
  /aurora.core.apiengine.contractsv1.ContractEventsService/ContractCreated:
    post:
      description: >-
        <p style="font-family:monospace;color:#777;font-size:14px;padding:0 0
        4px 0"><b>PATH:</b>
        /aurora.core.apiengine.contractsv1.ContractEventsService/ContractCreated</p>

          
      operationId: ContractCreated
      requestBody:
        content:
          application/json:
            schema:
              $ref: >-
                #/components/schemas/aurora.core.apiengine.contractsv1.ContractCreatedEvent
        description: Contract has been created (ContractStatus is 'New')
        required: true
        x-originalParamName: body
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/google.protobuf.Empty'
          description: A successful response
      security:
        - Bearer: []
      summary: ContractCreated
      tags:
        - ContractEventsService
  /aurora.core.apiengine.contractsv1.ContractEventsService/ContractDropped:
    post:
      description: >-
        <p style="font-family:monospace;color:#777;font-size:14px;padding:0 0
        4px 0"><b>PATH:</b>
        /aurora.core.apiengine.contractsv1.ContractEventsService/ContractDropped</p>

          
      operationId: ContractDropped
      requestBody:
        content:
          application/json:
            schema:
              $ref: >-
                #/components/schemas/aurora.core.apiengine.contractsv1.ContractDroppedEvent
        required: true
        x-originalParamName: body
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/google.protobuf.Empty'
          description: A successful response
      security:
        - Bearer: []
      summary: ContractDropped
      tags:
        - ContractEventsService
  /aurora.core.apiengine.contractsv1.ContractEventsService/ContractMade:
    post:
      description: >-
        <p style="font-family:monospace;color:#777;font-size:14px;padding:0 0
        4px 0"><b>PATH:</b>
        /aurora.core.apiengine.contractsv1.ContractEventsService/ContractMade</p>

          
      operationId: ContractMade
      requestBody:
        content:
          application/json:
            schema:
              $ref: >-
                #/components/schemas/aurora.core.apiengine.contractsv1.ContractMadeEvent
        description: Contract has been approved by the DTCC (ContractStatus is now 'Open')
        required: true
        x-originalParamName: body
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/google.protobuf.Empty'
          description: A successful response
      security:
        - Bearer: []
      summary: ContractMade
      tags:
        - ContractEventsService
  /aurora.core.apiengine.contractsv1.ContractEventsService/ContractPending:
    post:
      description: >-
        <p style="font-family:monospace;color:#777;font-size:14px;padding:0 0
        4px 0"><b>PATH:</b>
        /aurora.core.apiengine.contractsv1.ContractEventsService/ContractPending</p>

          
      operationId: ContractPending
      requestBody:
        content:
          application/json:
            schema:
              $ref: >-
                #/components/schemas/aurora.core.apiengine.contractsv1.ContractPendingEvent
        description: >-
          Contract created and waiting for a Delivery Order (ContractStatus is
          'Pending')
        required: true
        x-originalParamName: body
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/google.protobuf.Empty'
          description: A successful response
      security:
        - Bearer: []
      summary: ContractPending
      tags:
        - ContractEventsService
  /aurora.core.apiengine.contractsv1.ContractEventsService/ContractRateModificationAccepted:
    post:
      description: >-
        <p style="font-family:monospace;color:#777;font-size:14px;padding:0 0
        4px 0"><b>PATH:</b>
        /aurora.core.apiengine.contractsv1.ContractEventsService/ContractRateModificationAccepted</p>

          
      operationId: ContractRateModificationAccepted
      requestBody:
        content:
          application/json:
            schema:
              $ref: >-
                #/components/schemas/aurora.core.apiengine.contractsv1.ContractRateModificationAcceptedEvent
        required: true
        x-originalParamName: body
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/google.protobuf.Empty'
          description: A successful response
      security:
        - Bearer: []
      summary: ContractRateModificationAccepted
      tags:
        - ContractEventsService
  /aurora.core.apiengine.contractsv1.ContractEventsService/ContractRateModificationAutoCanceled:
    post:
      description: >-
        <p style="font-family:monospace;color:#777;font-size:14px;padding:0 0
        4px 0"><b>PATH:</b>
        /aurora.core.apiengine.contractsv1.ContractEventsService/ContractRateModificationAutoCanceled</p>

          
      operationId: ContractRateModificationAutoCanceled
      requestBody:
        content:
          application/json:
            schema:
              $ref: >-
                #/components/schemas/aurora.core.apiengine.contractsv1.ContractRateModificationAutoCanceledEvent
        required: true
        x-originalParamName: body
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/google.protobuf.Empty'
          description: A successful response
      security:
        - Bearer: []
      summary: ContractRateModificationAutoCanceled
      tags:
        - ContractEventsService
  /aurora.core.apiengine.contractsv1.ContractEventsService/ContractRateModificationCanceled:
    post:
      description: >-
        <p style="font-family:monospace;color:#777;font-size:14px;padding:0 0
        4px 0"><b>PATH:</b>
        /aurora.core.apiengine.contractsv1.ContractEventsService/ContractRateModificationCanceled</p>

          
      operationId: ContractRateModificationCanceled
      requestBody:
        content:
          application/json:
            schema:
              $ref: >-
                #/components/schemas/aurora.core.apiengine.contractsv1.ContractRateModificationCanceledEvent
        required: true
        x-originalParamName: body
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/google.protobuf.Empty'
          description: A successful response
      security:
        - Bearer: []
      summary: ContractRateModificationCanceled
      tags:
        - ContractEventsService
  /aurora.core.apiengine.contractsv1.ContractEventsService/ContractRateModificationExecuted:
    post:
      description: >-
        <p style="font-family:monospace;color:#777;font-size:14px;padding:0 0
        4px 0"><b>PATH:</b>
        /aurora.core.apiengine.contractsv1.ContractEventsService/ContractRateModificationExecuted</p>

          
      operationId: ContractRateModificationExecuted
      requestBody:
        content:
          application/json:
            schema:
              $ref: >-
                #/components/schemas/aurora.core.apiengine.contractsv1.ContractRateModificationExecutedEvent
        required: true
        x-originalParamName: body
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/google.protobuf.Empty'
          description: A successful response
      security:
        - Bearer: []
      summary: ContractRateModificationExecuted
      tags:
        - ContractEventsService
  /aurora.core.apiengine.contractsv1.ContractEventsService/ContractRateModificationExpired:
    post:
      description: >-
        <p style="font-family:monospace;color:#777;font-size:14px;padding:0 0
        4px 0"><b>PATH:</b>
        /aurora.core.apiengine.contractsv1.ContractEventsService/ContractRateModificationExpired</p>

          
      operationId: ContractRateModificationExpired
      requestBody:
        content:
          application/json:
            schema:
              $ref: >-
                #/components/schemas/aurora.core.apiengine.contractsv1.ContractRateModificationExpiredEvent
        required: true
        x-originalParamName: body
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/google.protobuf.Empty'
          description: A successful response
      security:
        - Bearer: []
      summary: ContractRateModificationExpired
      tags:
        - ContractEventsService
  /aurora.core.apiengine.contractsv1.ContractEventsService/ContractRateModificationOpened:
    post:
      description: >-
        <p style="font-family:monospace;color:#777;font-size:14px;padding:0 0
        4px 0"><b>PATH:</b>
        /aurora.core.apiengine.contractsv1.ContractEventsService/ContractRateModificationOpened</p>

          
      operationId: ContractRateModificationOpened
      requestBody:
        content:
          application/json:
            schema:
              $ref: >-
                #/components/schemas/aurora.core.apiengine.contractsv1.ContractRateModificationOpenedEvent
        required: true
        x-originalParamName: body
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/google.protobuf.Empty'
          description: A successful response
      security:
        - Bearer: []
      summary: ContractRateModificationOpened
      tags:
        - ContractEventsService
  /aurora.core.apiengine.contractsv1.ContractEventsService/ContractRateModificationRejected:
    post:
      description: >-
        <p style="font-family:monospace;color:#777;font-size:14px;padding:0 0
        4px 0"><b>PATH:</b>
        /aurora.core.apiengine.contractsv1.ContractEventsService/ContractRateModificationRejected</p>

          
      operationId: ContractRateModificationRejected
      requestBody:
        content:
          application/json:
            schema:
              $ref: >-
                #/components/schemas/aurora.core.apiengine.contractsv1.ContractRateModificationRejectedEvent
        required: true
        x-originalParamName: body
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/google.protobuf.Empty'
          description: A successful response
      security:
        - Bearer: []
      summary: ContractRateModificationRejected
      tags:
        - ContractEventsService
  /aurora.core.apiengine.contractsv1.ContractEventsService/ContractRecallCancelRejected:
    post:
      description: >-
        <p style="font-family:monospace;color:#777;font-size:14px;padding:0 0
        4px 0"><b>PATH:</b>
        /aurora.core.apiengine.contractsv1.ContractEventsService/ContractRecallCancelRejected</p>

          
      operationId: ContractRecallCancelRejected
      requestBody:
        content:
          application/json:
            schema:
              $ref: >-
                #/components/schemas/aurora.core.apiengine.contractsv1.ContractRecallCancelRejectedEvent
        required: true
        x-originalParamName: body
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/google.protobuf.Empty'
          description: A successful response
      security:
        - Bearer: []
      summary: ContractRecallCancelRejected
      tags:
        - ContractEventsService
  /aurora.core.apiengine.contractsv1.ContractEventsService/ContractRecallCanceled:
    post:
      description: >-
        <p style="font-family:monospace;color:#777;font-size:14px;padding:0 0
        4px 0"><b>PATH:</b>
        /aurora.core.apiengine.contractsv1.ContractEventsService/ContractRecallCanceled</p>

          
      operationId: ContractRecallCanceled
      requestBody:
        content:
          application/json:
            schema:
              $ref: >-
                #/components/schemas/aurora.core.apiengine.contractsv1.ContractRecallCanceledEvent
        required: true
        x-originalParamName: body
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/google.protobuf.Empty'
          description: A successful response
      security:
        - Bearer: []
      summary: ContractRecallCanceled
      tags:
        - ContractEventsService
  /aurora.core.apiengine.contractsv1.ContractEventsService/ContractRecallExecuted:
    post:
      description: >-
        <p style="font-family:monospace;color:#777;font-size:14px;padding:0 0
        4px 0"><b>PATH:</b>
        /aurora.core.apiengine.contractsv1.ContractEventsService/ContractRecallExecuted</p>

          Contract recall resolved — either by borrower returning shares or by lender executing a buy-in
      operationId: ContractRecallExecuted
      requestBody:
        content:
          application/json:
            schema:
              $ref: >-
                #/components/schemas/aurora.core.apiengine.contractsv1.ContractRecallExecutedEvent
        required: true
        x-originalParamName: body
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/google.protobuf.Empty'
          description: A successful response
      security:
        - Bearer: []
      summary: ContractRecallExecuted
      tags:
        - ContractEventsService
  /aurora.core.apiengine.contractsv1.ContractEventsService/ContractRecallOpened:
    post:
      description: >-
        <p style="font-family:monospace;color:#777;font-size:14px;padding:0 0
        4px 0"><b>PATH:</b>
        /aurora.core.apiengine.contractsv1.ContractEventsService/ContractRecallOpened</p>

          Contract recall opened (acknowledged by the DTCC)
      operationId: ContractRecallOpened
      requestBody:
        content:
          application/json:
            schema:
              $ref: >-
                #/components/schemas/aurora.core.apiengine.contractsv1.ContractRecallOpenedEvent
        required: true
        x-originalParamName: body
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/google.protobuf.Empty'
          description: A successful response
      security:
        - Bearer: []
      summary: ContractRecallOpened
      tags:
        - ContractEventsService
  /aurora.core.apiengine.contractsv1.ContractEventsService/ContractRecallRejected:
    post:
      description: >-
        <p style="font-family:monospace;color:#777;font-size:14px;padding:0 0
        4px 0"><b>PATH:</b>
        /aurora.core.apiengine.contractsv1.ContractEventsService/ContractRecallRejected</p>

          
      operationId: ContractRecallRejected
      requestBody:
        content:
          application/json:
            schema:
              $ref: >-
                #/components/schemas/aurora.core.apiengine.contractsv1.ContractRecallRejectedEvent
        required: true
        x-originalParamName: body
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/google.protobuf.Empty'
          description: A successful response
      security:
        - Bearer: []
      summary: ContractRecallRejected
      tags:
        - ContractEventsService
  /aurora.core.apiengine.contractsv1.ContractEventsService/ContractRecallUpdated:
    post:
      description: >-
        <p style="font-family:monospace;color:#777;font-size:14px;padding:0 0
        4px 0"><b>PATH:</b>
        /aurora.core.apiengine.contractsv1.ContractEventsService/ContractRecallUpdated</p>

          Corp Action announced for the shares under recall
      operationId: ContractRecallUpdated
      requestBody:
        content:
          application/json:
            schema:
              $ref: >-
                #/components/schemas/aurora.core.apiengine.contractsv1.ContractRecallUpdatedEvent
        required: true
        x-originalParamName: body
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/google.protobuf.Empty'
          description: A successful response
      security:
        - Bearer: []
      summary: ContractRecallUpdated
      tags:
        - ContractEventsService
  /aurora.core.apiengine.contractsv1.ContractEventsService/ContractRejected:
    post:
      description: >-
        <p style="font-family:monospace;color:#777;font-size:14px;padding:0 0
        4px 0"><b>PATH:</b>
        /aurora.core.apiengine.contractsv1.ContractEventsService/ContractRejected</p>

          
      operationId: ContractRejected
      requestBody:
        content:
          application/json:
            schema:
              $ref: >-
                #/components/schemas/aurora.core.apiengine.contractsv1.ContractRejectedEvent
        required: true
        x-originalParamName: body
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/google.protobuf.Empty'
          description: A successful response
      security:
        - Bearer: []
      summary: ContractRejected
      tags:
        - ContractEventsService
  /aurora.core.apiengine.contractsv1.ContractEventsService/ContractReturnAcceptedByLender:
    post:
      description: >-
        <p style="font-family:monospace;color:#777;font-size:14px;padding:0 0
        4px 0"><b>PATH:</b>
        /aurora.core.apiengine.contractsv1.ContractEventsService/ContractReturnAcceptedByLender</p>

          
      operationId: ContractReturnAcceptedByLender
      requestBody:
        content:
          application/json:
            schema:
              $ref: >-
                #/components/schemas/aurora.core.apiengine.contractsv1.ContractReturnAcceptedByLenderEvent
        required: true
        x-originalParamName: body
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/google.protobuf.Empty'
          description: A successful response
      security:
        - Bearer: []
      summary: ContractReturnAcceptedByLender
      tags:
        - ContractEventsService
  /aurora.core.apiengine.contractsv1.ContractEventsService/ContractReturnCancelAccepted:
    post:
      description: >-
        <p style="font-family:monospace;color:#777;font-size:14px;padding:0 0
        4px 0"><b>PATH:</b>
        /aurora.core.apiengine.contractsv1.ContractEventsService/ContractReturnCancelAccepted</p>

          
      operationId: ContractReturnCancelAccepted
      requestBody:
        content:
          application/json:
            schema:
              $ref: >-
                #/components/schemas/aurora.core.apiengine.contractsv1.ContractReturnCancelAcceptedEvent
        required: true
        x-originalParamName: body
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/google.protobuf.Empty'
          description: A successful response
      security:
        - Bearer: []
      summary: ContractReturnCancelAccepted
      tags:
        - ContractEventsService
  /aurora.core.apiengine.contractsv1.ContractEventsService/ContractReturnCancelRejected:
    post:
      description: >-
        <p style="font-family:monospace;color:#777;font-size:14px;padding:0 0
        4px 0"><b>PATH:</b>
        /aurora.core.apiengine.contractsv1.ContractEventsService/ContractReturnCancelRejected</p>

          
      operationId: ContractReturnCancelRejected
      requestBody:
        content:
          application/json:
            schema:
              $ref: >-
                #/components/schemas/aurora.core.apiengine.contractsv1.ContractReturnCancelRejectedEvent
        required: true
        x-originalParamName: body
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/google.protobuf.Empty'
          description: A successful response
      security:
        - Bearer: []
      summary: ContractReturnCancelRejected
      tags:
        - ContractEventsService
  /aurora.core.apiengine.contractsv1.ContractEventsService/ContractReturnCanceledByBorrower:
    post:
      description: >-
        <p style="font-family:monospace;color:#777;font-size:14px;padding:0 0
        4px 0"><b>PATH:</b>
        /aurora.core.apiengine.contractsv1.ContractEventsService/ContractReturnCanceledByBorrower</p>

          
      operationId: ContractReturnCanceledByBorrower
      requestBody:
        content:
          application/json:
            schema:
              $ref: >-
                #/components/schemas/aurora.core.apiengine.contractsv1.ContractReturnCanceledByBorrowerEvent
        required: true
        x-originalParamName: body
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/google.protobuf.Empty'
          description: A successful response
      security:
        - Bearer: []
      summary: ContractReturnCanceledByBorrower
      tags:
        - ContractEventsService
  /aurora.core.apiengine.contractsv1.ContractEventsService/ContractReturnDropped:
    post:
      description: >-
        <p style="font-family:monospace;color:#777;font-size:14px;padding:0 0
        4px 0"><b>PATH:</b>
        /aurora.core.apiengine.contractsv1.ContractEventsService/ContractReturnDropped</p>

          
      operationId: ContractReturnDropped
      requestBody:
        content:
          application/json:
            schema:
              $ref: >-
                #/components/schemas/aurora.core.apiengine.contractsv1.ContractReturnDroppedEvent
        required: true
        x-originalParamName: body
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/google.protobuf.Empty'
          description: A successful response
      security:
        - Bearer: []
      summary: ContractReturnDropped
      tags:
        - ContractEventsService
  /aurora.core.apiengine.contractsv1.ContractEventsService/ContractReturnExecuted:
    post:
      description: >-
        <p style="font-family:monospace;color:#777;font-size:14px;padding:0 0
        4px 0"><b>PATH:</b>
        /aurora.core.apiengine.contractsv1.ContractEventsService/ContractReturnExecuted</p>

          
      operationId: ContractReturnExecuted
      requestBody:
        content:
          application/json:
            schema:
              $ref: >-
                #/components/schemas/aurora.core.apiengine.contractsv1.ContractReturnExecutedEvent
        required: true
        x-originalParamName: body
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/google.protobuf.Empty'
          description: A successful response
      security:
        - Bearer: []
      summary: ContractReturnExecuted
      tags:
        - ContractEventsService
  /aurora.core.apiengine.contractsv1.ContractEventsService/ContractReturnFailed:
    post:
      description: >-
        <p style="font-family:monospace;color:#777;font-size:14px;padding:0 0
        4px 0"><b>PATH:</b>
        /aurora.core.apiengine.contractsv1.ContractEventsService/ContractReturnFailed</p>

          
      operationId: ContractReturnFailed
      requestBody:
        content:
          application/json:
            schema:
              $ref: >-
                #/components/schemas/aurora.core.apiengine.contractsv1.ContractReturnFailedEvent
        required: true
        x-originalParamName: body
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/google.protobuf.Empty'
          description: A successful response
      security:
        - Bearer: []
      summary: ContractReturnFailed
      tags:
        - ContractEventsService
  /aurora.core.apiengine.contractsv1.ContractEventsService/ContractReturnPending:
    post:
      description: >-
        <p style="font-family:monospace;color:#777;font-size:14px;padding:0 0
        4px 0"><b>PATH:</b>
        /aurora.core.apiengine.contractsv1.ContractEventsService/ContractReturnPending</p>

          
      operationId: ContractReturnPending
      requestBody:
        content:
          application/json:
            schema:
              $ref: >-
                #/components/schemas/aurora.core.apiengine.contractsv1.ContractReturnPendingEvent
        required: true
        x-originalParamName: body
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/google.protobuf.Empty'
          description: A successful response
      security:
        - Bearer: []
      summary: ContractReturnPending
      tags:
        - ContractEventsService
  /aurora.core.apiengine.contractsv1.ContractEventsService/ContractReturnPendingLenderApproval:
    post:
      description: >-
        <p style="font-family:monospace;color:#777;font-size:14px;padding:0 0
        4px 0"><b>PATH:</b>
        /aurora.core.apiengine.contractsv1.ContractEventsService/ContractReturnPendingLenderApproval</p>

          
      operationId: ContractReturnPendingLenderApproval
      requestBody:
        content:
          application/json:
            schema:
              $ref: >-
                #/components/schemas/aurora.core.apiengine.contractsv1.ContractReturnPendingLenderApprovalEvent
        required: true
        x-originalParamName: body
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/google.protobuf.Empty'
          description: A successful response
      security:
        - Bearer: []
      summary: ContractReturnPendingLenderApproval
      tags:
        - ContractEventsService
  /aurora.core.apiengine.contractsv1.ContractEventsService/ContractReturnRejected:
    post:
      description: >-
        <p style="font-family:monospace;color:#777;font-size:14px;padding:0 0
        4px 0"><b>PATH:</b>
        /aurora.core.apiengine.contractsv1.ContractEventsService/ContractReturnRejected</p>

          
      operationId: ContractReturnRejected
      requestBody:
        content:
          application/json:
            schema:
              $ref: >-
                #/components/schemas/aurora.core.apiengine.contractsv1.ContractReturnRejectedEvent
        required: true
        x-originalParamName: body
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/google.protobuf.Empty'
          description: A successful response
      security:
        - Bearer: []
      summary: ContractReturnRejected
      tags:
        - ContractEventsService
  /aurora.core.apiengine.contractsv1.ContractEventsService/ContractReturnRejectedByLender:
    post:
      description: >-
        <p style="font-family:monospace;color:#777;font-size:14px;padding:0 0
        4px 0"><b>PATH:</b>
        /aurora.core.apiengine.contractsv1.ContractEventsService/ContractReturnRejectedByLender</p>

          
      operationId: ContractReturnRejectedByLender
      requestBody:
        content:
          application/json:
            schema:
              $ref: >-
                #/components/schemas/aurora.core.apiengine.contractsv1.ContractReturnRejectedByLenderEvent
        required: true
        x-originalParamName: body
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/google.protobuf.Empty'
          description: A successful response
      security:
        - Bearer: []
      summary: ContractReturnRejectedByLender
      tags:
        - ContractEventsService
  /aurora.core.apiengine.contractsv1.ContractEventsService/ContractRolled:
    post:
      description: >-
        <p style="font-family:monospace;color:#777;font-size:14px;padding:0 0
        4px 0"><b>PATH:</b>
        /aurora.core.apiengine.contractsv1.ContractEventsService/ContractRolled</p>

          
      operationId: ContractRolled
      requestBody:
        content:
          application/json:
            schema:
              $ref: >-
                #/components/schemas/aurora.core.apiengine.contractsv1.ContractRolledEvent
        required: true
        x-originalParamName: body
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/google.protobuf.Empty'
          description: A successful response
      security:
        - Bearer: []
      summary: ContractRolled
      tags:
        - ContractEventsService
  /aurora.core.apiengine.agreementsv1.AgreementService/ApproveAgreement:
    post:
      description: >-
        <p style="font-family:monospace;color:#777;font-size:14px;padding:0 0
        4px 0"><b>PATH:</b>
        /aurora.core.apiengine.agreementsv1.AgreementService/ApproveAgreement</p>

          ApproveAgreement can be used to approve a drafted agreement
      operationId: ApproveAgreement
      requestBody:
        content:
          application/json:
            schema:
              $ref: >-
                #/components/schemas/aurora.core.apiengine.agreementsv1.ApproveAgreementRequest
        description: Approve-Agreement Request
        required: true
        x-originalParamName: body
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/aurora.core.apiengine.agreementsv1.ApproveAgreementResponse
          description: A successful response<br>Approve-Agreement Response
      security:
        - Bearer: []
      summary: ApproveAgreement
      tags:
        - AgreementService
  /aurora.core.apiengine.agreementsv1.AgreementService/CancelAgreement:
    post:
      description: >-
        <p style="font-family:monospace;color:#777;font-size:14px;padding:0 0
        4px 0"><b>PATH:</b>
        /aurora.core.apiengine.agreementsv1.AgreementService/CancelAgreement</p>

          CancelAgreement can be used to cancel a drafted or active agreement
      operationId: CancelAgreement
      requestBody:
        content:
          application/json:
            schema:
              $ref: >-
                #/components/schemas/aurora.core.apiengine.agreementsv1.CancelAgreementRequest
        description: Cancel-Agreement Request
        required: true
        x-originalParamName: body
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/aurora.core.apiengine.agreementsv1.CancelAgreementResponse
          description: A successful response<br>Cancel-Agreement Response
      security:
        - Bearer: []
      summary: CancelAgreement
      tags:
        - AgreementService
  /aurora.core.apiengine.agreementsv1.AgreementService/CreateAgreement:
    post:
      description: >-
        <p style="font-family:monospace;color:#777;font-size:14px;padding:0 0
        4px 0"><b>PATH:</b>
        /aurora.core.apiengine.agreementsv1.AgreementService/CreateAgreement</p>

          CreateAgreement can be used tc create an agreement
      operationId: CreateAgreement
      requestBody:
        content:
          application/json:
            schema:
              $ref: >-
                #/components/schemas/aurora.core.apiengine.agreementsv1.CreateAgreementRequest
        description: Create-Agreement Request
        required: true
        x-originalParamName: body
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/aurora.core.apiengine.agreementsv1.CreateAgreementResponse
          description: A successful response<br>Create-Agreement Response
      security:
        - Bearer: []
      summary: CreateAgreement
      tags:
        - AgreementService
  /aurora.core.apiengine.agreementsv1.AgreementService/GetAgreement:
    post:
      description: >-
        <p style="font-family:monospace;color:#777;font-size:14px;padding:0 0
        4px 0"><b>PATH:</b>
        /aurora.core.apiengine.agreementsv1.AgreementService/GetAgreement</p>

          GetAgreement can be used to get an agreement
      operationId: GetAgreement
      requestBody:
        content:
          application/json:
            schema:
              $ref: >-
                #/components/schemas/aurora.core.apiengine.agreementsv1.GetAgreementRequest
        required: true
        x-originalParamName: body
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/aurora.core.apiengine.agreementsv1.GetAgreementResponse
          description: A successful response
      security:
        - Bearer: []
      summary: GetAgreement
      tags:
        - AgreementService
  /aurora.core.apiengine.agreementsv1.AgreementService/ListAgreements:
    post:
      description: >-
        <p style="font-family:monospace;color:#777;font-size:14px;padding:0 0
        4px 0"><b>PATH:</b>
        /aurora.core.apiengine.agreementsv1.AgreementService/ListAgreements</p>

          ListAgreements can be used to query agreements
      operationId: ListAgreements
      requestBody:
        content:
          application/json:
            schema:
              $ref: >-
                #/components/schemas/aurora.core.apiengine.agreementsv1.ListAgreementsRequest
        description: List-Agreements Request
        required: true
        x-originalParamName: body
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/aurora.core.apiengine.agreementsv1.ListAgreementsResponse
          description: A successful response<br>List-Agreements Response
      security:
        - Bearer: []
      summary: ListAgreements
      tags:
        - AgreementService
  /aurora.core.apiengine.agreementsv1.AgreementService/ModifyAgreement:
    post:
      description: >-
        <p style="font-family:monospace;color:#777;font-size:14px;padding:0 0
        4px 0"><b>PATH:</b>
        /aurora.core.apiengine.agreementsv1.AgreementService/ModifyAgreement</p>

          ModifyAgreement can be used to create a new version of an agreement
      operationId: ModifyAgreement
      requestBody:
        content:
          application/json:
            schema:
              $ref: >-
                #/components/schemas/aurora.core.apiengine.agreementsv1.ModifyAgreementRequest
        description: Modify-Agreement Request
        required: true
        x-originalParamName: body
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/aurora.core.apiengine.agreementsv1.ModifyAgreementResponse
          description: A successful response<br>Modify-Agreement Response
      security:
        - Bearer: []
      summary: ModifyAgreement
      tags:
        - AgreementService
  /aurora.core.apiengine.agreementsv1.AgreementService/RejectAgreement:
    post:
      description: >-
        <p style="font-family:monospace;color:#777;font-size:14px;padding:0 0
        4px 0"><b>PATH:</b>
        /aurora.core.apiengine.agreementsv1.AgreementService/RejectAgreement</p>

          RejectAgreement can be used to reject a drafted agreement
      operationId: RejectAgreement
      requestBody:
        content:
          application/json:
            schema:
              $ref: >-
                #/components/schemas/aurora.core.apiengine.agreementsv1.RejectAgreementRequest
        description: Reject-Agreement Request
        required: true
        x-originalParamName: body
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/aurora.core.apiengine.agreementsv1.RejectAgreementResponse
          description: A successful response<br>Reject-Agreement Response
      security:
        - Bearer: []
      summary: RejectAgreement
      tags:
        - AgreementService
  /aurora.core.apiengine.contractrequestsv1.ContractRequestEventsService/ContractRequestAccepted:
    post:
      description: >-
        <p style="font-family:monospace;color:#777;font-size:14px;padding:0 0
        4px 0"><b>PATH:</b>
        /aurora.core.apiengine.contractrequestsv1.ContractRequestEventsService/ContractRequestAccepted</p>

          
      operationId: ContractRequestAccepted
      requestBody:
        content:
          application/json:
            schema:
              $ref: >-
                #/components/schemas/aurora.core.apiengine.contractrequestsv1.ContractRequestAcceptedEvent
        required: true
        x-originalParamName: body
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/google.protobuf.Empty'
          description: A successful response
      security:
        - Bearer: []
      summary: ContractRequestAccepted
      tags:
        - ContractRequestEventsService
  /aurora.core.apiengine.contractrequestsv1.ContractRequestEventsService/ContractRequestCanceled:
    post:
      description: >-
        <p style="font-family:monospace;color:#777;font-size:14px;padding:0 0
        4px 0"><b>PATH:</b>
        /aurora.core.apiengine.contractrequestsv1.ContractRequestEventsService/ContractRequestCanceled</p>

          
      operationId: ContractRequestCanceled
      requestBody:
        content:
          application/json:
            schema:
              $ref: >-
                #/components/schemas/aurora.core.apiengine.contractrequestsv1.ContractRequestCanceledEvent
        required: true
        x-originalParamName: body
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/google.protobuf.Empty'
          description: A successful response
      security:
        - Bearer: []
      summary: ContractRequestCanceled
      tags:
        - ContractRequestEventsService
  /aurora.core.apiengine.contractrequestsv1.ContractRequestEventsService/ContractRequestDeclined:
    post:
      description: >-
        <p style="font-family:monospace;color:#777;font-size:14px;padding:0 0
        4px 0"><b>PATH:</b>
        /aurora.core.apiengine.contractrequestsv1.ContractRequestEventsService/ContractRequestDeclined</p>

          
      operationId: ContractRequestDeclined
      requestBody:
        content:
          application/json:
            schema:
              $ref: >-
                #/components/schemas/aurora.core.apiengine.contractrequestsv1.ContractRequestDeclinedEvent
        required: true
        x-originalParamName: body
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/google.protobuf.Empty'
          description: A successful response
      security:
        - Bearer: []
      summary: ContractRequestDeclined
      tags:
        - ContractRequestEventsService
  /aurora.core.apiengine.contractrequestsv1.ContractRequestEventsService/ContractRequestOpened:
    post:
      description: >-
        <p style="font-family:monospace;color:#777;font-size:14px;padding:0 0
        4px 0"><b>PATH:</b>
        /aurora.core.apiengine.contractrequestsv1.ContractRequestEventsService/ContractRequestOpened</p>

          
      operationId: ContractRequestOpened
      requestBody:
        content:
          application/json:
            schema:
              $ref: >-
                #/components/schemas/aurora.core.apiengine.contractrequestsv1.ContractRequestOpenedEvent
        required: true
        x-originalParamName: body
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/google.protobuf.Empty'
          description: A successful response
      security:
        - Bearer: []
      summary: ContractRequestOpened
      tags:
        - ContractRequestEventsService
  /aurora.core.apiengine.contractrequestsv1.ContractRequestService/AcceptContractRequest:
    post:
      description: >-
        <p style="font-family:monospace;color:#777;font-size:14px;padding:0 0
        4px 0"><b>PATH:</b>
        /aurora.core.apiengine.contractrequestsv1.ContractRequestService/AcceptContractRequest</p>

          
      operationId: AcceptContractRequest
      requestBody:
        content:
          application/json:
            schema:
              $ref: >-
                #/components/schemas/aurora.core.apiengine.contractrequestsv1.AcceptContractRequestRequest
        required: true
        x-originalParamName: body
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/aurora.core.apiengine.contractrequestsv1.ContractRequestResponse
          description: A successful response
      security:
        - Bearer: []
      summary: AcceptContractRequest
      tags:
        - ContractRequestService
  /aurora.core.apiengine.contractrequestsv1.ContractRequestService/CancelContractRequest:
    post:
      description: >-
        <p style="font-family:monospace;color:#777;font-size:14px;padding:0 0
        4px 0"><b>PATH:</b>
        /aurora.core.apiengine.contractrequestsv1.ContractRequestService/CancelContractRequest</p>

          
      operationId: CancelContractRequest
      requestBody:
        content:
          application/json:
            schema:
              $ref: >-
                #/components/schemas/aurora.core.apiengine.contractrequestsv1.CancelContractRequestRequest
        required: true
        x-originalParamName: body
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/aurora.core.apiengine.contractrequestsv1.ContractRequestResponse
          description: A successful response
      security:
        - Bearer: []
      summary: CancelContractRequest
      tags:
        - ContractRequestService
  /aurora.core.apiengine.contractrequestsv1.ContractRequestService/DeclineContractRequest:
    post:
      description: >-
        <p style="font-family:monospace;color:#777;font-size:14px;padding:0 0
        4px 0"><b>PATH:</b>
        /aurora.core.apiengine.contractrequestsv1.ContractRequestService/DeclineContractRequest</p>

          
      operationId: DeclineContractRequest
      requestBody:
        content:
          application/json:
            schema:
              $ref: >-
                #/components/schemas/aurora.core.apiengine.contractrequestsv1.DeclineContractRequestRequest
        required: true
        x-originalParamName: body
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/aurora.core.apiengine.contractrequestsv1.ContractRequestResponse
          description: A successful response
      security:
        - Bearer: []
      summary: DeclineContractRequest
      tags:
        - ContractRequestService
  /aurora.core.apiengine.contractrequestsv1.ContractRequestService/QueryContractRequests:
    post:
      description: >-
        <p style="font-family:monospace;color:#777;font-size:14px;padding:0 0
        4px 0"><b>PATH:</b>
        /aurora.core.apiengine.contractrequestsv1.ContractRequestService/QueryContractRequests</p>

          
      operationId: QueryContractRequests
      requestBody:
        content:
          application/json:
            schema:
              $ref: >-
                #/components/schemas/aurora.core.apiengine.contractrequestsv1.QueryContractRequestsRequest
        required: true
        x-originalParamName: body
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/aurora.core.apiengine.contractrequestsv1.QueryContractRequestsResponse
          description: A successful response
      security:
        - Bearer: []
      summary: QueryContractRequests
      tags:
        - ContractRequestService
  /aurora.core.apiengine.contractrequestsv1.ContractRequestService/SubmitContractRequest:
    post:
      description: >-
        <p style="font-family:monospace;color:#777;font-size:14px;padding:0 0
        4px 0"><b>PATH:</b>
        /aurora.core.apiengine.contractrequestsv1.ContractRequestService/SubmitContractRequest</p>

          
      operationId: SubmitContractRequest
      requestBody:
        content:
          application/json:
            schema:
              $ref: >-
                #/components/schemas/aurora.core.apiengine.contractrequestsv1.SubmitContractRequestRequest
        required: true
        x-originalParamName: body
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/aurora.core.apiengine.contractrequestsv1.ContractRequestResponse
          description: A successful response
      security:
        - Bearer: []
      summary: SubmitContractRequest
      tags:
        - ContractRequestService
  /aurora.core.apiengine.instrumentsv1.InstrumentService/ListInstruments:
    post:
      description: >-
        <p style="font-family:monospace;color:#777;font-size:14px;padding:0 0
        4px 0"><b>PATH:</b>
        /aurora.core.apiengine.instrumentsv1.InstrumentService/ListInstruments</p>

          
      operationId: ListInstruments
      requestBody:
        content:
          application/json:
            schema:
              $ref: >-
                #/components/schemas/aurora.core.apiengine.instrumentsv1.ListInstrumentsRequest
        required: true
        x-originalParamName: body
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/aurora.core.apiengine.instrumentsv1.ListInstrumentsResponse
          description: A successful response
      security:
        - Bearer: []
      summary: ListInstruments
      tags:
        - InstrumentService
  /aurora.core.apiengine.executionsv1.ExecutionEventsService/Execution:
    post:
      description: >-
        <p style="font-family:monospace;color:#777;font-size:14px;padding:0 0
        4px 0"><b>PATH:</b>
        /aurora.core.apiengine.executionsv1.ExecutionEventsService/Execution</p>

          
      operationId: Execution
      requestBody:
        content:
          application/json:
            schema:
              $ref: >-
                #/components/schemas/aurora.core.apiengine.executionsv1.ExecutionEvent
        required: true
        x-originalParamName: body
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/google.protobuf.Empty'
          description: A successful response
      security:
        - Bearer: []
      summary: Execution
      tags:
        - ExecutionEventsService
  /aurora.core.apiengine.executionsv1.ExecutionService/AckExecutions:
    post:
      description: >-
        <p style="font-family:monospace;color:#777;font-size:14px;padding:0 0
        4px 0"><b>PATH:</b>
        /aurora.core.apiengine.executionsv1.ExecutionService/AckExecutions</p>

          
      operationId: AckExecutions
      requestBody:
        content:
          application/json:
            schema:
              $ref: >-
                #/components/schemas/aurora.core.apiengine.executionsv1.AckExecutionsRequest
        required: true
        x-originalParamName: body
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/aurora.core.apiengine.executionsv1.AckExecutionsResponse
          description: A successful response
      security:
        - Bearer: []
      summary: AckExecutions
      tags:
        - ExecutionService
  /aurora.core.apiengine.executionsv1.ExecutionService/ListExecutions:
    post:
      description: >-
        <p style="font-family:monospace;color:#777;font-size:14px;padding:0 0
        4px 0"><b>PATH:</b>
        /aurora.core.apiengine.executionsv1.ExecutionService/ListExecutions</p>

          
      operationId: ListExecutions
      requestBody:
        content:
          application/json:
            schema:
              $ref: >-
                #/components/schemas/aurora.core.apiengine.executionsv1.ListExecutionsRequest
        required: true
        x-originalParamName: body
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/aurora.core.apiengine.executionsv1.ListExecutionsResponse
          description: A successful response
      security:
        - Bearer: []
      summary: ListExecutions
      tags:
        - ExecutionService
  /aurora.core.apiengine.venuev1.VenueEventsService/OrderAdded:
    post:
      description: >-
        <p style="font-family:monospace;color:#777;font-size:14px;padding:0 0
        4px 0"><b>PATH:</b>
        /aurora.core.apiengine.venuev1.VenueEventsService/OrderAdded</p>

          
      operationId: OrderAdded
      requestBody:
        content:
          application/json:
            schema:
              $ref: >-
                #/components/schemas/aurora.core.apiengine.venuev1.OrderAddedEvent
        required: true
        x-originalParamName: body
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/google.protobuf.Empty'
          description: A successful response
      security:
        - Bearer: []
      summary: OrderAdded
      tags:
        - VenueEventsService
  /aurora.core.apiengine.venuev1.VenueEventsService/OrderRemoved:
    post:
      description: >-
        <p style="font-family:monospace;color:#777;font-size:14px;padding:0 0
        4px 0"><b>PATH:</b>
        /aurora.core.apiengine.venuev1.VenueEventsService/OrderRemoved</p>

          
      operationId: OrderRemoved
      requestBody:
        content:
          application/json:
            schema:
              $ref: >-
                #/components/schemas/aurora.core.apiengine.venuev1.OrderRemovedEvent
        required: true
        x-originalParamName: body
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/google.protobuf.Empty'
          description: A successful response
      security:
        - Bearer: []
      summary: OrderRemoved
      tags:
        - VenueEventsService
  /aurora.core.apiengine.venuev1.VenueService/QueryOrderBook:
    post:
      description: >-
        <p style="font-family:monospace;color:#777;font-size:14px;padding:0 0
        4px 0"><b>PATH:</b>
        /aurora.core.apiengine.venuev1.VenueService/QueryOrderBook</p>

          
      operationId: QueryOrderBook
      requestBody:
        content:
          application/json:
            schema:
              $ref: >-
                #/components/schemas/aurora.core.apiengine.venuev1.QueryOrderBookRequest
        required: true
        x-originalParamName: body
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/aurora.core.apiengine.venuev1.QueryOrderBookResponse
          description: A successful response
      security:
        - Bearer: []
      summary: QueryOrderBook
      tags:
        - VenueService
  /aurora.core.apiengine.loginv1.LoginService/LoginWithApiCredentials:
    post:
      description: >-
        <p style="font-family:monospace;color:#777;font-size:14px;padding:0 0
        4px 0"><b>PATH:</b>
        /aurora.core.apiengine.loginv1.LoginService/LoginWithApiCredentials</p>

          Request an access token.
        To identify, please request a `client_id` and `secret` from your
        representative at Provable Markets.


        Please note the services expect a JWT ***Bearer*** Token.

        For instance, when you pass the `access_token` to a `cURL` request you
        will have to pass it in the header like this:


        ```shell

        curl -H "Authorization: Bearer YOUR_ACCESS_TOKEN"

        ```

        Unfortunately the keyword `Bearer` is currently missing from the
        examples.
      operationId: LoginWithApiCredentials
      requestBody:
        content:
          application/json:
            schema:
              $ref: >-
                #/components/schemas/aurora.core.apiengine.loginv1.LoginWithApiCredentialsRequest
        required: true
        x-originalParamName: body
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/aurora.core.apiengine.loginv1.LoginWithApiCredentialsResponse
          description: A successful response
      summary: LoginWithApiCredentials
      tags:
        - LoginService
  /aurora.core.apiengine.companiesv1.CompanyService/ListCompanies:
    post:
      description: >-
        <p style="font-family:monospace;color:#777;font-size:14px;padding:0 0
        4px 0"><b>PATH:</b>
        /aurora.core.apiengine.companiesv1.CompanyService/ListCompanies</p>

          List available companies
      operationId: ListCompanies
      requestBody:
        content:
          application/json:
            schema:
              $ref: >-
                #/components/schemas/aurora.core.apiengine.companiesv1.ListCompaniesRequest
        required: true
        x-originalParamName: body
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/aurora.core.apiengine.companiesv1.ListCompaniesResponse
          description: A successful response
      security:
        - Bearer: []
      summary: ListCompanies
      tags:
        - CompanyService
tags:
  - description: Methods to query companies
    name: CompanyService
