The OpenPool API offers the capability to create, update and manage custom smart contract names for counterparty addresses your wallet interacts with. This can be helpful when you are trying to make 0x address data more readable and easier to understand for you and your service providers.
Before you can query the OpenPool API for a given wallet or contract balances and transactions you will first need to register the wallet. You can optionally register a set of wallets all at once by submitting a comma-separated list of 0x addresses to this endpoint.
Requests
- Create Custom Address Label
- Summary: This endpoint allows you to create a private, custom label to assign to a particular counterparty 0x address.
- Request Method: POST
- Update Custom Address Label
- Summary: This endpoint allows you to update a custom label name using a PUT method which will replace all of the custom name fields for a specified counterparty address throughout your wallet.
- Request Method: PUT
- Partial Update Custom Address Label
- Summary: This endpoint allows you to update a custom label using the PATCH method. PATCH will only update custom label name fields you specifically modify.
- Request Method: PATCH
- Delete Custom Address Label
- Summary:This endpoint allows you to delete one of your custom labels from OpenPool.
- Request Method: DELETE
- Get List of Custom Labels
- Summary: This endpoint allows you to get a list of all of your custom labels (and associated id's) so that you can query against them.
- Request Method: GET
- Get Custom Address Label
- Summary: This endpoint allows you to retrieve one of your custom address labels.
- Request Method: GET