postman.capital-iom.com Open in urlscan Pro
52.20.67.173  Public Scan

Form analysis
0 forms found in the DOM

Text Content

Public


Documentation Settings

ENVIRONMENT
Capital Reporting API

LAYOUT
Double Column

LANGUAGE
cURL - cURL



Capital Reporting API
Introduction
Authentication
Portfolios
Holdings
Trades
Transactions
Dividends


CAPITAL REPORTING API

The Capital Reporting API web service allow clients to request a feed of data
from Capital International. The data currently available is:

   

 * Portfolios

   

 * Holdings

   

 * Transactions

   

 * Dividends

   

 * Trades

   

This service is available at any point throughout the day. All data is returned
as JSON unless otherwise specified.


GETTING STARTED

   

 * Contact us to request access to the API, providing fixed, public IP
   address(es) the requests will originate from

   

 * An account will be set up that will be restricted to the pre-set fixed IP
   address(es)

   

 * Your authentication token will be securely provided to you

   

 * You can start querying the service

   


AUTHENTICATION

REST & V4

The original REST and the v4 versions of the API use a custom CLIENT_KEY header
and IP address restrictions. Provide your static bearer token in this header in
every request:

text


CLIENT_KEY: YOUR_TOKEN_HERE

V5

Version 5 of the API has switched to using the standard Authorization header to
handle the bearer token, as well as IP address restrictions. Provide your static
bearer token in the standard Authorization header as so:

text


Authorization: Bearer YOUR_TOKEN_HERE


RATE AND USAGE LIMITS

API calls are subject to fair use rate limits.

When rate limited, the API will respond with a 429 Too Many Requests response.


STATUS, MAINTENANCE & DOWNTIME

While maintenance and releases are generally performed with zero downtime,
should we need to make the service unavailable this will be announced on our
StatusPage, where you can subscribe for updates.

During periods of unavailabilty the service will respond with a 503 Service
Temporarily Unavailable response.

We endeavour to provide at least 1 weeks notice of downtime.


PAGINATION & LIMITING

Starting with v5 large result sets are paginated to improve API performance,
reduce system load and to make the responses more manageable.

The maximum limit of rows per page, however, should allow you to fetch daily and
intra-day data within a single page requiring pagination only when fetching
large batches of historical data, such as spanning multiple days or weeks.

Parameter Description Example page The page number to fetch ?page=1 limit The
number of rows to fetch per page ?limit=500


VERSIONS

Endpoints are versioned using a prefix in the URL to retain backwards
compatability, with older versions being deprecated before being removed.

For example:

text


https://live-api.capital-iom.com/v5/holdings

VERSION HISTORY

Version Status REST Deprecated v4 Deprecated v5 Active


DATA UPDATE SCHEDULE

The underlying data feeding the Reporting API is updated in the following
schedule:

Source Days Available By Frequency Portfolios Monday - Friday 06:00 to 19:00
Hourly Holdings Monday - Friday 06:30 Once Transactions Monday - Friday 06:30
Once Dividends Monday - Friday 06:30 Once Trades Monday - Friday 06:00 to 19:00
Every 10 minutes

Note: All times are UK local and follow DST (GMT or BST, depending on time of
year).