aboutsummaryrefslogtreecommitdiffstats
path: root/python-packages/sra_client/README.md
diff options
context:
space:
mode:
authorF. Eugene Aumson <feuGeneA@users.noreply.github.com>2018-12-15 08:08:57 +0800
committerF. Eugene Aumson <feuGeneA@users.noreply.github.com>2018-12-15 08:08:57 +0800
commit57ac2f28a43067e51f1db1736b48893189ce9dd0 (patch)
treeed61753826cd58ea3359ede634516679f6777ec5 /python-packages/sra_client/README.md
parent210840444d0eea3284bf973d13f1ad4b3b1db8fb (diff)
downloaddexon-sol-tools-57ac2f28a43067e51f1db1736b48893189ce9dd0.tar
dexon-sol-tools-57ac2f28a43067e51f1db1736b48893189ce9dd0.tar.gz
dexon-sol-tools-57ac2f28a43067e51f1db1736b48893189ce9dd0.tar.bz2
dexon-sol-tools-57ac2f28a43067e51f1db1736b48893189ce9dd0.tar.lz
dexon-sol-tools-57ac2f28a43067e51f1db1736b48893189ce9dd0.tar.xz
dexon-sol-tools-57ac2f28a43067e51f1db1736b48893189ce9dd0.tar.zst
dexon-sol-tools-57ac2f28a43067e51f1db1736b48893189ce9dd0.zip
Add example usage to sra_client README
Diffstat (limited to 'python-packages/sra_client/README.md')
-rw-r--r--python-packages/sra_client/README.md29
1 files changed, 29 insertions, 0 deletions
diff --git a/python-packages/sra_client/README.md b/python-packages/sra_client/README.md
index ab3939b41..279fb41a4 100644
--- a/python-packages/sra_client/README.md
+++ b/python-packages/sra_client/README.md
@@ -6,6 +6,35 @@ A Python client for interacting with servers conforming to [the Standard Relayer
The [JSON schemas](http://json-schema.org/) for the API payloads and responses can be found in [@0xproject/json-schemas](https://github.com/0xProject/0x.js/tree/development/packages/json-schemas). Examples of each payload and response can be found in the 0x.js library's [test suite](https://github.com/0xProject/0x.js/blob/development/packages/json-schemas/test/schema_test.ts#L1).
+```bash
+pip install 0x-json-schemas
+```
+
+You can easily validate your API's payloads and responses using the [0x-json-schemas](https://github.com/0xProject/0x.js/tree/development/python-packages/json_schemas) package:
+
+```python
+from zero_ex.json_schemas import assert_valid
+from zero_ex.order_utils import Order
+
+order: Order = {
+ 'makerAddress': "0x0000000000000000000000000000000000000000",
+ 'takerAddress': "0x0000000000000000000000000000000000000000",
+ 'feeRecipientAddress': "0x0000000000000000000000000000000000000000",
+ 'senderAddress': "0x0000000000000000000000000000000000000000",
+ 'makerAssetAmount': "1000000000000000000",
+ 'takerAssetAmount': "1000000000000000000",
+ 'makerFee': "0",
+ 'takerFee': "0",
+ 'expirationTimeSeconds': "12345",
+ 'salt': "12345",
+ 'makerAssetData': "0x0000000000000000000000000000000000000000",
+ 'takerAssetData': "0x0000000000000000000000000000000000000000",
+ 'exchangeAddress': "0x0000000000000000000000000000000000000000",
+}
+
+assert_valid(order, "/orderSchema")
+```
+
# Pagination
Requests that return potentially large collections should respond to the **?page** and **?perPage** parameters. For example: