Connect API - Overview

Our Connect API works
with OAuth 1.0a

The Sharesight Connect API allows you to integrate your own solution with Sharesight's online portfolio management software. It provides a secure electronic mechanism to read ¹ and write data to a portfolio (with permission from the portfolio owner).

Example usage of the Sharesight Connect includes:

Trading platforms: Offer clients a portfolio management solution by populating trade data directly into Sharesight portfolios for your clients.
Accountants / Accounting platforms: Use the Sharesight Connect to synchronise your clients share trading information from Sharesight into your accounting solution.

Sharesight Connect is available over HTTPS. Simple XML and JSON formats are used for communication via the API. We take a RESTful approach employing simple HTTP GET and HTTP POST methods for requesting or sending data.

Sharesight Connect uses the open authentication standard OAuth 1.0a for authentication. This protocol allows third parties to authenticate with a Sharesight portfolio, without users needing to divulge their passwords outside of Sharesight. To learn more about OAuth, we recommend reading The OAuth 1.0 Guide, provided by Hueniverse.

When you register for Sharesight Connect access, Sharesight will provision you with a consumer key and a consumer secret.

Documentation Content

Introduction: Provides basic information and an overview of the Sharesight Use API.
Configuring OAuth: Lists OAuth credentials and endpoints.
Authentication Flow: Shows how to obtain, use and refresh access tokens.
Connect API Endpoints: Lists and describes all endpoints (API reference).

Transaction Logging

Detailed transaction logging is provided. This can prove useful for debugging purposes during the initial setup.

To access this page, log into your Sharesight account and click the settings link (in the top right) and then click on the API tab. The Show Transactions button provides a log of all Sharesight Connect transactions between Sharesight and your organisation. The complete XML/JSON request and response is logged for each transaction, this can be shown by clicking on the Show details link.

^{1. API read (GET request) access is only available where the portfolio
owner is a paying Sharesight subscriber. API read access is not
available for portfolios where the owner is on a free plan, or where
their portfolio subscription has expired.}