How to migrate from API v1 to v2?

Quick Shortcuts

• Introduction.
• Reference.
• Root Endpoint Changes.
• Resources Changes.
  • Accounts.
  • Custodians.
  • FxRates.
  • Positions.
  • Prices.
  • TaxLots.
  • Transactions.
  • Vehicles.

Introduction

In this article, we will delve into the intricacies of migrating from our API v1 to our enhanced API v2. We understand the challenges that may arise during this transition, and we aim to provide you with a clear roadmap to navigate the migration process seamlessly.

With API v2, we have introduced notable updates, including new endpoints, modified key structures, and updated values. This guide will equip you with the necessary knowledge and examples to effortlessly adapt to the changes, ensuring a smooth transition for your applications and services.

Understanding the Changes

To begin, we will outline the key differences between API v1 and API v2.

By highlighting the modified endpoints, updated keys, and transformed values, we aim to empower you to make the necessary mapping changes required to interface with our new API.

A Step-by-Step Migration Process

We understand the importance of a systematic approach to migration. Therefore, we will walk you through a comprehensive, step-by-step process to ensure a successful migration from API v1 to API v2. Each step will be accompanied by detailed examples, enabling you to grasp the nuances of the migration process.

1. Review the Endpoint Changes: We will provide you with a detailed overview of the modified endpoints in API v2. By understanding these changes, you can update your existing API calls accordingly.
2. Mapping Changes for Keys and Values: We will compare the key structures of API v1 and API v2, highlighting any modifications. This section will guide you through the necessary adjustments needed for a successful transition.
3. Testing and Fine-Tuning: Once you have made the necessary adjustments, we will guide you through the testing and fine-tuning phase. This will ensure that your newly migrated applications are functioning smoothly and without any issues.

Root Endpoint Changes

-    https://api.wealthtechs.com/v1/
+    https://api.wealthtechs.com/v2/odata/

Resources Changes

'https://api.wealthtechs.com/v2/odata/Accounts?&$expand=Currency($select=Alpha2Code)&$select=custodianID,Master,Number,Name,accountStatus,accountType,primaryContact,mailingAddress,MailingCity,MailingZipCode,MailingCountry,Email,phone,bussinesPhone,dateOpened'									

'https://api.wealthtechs.com/v2/odata/FxRates?&$expand=LocalCurrency($select=Alpha2Code)&$expand=BaseCurrency($select=Alpha2Code)&$select=Factor'									

'https://api.wealthtechs.com/v2/odata/Positions?$expand=Security($select=PrimarySymbol;$expand=SecurityType($select=Code)&$expand=Currency($select=Alpha2Code))&$expand=Account($select=Number)&$select=ShortPosition,ProcessDate,Quantity,MarketValue,OriginalCostDate,OriginalCost,OriginalFace'					

'https://api.wealthtechs.com/v2/odata/Prices?$expand=Security($select=PrimarySymbol;$expand=SecurityType($select=Code)&$expand=Currency($select=Alpha2Code))&$select=PriceValue'									

'https://api.wealthtechs.com/v2/odata/TaxLots?$expand=Security($select=PrimarySymbol;$expand=SecurityType($select=Code)&$expand=Currency($select=Alpha2Code))&$expand=Account($select=Number)&$select=ShortPosition,TradeDate,Quantity,Amount,OriginalCostDate,OriginalCost,OriginalFace'

'https://api.wealthtechs.com/v2/odata/Transactions?$expand=Security($select=PrimarySymbol;$expand=SecurityType($select=Code)&$expand=Currency($select=Alpha2Code))&$expand=Account($select=Number)&$expand=TransactionCode($select=Code)&$select=Comment,TradeDate,SettlementDate,Quantity,Sdtype,Sdsymbol,Amount,ExchangeFee,Commission,Broker,OtherFees,OriginalCostDate,OriginalCost,ExecPri,ExecPriCalc'									

🔀 Vehicles

Accessing Updated & Removed Keys with OData Protocol

'https://api.wealthtechs.com/v2/odata/Securities?$expand=SecurityType($select=Code)&$expand=Currency($select=Alpha2Code)&$expand=Sector($select=Name)&$select=Id,PrimarySymbol,Cusip,Sedol,Isin,Ticker,Description,Industry'