|
| 1 | +// Copyright (c) 2021 Systemathics |
| 2 | +// |
| 3 | +// Permission is hereby granted, free of charge, to any person obtaining a copy |
| 4 | +// of this software and associated documentation files (the "Software"), to deal |
| 5 | +// in the Software without restriction, including without limitation the rights |
| 6 | +// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell |
| 7 | +// copies of the Software, and to permit persons to whom the Software is |
| 8 | +// furnished to do so, subject to the following conditions: |
| 9 | +// |
| 10 | +// The above copyright notice and this permission notice shall be included in all |
| 11 | +// copies or substantial portions of the Software. |
| 12 | +// |
| 13 | +// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR |
| 14 | +// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, |
| 15 | +// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE |
| 16 | +// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER |
| 17 | +// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, |
| 18 | +// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE |
| 19 | +// SOFTWARE. |
| 20 | + |
| 21 | +// Normalized tick by tick data extraction for a given watchlist and a specific look-back period. This can be useful to: |
| 22 | +// <br>- Get specific historical dataset such as trades, top of book data... |
| 23 | +// <br>- Compute analytics on the top of preselected tick by tick data dataset |
| 24 | +// <br>- Feed best execution reports for a given watchlist over the time |
| 25 | +syntax = "proto3"; |
| 26 | + |
| 27 | +import "google/protobuf/timestamp.proto"; |
| 28 | +import "google/protobuf/wrappers.proto"; |
| 29 | + |
| 30 | +import "systemathics/apis/type/shared/v1/constraints.proto"; |
| 31 | +import "systemathics/apis/type/shared/v1/identifier.proto"; |
| 32 | +import "systemathics/apis/type/shared/v1/keys.proto"; |
| 33 | +import "systemathics/apis/type/shared/v2/quotes_data.proto"; |
| 34 | + |
| 35 | +package systemathics.apis.services.tick.v2; |
| 36 | + |
| 37 | +// Called to request tick by tick normalized quotes data (MBO only). |
| 38 | +service TickQuotesService |
| 39 | +{ |
| 40 | + // Get tick by tick normalized trades and book historical |
| 41 | + rpc TickQuotes(TickQuotesRequest) returns (stream TickQuotesResponse); |
| 42 | +} |
| 43 | + |
| 44 | +// The required inputs to request the TickQuotesService. |
| 45 | +message TickQuotesRequest |
| 46 | +{ |
| 47 | + // [Mandatory] The instrument identifiers: a list of tickers and changes |
| 48 | + repeated systemathics.apis.type.shared.v1.Identifier identifiers = 1; |
| 49 | + |
| 50 | + // [Optional] The time constraints used to define the look-back period. |
| 51 | + // If empty, then all the available data is retrieved. |
| 52 | + systemathics.apis.type.shared.v1.Constraints constraints = 2; |
| 53 | + |
| 54 | + // [Optional] The corporate action adjustment, by default the value is set to false |
| 55 | + bool adjustment = 3; |
| 56 | +} |
| 57 | + |
| 58 | +// Contains the tick by tick normalized quotes: key and data |
| 59 | +message TickQuotesResponse |
| 60 | +{ |
| 61 | + oneof payload |
| 62 | + { |
| 63 | + // The trade and book data |
| 64 | + systemathics.apis.type.shared.v2.QuotesData data = 1; |
| 65 | + |
| 66 | + // The mapping data |
| 67 | + systemathics.apis.type.shared.v1.Keys mapping = 2; |
| 68 | + } |
| 69 | +} |
0 commit comments