Comprehensive reference for integrating with Bitwave API endpoints
Endpoint and Schema Overview
Core
| Endpoint | Schema | |
|---|---|---|
| Transactions V1 Retrieve blockchain transaction data. Use V2 endpoints (revised version) when possible. | /txns/categorize/{orgId}/{transactionId} /txns/{orgId}/{transactionId}/{sourceId} /txns/{orgId}/{transactionId}/{sourceId} /txns/{orgId}/{transactionId} /txns/{orgId} | |
| Transactions V2 Retrieve blockchain transaction data. Revised from V1, use V2 transaction endpoints where possible. | /orgs/{orgId}/transactions /orgs/{orgId}/transactions/dirty /orgs/{orgId}/transactions/{transactionId}/rules/{ruleId} /orgs/{orgId}/transactions/{transactionId} | |
| Categories Fetch all the categories for an organization. This is typically a chart of accounts from the customer's ERP system if integrated with Bitwave | org/{orgId}/categories/ | |
| Connections Retrieve all the integrations within an organization | /orgs/{orgId}/connections/{connectionId} /orgs/{orgId}/connections/{connectionId}/token /orgs/{orgId}/connections | |
| Contacts Retrieve all the contacts within an organization. This is typically the contacts from the customer's ERP system if integrated with Bitwave. | /contacts/{orgId} | |
| Authentication Obtain and manage an authentication token to access the Bitwave API | /oauth/token | |
| Organizations Retrieve all the organizations associated with a user | /organizations | |
| Users Access user account information and see all possible account types and sub-types | /users/me | |
| Wallets Fetch all the wallets within an organization | /orgs/{orgId}/wallets |
Address-SVC
| Endpoint | Schema |
|---|---|
| Addresses Retrieve all the addresses associated with a particular blockchain network | /networks/{networkId}/addresses/{address} /networks/{networkId}/addresses/{address}/balance /networks/{networkId}/addresses/{vaultAddress}/vaultBalance /networks/{networkId}/addresses/{address}/supply /networks/{networkId}/addresses/{address}/read/{method} |
| Blocks Retrieve all the blocks for a particular blockchain network | /networks/{networkId}/blocks |
| Coins View all the coins that we support | coins /coins/{coinId} |
| DeFi Platforms Verify a DeFi balance from the blockchain | /networks/{networkId}/platforms/{platformId}/balance |
| Symbols Retrieve all the different cryptocurrency symbols we support | /symbols/{symbol} |
API Access
To gain access to the Bitwave API, create an account on Bitwave. Once you've completed the signup process, navigate to the Organization tab > API section. Then, click on 'Create API Key' and we will generate a client_id and secret for you. Please save the secret, it will be inaccessible after you close this pop-up.
API Protocol and Headers
The Bitwave API uses standard HTTP methods (PUT, HEAD, GET, POST) to communicate and HTTP response codes to indicate status and errors. All responses come in standard JSON.
Almost all Bitwave API endpoints require a client_id and secret.
Successful Callback
The successCallback is called when a user successfully authenticates with the Bitwave API.
$http.post('/someUrl', data).success(successCallback);
alert('test');