# DriveWealth API API

> DriveWealth API API on Apizie: 109 endpoints (Create Trade Allocation, Retrieve Trade Allocation, Create Fund, Retrieve Fund, …) returned as clean JSON through one API key. Send your own provider key in the x-upstream-key header. Call it over REST at https://www.apizie.tech/v1/finance:drivewealth/{endpoint} or from Claude, ChatGPT and Cursor through the Apizie MCP server. Free plan: 1,000 requests a month.

- Project key: `finance:drivewealth`
- Category: Finance
- Status: byok
- Source: https://www.drivewealth.com
- Page: https://www.apizie.tech/api/finance/drivewealth
- OpenAPI: https://www.apizie.tech/api/finance/drivewealth/openapi.json

DriveWealth is the pioneer of fractional equities trading and embedded investing. We are a visionary technology company that empowers more than 100 partners around the world to engage their customers by placing the…

## Endpoints

### Create Trade Allocation
`POST https://www.apizie.tech/v1/finance:drivewealth/trade-allocations-create-allocation` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | yes | JSON request body |

### Retrieve Trade Allocation
`GET https://www.apizie.tech/v1/finance:drivewealth/trade-allocations-get-details` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| allocationID | string | yes | The unique identifier returned when a Trade Allocation request is made. |

### Create Fund
`POST https://www.apizie.tech/v1/finance:drivewealth/funds-create-fund-collection` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | yes | JSON request body |

### Retrieve Fund
`GET https://www.apizie.tech/v1/finance:drivewealth/funds-get-details` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| fundID | string | yes | The unique identifier associated with the Fund. |

### Create Portfolio
`POST https://www.apizie.tech/v1/finance:drivewealth/portfolios-create-portfolio-allocation` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | yes | JSON request body |

### Retrieve Portfolio
`GET https://www.apizie.tech/v1/finance:drivewealth/portfolios-get-details` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| portfolioID | string | yes | A unique identifier associated with a specific Portfolio. |

### Update Portfolio
`POST https://www.apizie.tech/v1/finance:drivewealth/portfolios-update-holdings` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| portfolioID | string | yes | A unique identifier associated with a specific Portfolio. |
| body | object | no | JSON request body |

### Create Autopilot Run
`POST https://www.apizie.tech/v1/finance:drivewealth/auto-pilot-create-run` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| partnerID | string | yes | This is the parentIBID or userID of the registered investment advisor. |
| body | object | yes | JSON request body |

### Retrieve Autopilot Run
`GET https://www.apizie.tech/v1/finance:drivewealth/auto-pilot-get-run-details` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| rebalanceRunID | string | yes | The unique re-balance run identifier `rebalanceRunID` associated with a specific re-balance. |

### Create Account
`POST https://www.apizie.tech/v1/finance:drivewealth/accounts-create-new-brokerage-account` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | yes | JSON request body |

### Retrieve Account
`GET https://www.apizie.tech/v1/finance:drivewealth/accounts-get-details` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| accountID | string | yes | The user's unique account identifier. |

### Update Account
`POST https://www.apizie.tech/v1/finance:drivewealth/accounts-update-account-details` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| accountID | string | yes | The user's unique account identifier. |
| body | object | yes | JSON request body |

### List all Commission Schedules
`GET https://www.apizie.tech/v1/finance:drivewealth/commission-schedules-list-all` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| accountID | string | yes | The user's unique account identifier. |

### Retrieve Beneficiaries by Account
`GET https://www.apizie.tech/v1/finance:drivewealth/beneficiaries-list-by-account` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| accountID | string | yes | The user's unique account identifier. |

### Create Beneficiaries
`POST https://www.apizie.tech/v1/finance:drivewealth/beneficiaries-create-new-set` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| accountID | string | yes | The user's unique account identifier. |
| body | object | yes | JSON request body |

### Delete Beneficiaries
`POST https://www.apizie.tech/v1/finance:drivewealth/beneficiaries-remove-all` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| accountID | string | yes | The user's unique account identifier. |

### Retrieve Virtual Bank Account by Account
`GET https://www.apizie.tech/v1/finance:drivewealth/virtual-bank-accounts-get-details` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| accountID | string | yes | The user's unique account identifier. |

### List Deposits by Account
`GET https://www.apizie.tech/v1/finance:drivewealth/deposits-list-by-account` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| accountID | string | yes | The user's unique account identifier. |

### List Withdrawals by Account
`GET https://www.apizie.tech/v1/finance:drivewealth/withdrawals-list-by-account` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| accountID | string | yes | The user's unique account identifier. |

### Retrieve Orders by Account
`GET https://www.apizie.tech/v1/finance:drivewealth/orders-get-by-account` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| accountID | string | yes | The user's unique account identifier. |

### List Orders by Account
`GET https://www.apizie.tech/v1/finance:drivewealth/orders-list-by-account` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| accountID | string | yes | The user's unique account identifier. |
| from | string | yes | Date start time of data. Follow [ISO 8601 standard](https://en.wikipedia.org/wiki/ISO_8601) |
| to | string | yes | Date end time of data. Follow [ISO 8601 standard](https://en.wikipedia.org/wiki/ISO_8601) |
| limit | number | no | The number of orders to be returned per page. |
| offset | string | no | Follow [ISO 8601 standard](https://en.wikipedia.org/wiki/ISO_8601) |
| direction | string | no | The direction of pagination. |

### Retrieve Portfolio by Account
`GET https://www.apizie.tech/v1/finance:drivewealth/auto-pilot-get-portfolio-by-account` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| accountID | string | yes | The user's unique account identifier. |

### Retrieve Money by Account
`GET https://www.apizie.tech/v1/finance:drivewealth/accounts-get-money-by-account` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| accountID | string | yes | The user's unique account identifier. |

### List Statements by Account
`GET https://www.apizie.tech/v1/finance:drivewealth/statements-list-by-account` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| accountID | string | yes | The user's unique account identifier. |

### List Tax Statements by Account
`GET https://www.apizie.tech/v1/finance:drivewealth/statements-list-tax-statements-by-account` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| accountID | string | yes | The user's unique account identifier. |
| from | string | no | The date to start the filter. |
| to | string | no | The date to end the filter. |

### List Trade Confirmations by Account
`GET https://www.apizie.tech/v1/finance:drivewealth/statements-list-trade-confirmations` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| accountID | string | yes | The user's unique account identifier. |
| from | string | no | Filter, the date from which to start the search. |
| to | string | no | Filter, the date to which to end the search. |

### Retrieve Performance Metrics by Account
`GET https://www.apizie.tech/v1/finance:drivewealth/accounts-get-performance-metrics` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| accountID | string | yes | The user's unique account identifier. |
| period | string | no | Used for relative date range, accepts a number and a unit of time (E.g: 3d = 3 Days or 2w = 2 Weeks). |
| from | string | no | Start date and time of requested time frame of the accounts performance. |
| to | string | no | End date and time of requested time frame of the accounts performance. |

### List Positions by Account
`GET https://www.apizie.tech/v1/finance:drivewealth/positions-list-equity-positions` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| accountID | string | yes | The user's unique account identifier. |

### Retrieve Violations by Account
`GET https://www.apizie.tech/v1/finance:drivewealth/violations-get-by-account` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| accountID | string | yes | The user's unique account identifier. |

### List Violations by Account
`GET https://www.apizie.tech/v1/finance:drivewealth/violations-list-by-account` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| accountID | string | yes | The user's unique account identifier. |

### Retrieve Margin Details by Account
`GET https://www.apizie.tech/v1/finance:drivewealth/accounts-get-margin-details` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| accountID | string | yes | The user's unique account identifier. |

### Retrieve Transaction Summary by Account
`GET https://www.apizie.tech/v1/finance:drivewealth/transactions-get-summary-by-account` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| accountID | string | yes | The user's unique account identifier. |

### List Transactions by Account
`GET https://www.apizie.tech/v1/finance:drivewealth/transactions-list-by-account` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| accountID | string | yes | The user's unique account identifier. |
| from | string | yes | Date start time of data. Follow [ISO 8601 standard](https://en.wikipedia.org/wiki/ISO_8601) |
| to | string | yes | Date end time of data. Follow [ISO 8601 standard](https://en.wikipedia.org/wiki/ISO_8601) |
| limit | number | no | The number of transactions to be returned per page. |
| offset | string | no | Follow [ISO 8601 standard](https://en.wikipedia.org/wiki/ISO_8601) |
| direction | string | no | The direction of pagination |

### Retrieve Account Position Lots
`GET https://www.apizie.tech/v1/finance:drivewealth/accounts-get-position-lots` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| accountID | string | yes | The user's unique account identifier. |

### Retrieve Account Option Positions
`GET https://www.apizie.tech/v1/finance:drivewealth/positions-get-account-option` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| accountID | string | yes | The user's unique account identifier. |
| filterBy | string | no | The expiration date of options; to filter by. |
| from | string | no | The start date of the range of option's expiration. |
| to | string | no | The end date of the range of option's expiration. |
| limit | number | no | The number of results to be returned. |
| offset | string | no | The identifier of the page. |

### Create ACATS Transfer
`POST https://www.apizie.tech/v1/finance:drivewealth/asset-transfer-create-acats-transfer` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | no | JSON request body |

### Create Minor Graduation Transfer
`POST https://www.apizie.tech/v1/finance:drivewealth/asset-transfer-create-minor-graduation-transfer` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | no | JSON request body |

### Retrieve Transfer
`GET https://www.apizie.tech/v1/finance:drivewealth/asset-transfer-get-details` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| assetTransferID | string | yes |  |

### List Transfers
`GET https://www.apizie.tech/v1/finance:drivewealth/asset-transfer-list-transfers` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| status | string | no | A status to filter by |
| type | string | yes | A Transfer type to filter by |
| limit | string | no | Maximum number of records to be returned |
| offset | string | no | Specify an identifier from last API response to go to the next page or prev page |
| direction | string | no | Go to the next page or prev page |

### List Cancel Rebills
`GET https://www.apizie.tech/v1/finance:drivewealth/cancel-rebill-list-cancel-rebills` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| from | string | yes | The start date of the range of Cancel Rebill. |
| to | string | yes | The end date of the range of Cancel Rebill. |
| partnerID | string | no |  |
| status | string | yes | The Cancel Rebill status code. |
| limit | integer | no | The number of records to be returned by the query. |
| offset | string | no | The offset of the last queried result. |
| direction | string | no |  |

### Create Cancel Rebill
`POST https://www.apizie.tech/v1/finance:drivewealth/cancel-rebill-create` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | yes | JSON request body |

### Retrieve Cancel Rebill
`GET https://www.apizie.tech/v1/finance:drivewealth/cancel-rebill-get-details-by-id` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | The identifier of the Cancel Rebill. |

### Create Session Token
`POST https://www.apizie.tech/v1/finance:drivewealth/auth-create-session-token` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | no | JSON request body |

### List Supported Countries
`GET https://www.apizie.tech/v1/finance:drivewealth/supported-countries-get-list` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| status | string | yes | Filters on the returned countries list has inactive or active countries inside it. |

### Create Deposit
`POST https://www.apizie.tech/v1/finance:drivewealth/deposits-create-user-deposit` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | no | JSON request body |

### Retrieve Deposit
`GET https://www.apizie.tech/v1/finance:drivewealth/deposits-get-by-id` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| depositID | string | yes | A unique identifier for the user's account deposit. |

### List Disclosures
`GET https://www.apizie.tech/v1/finance:drivewealth/disclosures-list-items` (byok)

### Retrieve Disclosure
`GET https://www.apizie.tech/v1/finance:drivewealth/disclosures-get-details` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| disclosureID | string | yes | The id of a disclosure |

### List Disclosures Acknowledgments by User
`GET https://www.apizie.tech/v1/finance:drivewealth/disclosures-list-user-acknowledgments` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| userID | string | yes | A unique identifier created for each User on DriveWealth's platform. |

### Create Disclosure Acknowledgment
`POST https://www.apizie.tech/v1/finance:drivewealth/disclosures-acknowledge-user-disclosure` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| userID | string | yes | A unique identifier created for each User on DriveWealth's platform. |
| body | object | yes | JSON request body |

### Create Exchange
`POST https://www.apizie.tech/v1/finance:drivewealth/exchanges-create-exchange` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | no | JSON request body |

### Update Exchange
`POST https://www.apizie.tech/v1/finance:drivewealth/exchanges-cancel-pending-order` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | no | JSON request body |

### Retrieve Exchange
`GET https://www.apizie.tech/v1/finance:drivewealth/exchanges-get-details` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| exchangeIdentifier | string | yes | The Exchange ID (id) or Exchange Number (exchangeNo) |

### List Exchanges by Account
`GET https://www.apizie.tech/v1/finance:drivewealth/exchanges-list-by-account` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| accountID | string | yes | The account id of the user where the order was placed |

### Retrieve Exchange History by Account
`GET https://www.apizie.tech/v1/finance:drivewealth/exchanges-get-exchange-history` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| accountID | string | yes | The account id of the user where the order was placed |

### Retrieve Chart
`GET https://www.apizie.tech/v1/finance:drivewealth/charts-get-bars` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| instrumentID | string | yes | A unique ID created by DriveWealth to identify a specific instrument. |
| compression | string | yes | The compression number represents the time increments of the chart data. Refer to the Compression table above. |
| dateStart | string | yes | The start date of the chart data. Follow ISO-8601 format. |
| dateEnd | string | yes | The end date of the chart data. Follow ISO-8601 format. |
| tradingDays | string | no | TradingDays may be defined as 1-60 days in the past from the current date. If set do not use `dateStart` and `dateEnd` values. |

### List Instruments
`GET https://www.apizie.tech/v1/finance:drivewealth/instruments-list-all` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| status | string | no | The instrument status; to filter by. |
| isOptionsEnabled | boolean | no | The ability to trade options for this instrument; to filter by. |

### Retrieve Instrument
`GET https://www.apizie.tech/v1/finance:drivewealth/instruments-get-details` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| symbolOrInstrumentID | string | yes | A unique ID created by DriveWealth to identify a specific Equity Instrument or Option Instrument, also accept the market symbols like… |
| options | string | no | This query parameter will add an additional property; `fundamentalDataModel` to the response object for an Equity Instrument only. This… |

### Retrieve Options Chain
`GET https://www.apizie.tech/v1/finance:drivewealth/instruments-get-options-chain` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| symbolOrInstrumentID | string | yes | Symbol or instrumentID of the underlying equity security |
| expirationDate | string | yes | The expiration date of the option security; to filter by. |
| page | integer | no |  |
| pageSize | integer | no | The number of option instruments to be returned per page. |
| sortOrder | string | no | The sorting order of option instruments. |
| noOfStrikes | integer | no | The number of option instruments to be returned above and below market price. |
| minStrikePrice | integer | no | The option instruments to be returned above the strike price. |
| maxStrikePrice | integer | no | The option instruments to be returned below the strike price. |
| optionType | string | no | The type of option instruments to be returned. |
| id | string | no | The instrument ID of the option security. |
| filterBy | string | no | The expiration dates for the given underlying security; to filter by. |

### Retrieve Option Expiration
`GET https://www.apizie.tech/v1/finance:drivewealth/instruments-get-option-expiration` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| symbolOrInstrumentID | string | yes | Symbol or instrumentID of the underlying equity security. |

### Search Instruments by Filter
`POST https://www.apizie.tech/v1/finance:drivewealth/instruments-search-by-filter` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | no | JSON request body |

### Create Order
`POST https://www.apizie.tech/v1/finance:drivewealth/orders-create-security-order` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | yes | JSON request body |

### Retrieve Order
`GET https://www.apizie.tech/v1/finance:drivewealth/orders-get-status` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| orderID | string | yes | A unique DriveWealth order identifier created when an order is placed. |

### Update Order
`POST https://www.apizie.tech/v1/finance:drivewealth/orders-update-in-progress` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| orderID | string | yes | A unique DriveWealth order identifier created when an order is placed. |
| body | object | yes | JSON request body |

### Retrieve Order By OrderNo
`GET https://www.apizie.tech/v1/finance:drivewealth/orders-get-by-order-no` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| orderNo | string | yes | The unique order number that is human readable. |

### Create a request-for-quote
`POST https://www.apizie.tech/v1/finance:drivewealth/orders-create-rfq-crypto` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | yes | JSON request body |

### Create Order with request-for-quote
`POST https://www.apizie.tech/v1/finance:drivewealth/orders-execute-rfq-crypto` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | yes | JSON request body |

### Retrieve Option Orders
`GET https://www.apizie.tech/v1/finance:drivewealth/orders-get-option-orders` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| type | string | yes | The Transaction Batch type. |
| status | string | yes | The status of Transaction Batch. |
| partnerIBID | string | yes | The unique identifier of the firm. |
| fromDate | string | no | A filter, the start date. |
| toDate | string | no | A filter, the end date. |
| pageSize | integer | no | The number of results to be returned. |
| pageNo | integer | no |  |

### Create Physical Document
`POST https://www.apizie.tech/v1/finance:drivewealth/physical-documents-upload-driver-license` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | no | JSON request body |

### Retrieve Physical Document URL by Document
`GET https://www.apizie.tech/v1/finance:drivewealth/physical-documents-get-url-by-document-id` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| documentID | string | yes | The unique identifier of the document. |

### Retrieve Quote (referential feed)
`GET https://www.apizie.tech/v1/finance:drivewealth/quotes-get-referential-details` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| dw-customer-user-id | string | no | The unique identifier of the user, who is requesting the quote. |
| symbols | string | yes | The ticker symbol of the associated instrument. Multiple ticker symbols separated by a comma may also be used. |
| exchangeOverride | string | no | The quote details will be 15 minutes delayed. |

### Retrieve Quote (consolidated feed)
`GET https://www.apizie.tech/v1/finance:drivewealth/quotes-get-consolidated-feed` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| dw-customer-user-id | string | no | The unique identifier of the user, who is requesting the quote. |
| symbols | string | yes | The ticker symbol of the associated instrument. |

### Retrieve Depth of Book
`POST https://www.apizie.tech/v1/finance:drivewealth/depth-of-book-get-debt-depth` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | yes | JSON request body |

### List Cashless Reconciliations
`GET https://www.apizie.tech/v1/finance:drivewealth/settlements-get-daily-reconciliations` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| to | string | yes | The date and time in which to end at. |
| from | string | yes | The date and time in which to start from. |
| type | string | no | Filters the reconciliations reports by the type of reconciliation. |
| status | string | no | Filters the reconciliations reports by the status of reconciliation. |

### Retrieve Cashless Reconciliation
`GET https://www.apizie.tech/v1/finance:drivewealth/settlements-get-cashless-reconciliation` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| reconciliationID | string | yes | The unique identifier of the reconciliation report. |

### Update Cashless Reconciliation
`POST https://www.apizie.tech/v1/finance:drivewealth/settlements-update-cashless-reconciliation` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| reconciliationID | string | yes | The unique identifier of the reconciliation report. |
| body | object | no | JSON request body |

### Retrieve Recurring Deposits
`GET https://www.apizie.tech/v1/finance:drivewealth/deposits-get-schedule-by-recurring-id` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| recurringID | string | yes | A unique identifier for the user's recurring bank deposit. |

### Update Recurring Deposit
`POST https://www.apizie.tech/v1/finance:drivewealth/deposits-update-recurring-deposit` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| recurringID | string | yes | A unique identifier for the user's recurring bank deposit. |
| body | object | no | JSON request body |

### Delete Recurring Deposit
`POST https://www.apizie.tech/v1/finance:drivewealth/deposits-inactivate-recurring` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| recurringID | string | yes | A unique identifier for the user's recurring bank deposit. |

### List Withdrawals
`GET https://www.apizie.tech/v1/finance:drivewealth/withdrawals-get-all` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| status | string | yes | The current status of the withdrawal; to filter by. |
| type | string | yes | The type of withdrawal; to filter by. |

### Create Withdrawal
`POST https://www.apizie.tech/v1/finance:drivewealth/withdrawals-create-user-withdrawal` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | no | JSON request body |

### Retrieve Withdrawal
`GET https://www.apizie.tech/v1/finance:drivewealth/withdrawals-get-by-redemption-id` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| redemptionID | string | yes | A unique identifier for the user's account redemption/withdrawal. |

### List Bulk Settlements
`GET https://www.apizie.tech/v1/finance:drivewealth/settlements-list-bulk-settlements` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| from | string | yes | The date and time in which to start from. |
| to | string | yes | The date and time in which to end at. |
| category | string | no | Filters the settlements by the category of the settlement. |

### Retrieve Bulk Settlement
`GET https://www.apizie.tech/v1/finance:drivewealth/settlements-get-bulk-settlement-by-settlement-id` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| settlementID | string | yes | The unique identifier that identifies the settlement report. |

### Update Bulk Settlement
`POST https://www.apizie.tech/v1/finance:drivewealth/settlements-update-bulk-settlement-by-settlement-id` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| settlementID | string | yes | The unique identifier that identifies the settlement report. |
| body | object | no | JSON request body |

### List DVP RVP Reports
`GET https://www.apizie.tech/v1/finance:drivewealth/settlements-list-dvp-rvp-reports` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| accountID | string | yes | The user's unique account identifier. |
| status | string | no | A filter, to filter on the status of the DVP/RVP. |
| from | string | yes | A filter, the start date. |
| to | string | yes | A filter, the end date. |

### Create DVP RVP Report
`POST https://www.apizie.tech/v1/finance:drivewealth/settlements-create-dvp-rvp-report-job` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| accountID | string | yes | The user's unique account identifier. |
| body | object | no | JSON request body |

### Retrieve DVP RVP
`GET https://www.apizie.tech/v1/finance:drivewealth/settlements-get-dvp-rvp-by-report-id` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| accountID | string | yes | The user's unique account identifier. |
| reportID | string | yes | The DVP/RVP report identifier. |

### Retrieve Document URL by Account and FileKey
`GET https://www.apizie.tech/v1/finance:drivewealth/statements-get-document-url-by-account-and-file-key` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| accountID | string | yes | The user's unique account identifier. |
| fileKey | string | yes | A unique identifier for the specific account document. |

### Create Subscription
`POST https://www.apizie.tech/v1/finance:drivewealth/subscriptions-create-charge` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | no | JSON request body |

### Delete Subscription
`POST https://www.apizie.tech/v1/finance:drivewealth/subscriptions-remove-by-subscription` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| subscriptionID | string | yes | The unique identifier that identifies the user's subscription. |

### Create User
`POST https://www.apizie.tech/v1/finance:drivewealth/users-create-profile` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | no | JSON request body |

### Retrieve User
`GET https://www.apizie.tech/v1/finance:drivewealth/users-get-profile` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| userID | string | yes | Unique ID of the User to fetch. |

### Update User
`POST https://www.apizie.tech/v1/finance:drivewealth/users-update-profile` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| userID | string | yes | Unique ID of the User to update. |
| body | object | no | JSON request body |

### Retrieve KYC by User
`GET https://www.apizie.tech/v1/finance:drivewealth/users-get-kyc-by-user` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| userID | string | yes | Unique ID of the User to fetch their profile & kyc status. |

### List Accounts by User
`GET https://www.apizie.tech/v1/finance:drivewealth/accounts-list-by-user` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| userID | string | yes | Unique ID of the User to fetch their accounts at DriveWealth. |

### List Linked Bank Accounts by User
`GET https://www.apizie.tech/v1/finance:drivewealth/linked-bank-accounts-list-by-user` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| userID | string | yes | Unique ID of the User to fetch their stored bank accounts. |

### List Physical Documents by User
`GET https://www.apizie.tech/v1/finance:drivewealth/physical-documents-list-by-user` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| userID | string | yes | The User's unique identifier. |

### List Subscriptions by User
`GET https://www.apizie.tech/v1/finance:drivewealth/subscriptions-list-by-user` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| userID | string | yes | The User's unique identifier. |

### List Recurring Deposits by User
`GET https://www.apizie.tech/v1/finance:drivewealth/deposits-get-user-recurring` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| userID | string | yes | The User's unique identifier. |

### List Deposits by User
`GET https://www.apizie.tech/v1/finance:drivewealth/deposits-list-by-user` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| userID | string | yes | The User's unique identifier. |

### List Withdrawals by User
`GET https://www.apizie.tech/v1/finance:drivewealth/withdrawals-get-user-redemptions` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| userID | string | yes | The User's unique identifier. |

### List Trade Allocations by Advisor
`GET https://www.apizie.tech/v1/finance:drivewealth/trade-allocations-list-by-advisor` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| userID | string | yes | The User's unique identifier. |

### List Orders by Advisor
`GET https://www.apizie.tech/v1/finance:drivewealth/advisor-reports-get-user-orders-summary` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| userID | string | yes | The User's unique identifier. |
| date | string | no | The specific request date in format YYYY-MM-DD. |

### List Allocations by Advisor
`GET https://www.apizie.tech/v1/finance:drivewealth/advisor-reports-list-allocations-by-user-id` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| userID | string | yes | The User's unique identifier. |
| from | string | yes | The date and time in which to start from. |
| to | string | yes | The date and time in which to end at. |

### Retrieve Beginning Of Day (BOD) by Advisor
`GET https://www.apizie.tech/v1/finance:drivewealth/advisor-reports-get-beginning-of-day-holdings-by-user-id` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| userID | string | yes | The User's unique identifier. |

### List Funds by Advisor
`GET https://www.apizie.tech/v1/finance:drivewealth/funds-list-by-advisor` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| userID | string | yes | The User's unique identifier. |

### List Portfolios by Advisor
`GET https://www.apizie.tech/v1/finance:drivewealth/portfolios-list-by-advisor` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| userID | string | yes | The User's unique identifier. |

### List AutoPilot Runs by Advisor
`GET https://www.apizie.tech/v1/finance:drivewealth/auto-pilot-list-by-advisor` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| userID | string | yes | The User's unique identifier. |
| from | string | no | The date and time in which to start from. |
| to | string | no | The date and time in which to end at. |
| direction | string | no |  |
| offset | string | no |  |

## Example
```
curl "https://www.apizie.tech/v1/finance:drivewealth/trade-allocations-create-allocation" \
  -H "x-api-key: $APIZIE_KEY" \
  -H "x-upstream-key: $PROVIDER_KEY"
```

## FAQ

### How do I call the DriveWealth API API?
Create a free Apizie key, then send POST https://www.apizie.tech/v1/finance:drivewealth/trade-allocations-create-allocation with the header x-api-key. Every endpoint returns { project, data, timestamp }.

### Is the DriveWealth API API free on Apizie?
Yes. The Free plan includes 1,000 requests a month at 100 requests a minute, no credit card. DriveWealth API itself also needs your own key from bo-api.drivewealth.io.

### Can AI agents use the DriveWealth API API?
Yes. Add the Apizie MCP server (https://www.apizie.tech/mcp) to Claude, ChatGPT, Cursor or VS Code, then ask in plain language. The agent calls run_scraper with project key finance:drivewealth.

### What is the status of the DriveWealth API API?
Needs your own provider key (bring your own key)