parlayx 3.2.1__tar.gz → 3.2.2__tar.gz

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -1,6 +1,6 @@
1
1
  Metadata-Version: 2.5
2
2
  Name: parlayx
3
- Version: 3.2.1
3
+ Version: 3.2.2
4
4
  Summary: Official Python client for the ParlayX public API.
5
5
  Project-URL: Homepage, https://docs.parlayx.com
6
6
  Project-URL: Documentation, https://docs.parlayx.com
@@ -214,7 +214,7 @@ order = ProphetXOrderRequest(strike_id="strike-id", price="0.400000", quantity=2
214
214
  order.quantity = 20
215
215
  ```
216
216
 
217
- Set `time_in_force={"type": "AUTO_CANCEL"}` for the venue's timed cancellation; it cannot be combined with `post_only=True`, and the API answers 400 if you send both.
217
+ Set `time_in_force={"type": "FOK"}` for the venue's fill-or-kill, where an order with no match is cancelled at the venue after about two seconds. It cannot be combined with `post_only=True`, and the API answers 400 if you send both.
218
218
 
219
219
  `price` is the cost of one share in dollars, greater than 0 and less than 1, with at most six decimal places. ProphetX quotes a fixed set of prices, and one it does not quote is placed at the nearest it does quote at or below the price you sent, so an order never fills worse than you asked. `submit_order` reports the price actually placed on its response, and `get_ladder` returns the set.
220
220
 
@@ -194,7 +194,7 @@ order = ProphetXOrderRequest(strike_id="strike-id", price="0.400000", quantity=2
194
194
  order.quantity = 20
195
195
  ```
196
196
 
197
- Set `time_in_force={"type": "AUTO_CANCEL"}` for the venue's timed cancellation; it cannot be combined with `post_only=True`, and the API answers 400 if you send both.
197
+ Set `time_in_force={"type": "FOK"}` for the venue's fill-or-kill, where an order with no match is cancelled at the venue after about two seconds. It cannot be combined with `post_only=True`, and the API answers 400 if you send both.
198
198
 
199
199
  `price` is the cost of one share in dollars, greater than 0 and less than 1, with at most six decimal places. ProphetX quotes a fixed set of prices, and one it does not quote is placed at the nearest it does quote at or below the price you sent, so an order never fills worse than you asked. `submit_order` reports the price actually placed on its response, and `get_ladder` returns the set.
200
200
 
@@ -4,7 +4,7 @@ build-backend = "hatchling.build"
4
4
 
5
5
  [project]
6
6
  name = "parlayx"
7
- version = "3.2.1"
7
+ version = "3.2.2"
8
8
  description = "Official Python client for the ParlayX public API."
9
9
  readme = "README.md"
10
10
  requires-python = ">=3.11"
@@ -77,9 +77,9 @@ from ._generated.models import (
77
77
  PolymarketPosition,
78
78
  PolymarketSide,
79
79
  PolymarketUncancelledOrder,
80
- ProphetXAutoCancelTimeInForce,
81
80
  ProphetXBalance,
82
81
  ProphetXFillView,
82
+ ProphetXFokTimeInForce,
83
83
  ProphetXLadder,
84
84
  ProphetXListing,
85
85
  ProphetXOrderRequest,
@@ -181,9 +181,9 @@ __all__ = [
181
181
  "PolymarketResource",
182
182
  "PolymarketSide",
183
183
  "PolymarketUncancelledOrder",
184
- "ProphetXAutoCancelTimeInForce",
185
184
  "ProphetXBalance",
186
185
  "ProphetXFillView",
186
+ "ProphetXFokTimeInForce",
187
187
  "ProphetXLadder",
188
188
  "ProphetXListing",
189
189
  "ProphetXOrderRequest",
@@ -328,8 +328,9 @@ class AsyncProphetXResource:
328
328
  at the nearer one at or below, so read ``price`` on the response for what was
329
329
  actually placed. The response acknowledges the order at the venue. It does not
330
330
  report a fill: ProphetX acknowledges an order before matching it, so read
331
- ``get_order_fills`` for execution. AUTO_CANCEL requests the venue's two-second
332
- policy and permits partial fills. It cannot be combined with post_only=True.
331
+ ``get_order_fills`` for execution. FOK requests the venue's fill-or-kill: an
332
+ order with no match is cancelled at the venue after about two seconds. It
333
+ cannot be combined with post_only=True.
333
334
 
334
335
  An idempotency key is attached for you and defaults to a fresh value per call,
335
336
  so an unkeyed retry submits a SECOND order. Pass your own to make a specific
@@ -1681,19 +1681,19 @@ class SubmitProphetXOrderResponse(BaseModel):
1681
1681
 
1682
1682
 
1683
1683
  class Type8(StrEnum):
1684
- auto_cancel = "AUTO_CANCEL"
1684
+ fok = "FOK"
1685
1685
 
1686
1686
 
1687
- class ProphetXAutoCancelTimeInForce(BaseModel):
1687
+ class ProphetXFokTimeInForce(BaseModel):
1688
1688
  """
1689
- Cancels at the venue if no match is made within two seconds; partial fills are possible.
1689
+ The venue's fill-or-kill strategy: an order with no match is cancelled at the venue after about two seconds.
1690
1690
  """
1691
1691
 
1692
1692
  model_config = ConfigDict(
1693
1693
  extra="forbid",
1694
1694
  populate_by_name=True,
1695
1695
  )
1696
- type: Literal["AUTO_CANCEL"]
1696
+ type: Literal["FOK"]
1697
1697
 
1698
1698
 
1699
1699
  class ProphetXOrderRequest(BaseModel):
@@ -1722,7 +1722,7 @@ class ProphetXOrderRequest(BaseModel):
1722
1722
  Field(description="Stake in account currency units.", examples=[25], gt=0.0),
1723
1723
  ]
1724
1724
  time_in_force: Annotated[
1725
- GtcTimeInForce | ProphetXAutoCancelTimeInForce | None,
1725
+ GtcTimeInForce | ProphetXFokTimeInForce | None,
1726
1726
  Field(
1727
1727
  alias="timeInForce",
1728
1728
  description="Execution policy; omission uses GTC.",
@@ -1799,7 +1799,7 @@ class ProphetXOrderView(BaseModel):
1799
1799
  ),
1800
1800
  ]
1801
1801
  time_in_force: Annotated[
1802
- GtcTimeInForce | ProphetXAutoCancelTimeInForce | None,
1802
+ GtcTimeInForce | ProphetXFokTimeInForce | None,
1803
1803
  Field(
1804
1804
  alias="timeInForce",
1805
1805
  description="Requested execution policy when recorded with the order.",
@@ -333,8 +333,9 @@ class ProphetXResource:
333
333
  at the nearer one at or below, so read ``price`` on the response for what was
334
334
  actually placed. The response acknowledges the order at the venue. It does not
335
335
  report a fill: ProphetX acknowledges an order before matching it, so read
336
- ``get_order_fills`` for execution. AUTO_CANCEL requests the venue's two-second
337
- policy and permits partial fills. It cannot be combined with post_only=True.
336
+ ``get_order_fills`` for execution. FOK requests the venue's fill-or-kill: an
337
+ order with no match is cancelled at the venue after about two seconds. It
338
+ cannot be combined with post_only=True.
338
339
 
339
340
  An idempotency key is attached for you and defaults to a fresh value per call,
340
341
  so an unkeyed retry submits a SECOND order. Pass your own to make a specific
File without changes
File without changes
File without changes
File without changes
File without changes