Skip to content

Api trades

Api for get trades information from server.

Source code in onequant/api/trades.py 
  5
  6
  7
  8
  9
 10
 11
 12
 13
 14
 15
 16
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
class OqTrades:
    """Api for get trades information from server."""

    def __init__(self, wrapper=None):
        """Initializes the OqTrades class.

        Args:
            wrapper: An object that wraps the OneQuant API.

        Returns:
            None.
        """
        self.api = wrapper.api
        self.username = wrapper.username

    def _query(self, router=None, params=None):
        """Sends a GET request to the OneQuant API.

        Args:
            router: The router for the request.
            params: The parameters for the request.

        Returns:
            A tuple containing the data and code from the request.
        """
        result = self.api.request(method='get', router=router, params=params)
        if result['code'] != 200:
            raise Exception(f'An error occurred while retrieving tdegine data! code is {result["code"]}')
        return result['data']

    @_pd
    def _query_pd(self, router=None, params=None):
        """Sends a GET request to the OneQuant API and returns the data as a pandas DataFrame.

        Args:
            router: The router for the request.
            params: The parameters for the request.

        Returns:
            A pandas DataFrame containing the data from the request.
        """
        result = self.api.request(method='get', router=router, params=params)
        return result['data'], result['code']

    def account(self):
        """Sends a GET request to the OneQuant API to retrieve account information.

        Args:
            None.

        Returns:
            A tuple containing the data and code from the request.
        """
        params = {'acc_type': 0}
        return self._query('/trade/account/query', params)

    def account_virtual(self):
        """Sends a GET request to the OneQuant API to retrieve virtual account information.

        Args:
            None.

        Returns:
            A tuple containing the data and code from the request.
        """
        params = {'acc_type': 1}
        return self._query('/trade/account/query', params)

    def position(self):
        """Sends a GET request to the OneQuant API to retrieve position information.

        Args:
            None.

        Returns:
            A pandas DataFrame containing the position data from the request.
        """
        params = {'acc_type': 0}
        return self._query_pd('/trade/position/query', params)

    def position_virtual(self):
        """Sends a GET request to the OneQuant API to retrieve virtual position information.

        Args:
            None.

        Returns:
            A pandas DataFrame containing the virtual position data from the request.
        """
        params = {'acc_type': 1}
        return self._query_pd('/trade/position/query', params)

    def orders(self):
        """Sends a GET request to the OneQuant API to retrieve order information.

        Args:
            None.

        Returns:
            A pandas DataFrame containing the order data from the request.
        """
        params = {'is_virtual': 0}
        return self._query_pd('/trade/order/query', params)

    def orders_virtual(self):
        """Sends a GET request to the OneQuant API to retrieve virtual order information.

        Args:
            None.

        Returns:
            A pandas DataFrame containing the virtual order data from the request.
        """
        params = {'is_virtual': 1}
        return self._query_pd('/trade/order/query', params)

    def unfill_orders(self):
        """Sends a GET request to the OneQuant API to retrieve unfulfilled order information.

        Args:
            None.

        Returns:
            A pandas DataFrame containing the unfulfilled order data from the request.
        """
        params = {'is_virtual': 0}
        return self._query_pd('/trade/order/restore/query', params)

    def unfill_orders_virtual(self):
        """Sends a GET request to the OneQuant API to retrieve virtual unfulfilled order information.

        Args:
            None.

        Returns:
            A pandas DataFrame containing the virtual unfulfilled order data from the request.
        """
        params = {'is_virtual': 1}
        return self._query_pd('/trade/order/restore/query', params)

    def rsptrades(self):
        """Sends a GET request to the OneQuant API to retrieve real-time settlement trade information.

        Args:
            None.

        Returns:
            A pandas DataFrame containing the real-time settlement trade data from the request.
        """
        params = {'is_virtual': 0}
        return self._query_pd('/trade/rsptrade/query', params)

    def rsptrades_virtual(self):
        """Sends a GET request to the OneQuant API to retrieve virtual real-time settlement trade information.

        Args:
            None.

        Returns:
            A pandas DataFrame containing the virtual real-time settlement trade data from the request.
        """
        params = {'is_virtual': 1}
        return self._query_pd('/trade/rsptrade/query', params)

    def workers(self):
        """Sends a GET request to the OneQuant API to retrieve worker information.

        Args:
            None.

        Returns:
            A pandas DataFrame containing the worker data from the request.
        """
        return self._query_pd('/trade/worker/query')

    def conditions(self):
        """Sends a GET request to the OneQuant API to retrieve condition information.

        Args:
            None.

        Returns:
            A pandas DataFrame containing the condition data from the request.
        """
        return self._query_pd('/trade/condition/query')

    def acc_follow(self):
        """Sends a GET request to the OneQuant API to retrieve account follow information.

        Args:
            None.

        Returns:
            A pandas DataFrame containing the account follow data from the request.
        """
        params = {'user': self.username}
        return self._query_pd('/trade/accFollow/query', params)

__init__(wrapper=None)

Initializes the OqTrades class.

Parameters:

Name Type Description Default
wrapper

An object that wraps the OneQuant API.

 None

Returns:

Type Description

None.
Source code in onequant/api/trades.py 
 8
 9
10
11
12
13
14
15
16
17
18
def __init__(self, wrapper=None):
    """Initializes the OqTrades class.

    Args:
        wrapper: An object that wraps the OneQuant API.

    Returns:
        None.
    """
    self.api = wrapper.api
    self.username = wrapper.username

acc_follow()

Sends a GET request to the OneQuant API to retrieve account follow information.

Returns:

Type Description

A pandas DataFrame containing the account follow data from the request.
Source code in onequant/api/trades.py 
191
192
193
194
195
196
197
198
199
200
201
def acc_follow(self):
    """Sends a GET request to the OneQuant API to retrieve account follow information.

    Args:
        None.

    Returns:
        A pandas DataFrame containing the account follow data from the request.
    """
    params = {'user': self.username}
    return self._query_pd('/trade/accFollow/query', params)

account()

Sends a GET request to the OneQuant API to retrieve account information.

Returns:

Type Description

A tuple containing the data and code from the request.
Source code in onequant/api/trades.py 
49
50
51
52
53
54
55
56
57
58
59
def account(self):
    """Sends a GET request to the OneQuant API to retrieve account information.

    Args:
        None.

    Returns:
        A tuple containing the data and code from the request.
    """
    params = {'acc_type': 0}
    return self._query('/trade/account/query', params)

account_virtual()

Sends a GET request to the OneQuant API to retrieve virtual account information.

Returns:

Type Description

A tuple containing the data and code from the request.
Source code in onequant/api/trades.py 
61
62
63
64
65
66
67
68
69
70
71
def account_virtual(self):
    """Sends a GET request to the OneQuant API to retrieve virtual account information.

    Args:
        None.

    Returns:
        A tuple containing the data and code from the request.
    """
    params = {'acc_type': 1}
    return self._query('/trade/account/query', params)

conditions()

Sends a GET request to the OneQuant API to retrieve condition information.

Returns:

Type Description

A pandas DataFrame containing the condition data from the request.
Source code in onequant/api/trades.py 
180
181
182
183
184
185
186
187
188
189
def conditions(self):
    """Sends a GET request to the OneQuant API to retrieve condition information.

    Args:
        None.

    Returns:
        A pandas DataFrame containing the condition data from the request.
    """
    return self._query_pd('/trade/condition/query')

orders()

Sends a GET request to the OneQuant API to retrieve order information.

Returns:

Type Description

A pandas DataFrame containing the order data from the request.
Source code in onequant/api/trades.py 
 97
 98
 99
100
101
102
103
104
105
106
107
def orders(self):
    """Sends a GET request to the OneQuant API to retrieve order information.

    Args:
        None.

    Returns:
        A pandas DataFrame containing the order data from the request.
    """
    params = {'is_virtual': 0}
    return self._query_pd('/trade/order/query', params)

orders_virtual()

Sends a GET request to the OneQuant API to retrieve virtual order information.

Returns:

Type Description

A pandas DataFrame containing the virtual order data from the request.
Source code in onequant/api/trades.py 
109
110
111
112
113
114
115
116
117
118
119
def orders_virtual(self):
    """Sends a GET request to the OneQuant API to retrieve virtual order information.

    Args:
        None.

    Returns:
        A pandas DataFrame containing the virtual order data from the request.
    """
    params = {'is_virtual': 1}
    return self._query_pd('/trade/order/query', params)

position()

Sends a GET request to the OneQuant API to retrieve position information.

Returns:

Type Description

A pandas DataFrame containing the position data from the request.
Source code in onequant/api/trades.py 
73
74
75
76
77
78
79
80
81
82
83
def position(self):
    """Sends a GET request to the OneQuant API to retrieve position information.

    Args:
        None.

    Returns:
        A pandas DataFrame containing the position data from the request.
    """
    params = {'acc_type': 0}
    return self._query_pd('/trade/position/query', params)

position_virtual()

Sends a GET request to the OneQuant API to retrieve virtual position information.

Returns:

Type Description

A pandas DataFrame containing the virtual position data from the request.
Source code in onequant/api/trades.py 
85
86
87
88
89
90
91
92
93
94
95
def position_virtual(self):
    """Sends a GET request to the OneQuant API to retrieve virtual position information.

    Args:
        None.

    Returns:
        A pandas DataFrame containing the virtual position data from the request.
    """
    params = {'acc_type': 1}
    return self._query_pd('/trade/position/query', params)

rsptrades()

Sends a GET request to the OneQuant API to retrieve real-time settlement trade information.

Returns:

Type Description

A pandas DataFrame containing the real-time settlement trade data from the request.
Source code in onequant/api/trades.py 
145
146
147
148
149
150
151
152
153
154
155
def rsptrades(self):
    """Sends a GET request to the OneQuant API to retrieve real-time settlement trade information.

    Args:
        None.

    Returns:
        A pandas DataFrame containing the real-time settlement trade data from the request.
    """
    params = {'is_virtual': 0}
    return self._query_pd('/trade/rsptrade/query', params)

rsptrades_virtual()

Sends a GET request to the OneQuant API to retrieve virtual real-time settlement trade information.

Returns:

Type Description

A pandas DataFrame containing the virtual real-time settlement trade data from the request.
Source code in onequant/api/trades.py 
157
158
159
160
161
162
163
164
165
166
167
def rsptrades_virtual(self):
    """Sends a GET request to the OneQuant API to retrieve virtual real-time settlement trade information.

    Args:
        None.

    Returns:
        A pandas DataFrame containing the virtual real-time settlement trade data from the request.
    """
    params = {'is_virtual': 1}
    return self._query_pd('/trade/rsptrade/query', params)

unfill_orders()

Sends a GET request to the OneQuant API to retrieve unfulfilled order information.

Returns:

Type Description

A pandas DataFrame containing the unfulfilled order data from the request.
Source code in onequant/api/trades.py 
121
122
123
124
125
126
127
128
129
130
131
def unfill_orders(self):
    """Sends a GET request to the OneQuant API to retrieve unfulfilled order information.

    Args:
        None.

    Returns:
        A pandas DataFrame containing the unfulfilled order data from the request.
    """
    params = {'is_virtual': 0}
    return self._query_pd('/trade/order/restore/query', params)

unfill_orders_virtual()

Sends a GET request to the OneQuant API to retrieve virtual unfulfilled order information.

Returns:

Type Description

A pandas DataFrame containing the virtual unfulfilled order data from the request.
Source code in onequant/api/trades.py 
133
134
135
136
137
138
139
140
141
142
143
def unfill_orders_virtual(self):
    """Sends a GET request to the OneQuant API to retrieve virtual unfulfilled order information.

    Args:
        None.

    Returns:
        A pandas DataFrame containing the virtual unfulfilled order data from the request.
    """
    params = {'is_virtual': 1}
    return self._query_pd('/trade/order/restore/query', params)

workers()

Sends a GET request to the OneQuant API to retrieve worker information.

Returns:

Type Description

A pandas DataFrame containing the worker data from the request.
Source code in onequant/api/trades.py 
169
170
171
172
173
174
175
176
177
178
def workers(self):
    """Sends a GET request to the OneQuant API to retrieve worker information.

    Args:
        None.

    Returns:
        A pandas DataFrame containing the worker data from the request.
    """
    return self._query_pd('/trade/worker/query')