97 lines
5.6 KiB
Markdown
97 lines
5.6 KiB
Markdown
> ## Documentation Index
|
|
> Fetch the complete documentation index at: https://docs.polymarket.com/llms.txt
|
|
> Use this file to discover all available pages before exploring further.
|
|
|
|
# Get Trades
|
|
|
|
<Tip> This endpoint requires a L2 Header. </Tip>
|
|
|
|
Get trades for the authenticated user based on the provided filters.
|
|
|
|
**HTTP REQUEST**
|
|
|
|
`GET /<clob-endpoint>/data/trades`
|
|
|
|
### Request Parameters
|
|
|
|
| Name | Required | Type | Description |
|
|
| ------ | -------- | ------ | --------------------------------------------------------------------------------------------------- |
|
|
| id | no | string | id of trade to fetch |
|
|
| taker | no | string | address to get trades for where it is included as a taker |
|
|
| maker | no | string | address to get trades for where it is included as a maker |
|
|
| market | no | string | market for which to get the trades (condition ID) |
|
|
| before | no | string | unix timestamp representing the cutoff up to which trades that happened before then can be included |
|
|
| after | no | string | unix timestamp representing the cutoff for which trades that happened after can be included |
|
|
|
|
### Response Format
|
|
|
|
| Name | Type | Description |
|
|
| ---- | -------- | ------------------------------------------- |
|
|
| null | Trade\[] | list of trades filtered by query parameters |
|
|
|
|
A `Trade` object is of the form:
|
|
|
|
| Name | Type | Description |
|
|
| ----------------- | ------------- | ---------------------------------------------------------------------------- |
|
|
| id | string | trade id |
|
|
| taker\_order\_id | string | hash of taker order (market order) that catalyzed the trade |
|
|
| market | string | market id (condition id) |
|
|
| asset\_id | string | asset id (token id) of taker order (market order) |
|
|
| side | string | buy or sell |
|
|
| size | string | size |
|
|
| fee\_rate\_bps | string | the fees paid for the taker order expressed in basic points |
|
|
| price | string | limit price of taker order |
|
|
| status | string | trade status (see above) |
|
|
| match\_time | string | time at which the trade was matched |
|
|
| last\_update | string | timestamp of last status update |
|
|
| outcome | string | human readable outcome of the trade |
|
|
| maker\_address | string | funder address of the taker of the trade |
|
|
| owner | string | api key of taker of the trade |
|
|
| transaction\_hash | string | hash of the transaction where the trade was executed |
|
|
| bucket\_index | integer | index of bucket for trade in case trade is executed in multiple transactions |
|
|
| maker\_orders | MakerOrder\[] | list of the maker trades the taker trade was filled against |
|
|
| type | string | side of the trade: TAKER or MAKER |
|
|
|
|
A `MakerOrder` object is of the form:
|
|
|
|
| Name | Type | Description |
|
|
| --------------- | ------ | ----------------------------------------------------------- |
|
|
| order\_id | string | id of maker order |
|
|
| maker\_address | string | maker address of the order |
|
|
| owner | string | api key of the owner of the order |
|
|
| matched\_amount | string | size of maker order consumed with this trade |
|
|
| fee\_rate\_bps | string | the fees paid for the taker order expressed in basic points |
|
|
| price | string | price of maker order |
|
|
| asset\_id | string | token/asset id |
|
|
| outcome | string | human readable outcome of the maker order |
|
|
| side | string | the side of the maker order. Can be `buy` or `sell` |
|
|
|
|
<RequestExample>
|
|
```python Python theme={null}
|
|
from py_clob_client.clob_types import TradeParams
|
|
|
|
resp = client.get_trades(
|
|
TradeParams(
|
|
maker_address=client.get_address(),
|
|
market="0xbd31dc8a20211944f6b70f31557f1001557b59905b7738480ca09bd4532f84af",
|
|
),
|
|
)
|
|
print(resp)
|
|
print("Done!")
|
|
```
|
|
|
|
```typescript Typescript theme={null}
|
|
async function main() {
|
|
const trades = await clobClient.getTrades({
|
|
market:
|
|
"0xbd31dc8a20211944f6b70f31557f1001557b59905b7738480ca09bd4532f84af",
|
|
maker_address: await wallet.getAddress(),
|
|
});
|
|
console.log(`trades: `);
|
|
console.log(trades);
|
|
}
|
|
|
|
main();
|
|
```
|
|
</RequestExample>
|