Getting Started with PoolStream API Services
Welcome to PoolStream API Services! This guide will help you quickly get started with our APIs and libraries.
To begin using PoolStream APIs, you must generate an API key. This key will be used to authenticate your requests.
Visit the API Key management site: https://dashboard.poolstream.io/auth/apikeys.
Log in to your account or create one if you haven’t already.
Generate your API key and store it securely. You will need it to make API requests.
All PoolStream APIs follow a consistent structure with /private as the base path. For example:
https://api.poolstream.io/private/rest/v1/tron/TXoxyWGkiPGA66Jbx9ANscVCRxNKwGcC5p/payments
Every request to our API must include the API_KEY header:
API_KEY: <your-api-key>
We provide a comprehensive Swagger interface for you to explore all available endpoints and their details.
Access the Swagger documentation here: https://api.poolstream.io/api-docs.
Use the Swagger interface to:
Test endpoints interactively.
View parameter and response details.
Understand error codes.
PoolStream provides libraries to sign transactions and generate wallets offline, ensuring maximum security for your operations.
Currently, we offer the following library:
NPM Package: @poolstream/offline
To install the library, use:
npm install @poolstream/offline
Refer to the library documentation for examples and detailed usage.
If you have any questions or run into issues:
Contact support via the dashboard.
Visit our API documentation: https://api.poolstream.io/api-docs.
Check out our community forums for tips and solutions.
Thank you for choosing PoolStream. Happy coding!