---
updatedAt: 2025-09-29T20:17:21.000Z
agentTools:
  projectIndex: https://docs.bitwave.io/llms.txt
---

# API Reference

Comprehensive reference for integrating with Bitwave API endpoints

## Endpoint and Schema Overview

Core

<Table align={["left","left","left"]}>
  <thead>
    <tr>
      <th style={{ textAlign: "left" }}>
        Endpoint
      </th>

      <th style={{ textAlign: "left" }}>
        Schema
      </th>

      <th style={{ textAlign: "left" }}>

      </th>
    </tr>
  </thead>

  <tbody>
    <tr>
      <td style={{ textAlign: "left" }}>
        **Transactions V1**  

        Retrieve blockchain transaction data. Use V2 endpoints (revised version) when possible.
      </td>

      <td style={{ textAlign: "left" }}>
        [/txns/categorize/\{orgId}/\{transactionId}](https://docs.bitwave.io/reference/categorizetransaction)\
        [/txns/\{orgId}/\{transactionId}/\{sourceId}](https://docs.bitwave.io/reference/upserttransaction)\
        [/txns/\{orgId}/\{transactionId}/\{sourceId}](https://docs.bitwave.io/reference/head)\
        [/txns/\{orgId}/\{transactionId}](https://docs.bitwave.io/reference/getTransaction)\
        [/txns/\{orgId}](https://docs.bitwave.io/reference/getTransactionsPaginated)
      </td>

      <td style={{ textAlign: "left" }}>

      </td>
    </tr>

    <tr>
      <td style={{ textAlign: "left" }}>
        **Transactions V2**  

        Retrieve blockchain transaction data. Revised from V1, use V2 transaction endpoints where possible.
      </td>

      <td style={{ textAlign: "left" }}>
        [/orgs/\{orgId}/transactions](https://docs.bitwave.io/reference/getTransactionsLite)\
        [/orgs/\{orgId}/transactions/dirty](https://docs.bitwave.io/reference/checkPriceDirty)\
        [/orgs/\{orgId}/transactions/\{transactionId}/rules/\{ruleId}](https://docs.bitwave.io/reference/checkRuleApplication)\
        [/orgs/\{orgId}/transactions/\{transactionId}](https://docs.bitwave.io/reference/categorizeTransactionPatch)
      </td>

      <td style={{ textAlign: "left" }}>

      </td>
    </tr>

    <tr>
      <td style={{ textAlign: "left" }}>
        **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
      </td>

      <td style={{ textAlign: "left" }}>
        [org/\{orgId}/categories/](https://docs.bitwave.io/reference/getcategories)
      </td>

      <td style={{ textAlign: "left" }}>

      </td>
    </tr>

    <tr>
      <td style={{ textAlign: "left" }}>
        **Connections**  

        Retrieve all the integrations within an organization
      </td>

      <td style={{ textAlign: "left" }}>
        [/orgs/\{orgId}/connections/\{connectionId}](https://docs.bitwave.io/reference/getconnection)\
        [/orgs/\{orgId}/connections/\{connectionId}/token](https://docs.bitwave.io/reference/getconnectiontoken)\
        [/orgs/\{orgId}/connections](https://docs.bitwave.io/reference/getconnections)
      </td>

      <td style={{ textAlign: "left" }}>

      </td>
    </tr>

    <tr>
      <td style={{ textAlign: "left" }}>
        **Contacts**  

        Retrieve all the contacts within an organization. This is typically the contacts from the customer's ERP system if integrated with Bitwave.
      </td>

      <td style={{ textAlign: "left" }}>
        [/contacts/\{orgId}](https://docs.bitwave.io/reference/getcontacts)
      </td>

      <td style={{ textAlign: "left" }}>

      </td>
    </tr>

    <tr>
      <td style={{ textAlign: "left" }}>
        **Authentication**  

        Obtain and manage an authentication token to access the Bitwave API
      </td>

      <td style={{ textAlign: "left" }}>
        [/oauth/token](https://docs.bitwave.io/reference/gettoken)
      </td>

      <td style={{ textAlign: "left" }}>

      </td>
    </tr>

    <tr>
      <td style={{ textAlign: "left" }}>
        **Organizations**  

        Retrieve all the organizations associated with a user
      </td>

      <td style={{ textAlign: "left" }}>
        [/organizations](https://docs.bitwave.io/reference/getuserorganizations)
      </td>

      <td style={{ textAlign: "left" }}>

      </td>
    </tr>

    <tr>
      <td style={{ textAlign: "left" }}>
        **Users**  

        Access user account information and see all possible account types and sub-types
      </td>

      <td style={{ textAlign: "left" }}>
        [/users/me](https://docs.bitwave.io/reference/me)
      </td>

      <td style={{ textAlign: "left" }}>

      </td>
    </tr>

    <tr>
      <td style={{ textAlign: "left" }}>
        **Wallets**  

        Fetch all the wallets within an organization
      </td>

      <td style={{ textAlign: "left" }}>
        [/orgs/\{orgId}/wallets](https://docs.bitwave.io/reference/getwallets)
      </td>

      <td style={{ textAlign: "left" }}>

      </td>
    </tr>
  </tbody>
</Table>

Address-SVC

<Table align={["left","left"]}>
  <thead>
    <tr>
      <th>
        Endpoint
      </th>

      <th>
        Schema
      </th>
    </tr>
  </thead>

  <tbody>
    <tr>
      <td>
        **Addresses**  

        Retrieve all the addresses associated with a particular blockchain network
      </td>

      <td>
        [/networks/\{networkId}/addresses/\{address}](https://docs.bitwave.io/reference/getaddress)\
        [/networks/\{networkId}/addresses/\{address}/balance](https://docs.bitwave.io/reference/getaddressbalance)\
        [/networks/\{networkId}/addresses/\{vaultAddress}/vaultBalance](https://docs.bitwave.io/reference/getvaultbalance)\
        [/networks/\{networkId}/addresses/\{address}/supply](https://docs.bitwave.io/reference/getaddresssupply)\
        [/networks/\{networkId}/addresses/\{address}/read/\{method}](https://docs.bitwave.io/reference/read)
      </td>
    </tr>

    <tr>
      <td>
        **Blocks**  

        Retrieve all the blocks for a particular blockchain network
      </td>

      <td>
        [/networks/\{networkId}/blocks](https://docs.bitwave.io/reference/listblocks)
      </td>
    </tr>

    <tr>
      <td>
        **Coins**  

        View all the coins that we support
      </td>

      <td>
        [coins](https://docs.bitwave.io/reference/list)\
        [/coins/\{coinId}](https://docs.bitwave.io/reference/getcoin)
      </td>
    </tr>

    <tr>
      <td>
        **DeFi Platforms**  

        Verify a DeFi balance from the blockchain
      </td>

      <td>
        [/networks/\{networkId}/platforms/\{platformId}/balance](https://docs.bitwave.io/reference/getplatformbalance)
      </td>
    </tr>

    <tr>
      <td>
        **Symbols**  

        Retrieve all the different cryptocurrency symbols we support
      </td>

      <td>
        [/symbols/\{symbol}](https://docs.bitwave.io/reference/getsymbol)
      </td>
    </tr>
  </tbody>
</Table>

## 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.

```javascript
$http.post('/someUrl', data).success(successCallback);

alert('test');
```