{"activeVersionTag":"latest","latestAvailableVersionTag":"latest","collection":{"info":{"_postman_id":"1232b301-09ba-452c-99b8-0fe9b384bf36","name":"Capital Reporting API","description":"The Capital Reporting API web service allow clients to request a feed of data from Capital International. The data currently available is:\n\n- Portfolios\n    \n- Holdings\n    \n- Transactions\n    \n- Dividends\n    \n- Trades\n    \n\nThis service is available at any point throughout the day. All data is returned as JSON unless otherwise specified.\n\n## Getting started\n\n1. Contact us to request access to the API, providing fixed, public IP address(es) the requests will originate from\n    \n2. An account will be set up that will be restricted to the pre-set fixed IP address(es)\n    \n3. Your authentication token will be securely provided to you\n    \n4. You can start querying the service\n    \n\n## Authentication\n\n#### REST & v4\n\nThe 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:\n\n``` text\nCLIENT_KEY: YOUR_TOKEN_HERE\n\n ```\n\n#### v5\n\nVersion 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:\n\n``` text\nAuthorization: Bearer YOUR_TOKEN_HERE\n\n ```\n\n## Rate and usage limits\n\nAPI calls are subject to fair use rate limits.\n\nWhen rate limited, the API will respond with a `429 Too Many Requests` response.\n\n## Status, maintenance & downtime\n\nWhile maintenance and releases are generally performed with zero downtime, should we need to make the service unavailable this will be announced on our [StatusPage](https://platform-status.capital-iom.com/), where you can subscribe for updates.\n\nDuring periods of unavailabilty the service will respond with a `503 Service Temporarily Unavailable` response.\n\nWe endeavour to provide at least 1 weeks notice of downtime.\n\n## Pagination & limiting\n\nStarting with v5 large result sets are paginated to improve API performance, reduce system load and to make the responses more manageable.\n\nThe 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.\n\n| **Parameter** | **Description** | **Example** |\n| --- | --- | --- |\n| `page` | The page number to fetch | `?page=1` |\n| `limit` | The number of rows to fetch per page | `?limit=500` |\n\n## Versions\n\nEndpoints are versioned using a prefix in the URL to retain backwards compatability, with older versions being deprecated before being removed.\n\nFor example:\n\n``` text\nhttps://live-api.capital-iom.com/v5/holdings\n\n ```\n\n#### Version history\n\n| **Version** | **Status** |\n| --- | --- |\n| REST | Deprecated |\n| v4 | Deprecated |\n| v5 | Active |\n\n## Data update schedule\n\nThe underlying data feeding the Reporting API is updated in the following schedule:\n\n| **Source** | **Days** | **Available By** | **Frequency** |\n| --- | --- | --- | --- |\n| Portfolios | Monday - Friday | 06:00 to 19:00 | Hourly |\n| Holdings | Monday - Friday | 06:30 | Once |\n| Transactions | Monday - Friday | 06:30 | Once |\n| Transactions (Intra) | Monday - Friday | 06:00 - 22:00 | Every 10 minutes |\n| Dividends | Monday - Friday | 06:30 | Once |\n| Trades | Monday - Friday | 06:00 to 19:00 | Every 10 minutes |\n\nNote: All times are UK local and follow DST (GMT or BST, depending on time of year).","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","isPublicCollection":false,"owner":"39481545","team":5794705,"collectionId":"1232b301-09ba-452c-99b8-0fe9b384bf36","publishedId":"2sAYBVhWtM","public":true,"publicUrl":"https://postman.capital-iom.com","privateUrl":"https://go.postman.co/documentation/39481545-1232b301-09ba-452c-99b8-0fe9b384bf36","customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"BB8B41"},"documentationLayout":"classic-double-column","customisation":{"metaTags":[{"name":"description","value":""},{"name":"title","value":""}],"appearance":{"default":"light","themes":[{"name":"dark","logo":null,"colors":{"top-bar":"212121","right-sidebar":"303030","highlight":"BB8B41"}},{"name":"light","logo":null,"colors":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"BB8B41"}}]}},"version":"8.10.1","publishDate":"2024-11-26T12:25:19.000Z","activeVersionTag":"latest","documentationTheme":"light","metaTags":{"title":"","description":""},"logos":{"logoLight":null,"logoDark":null}},"statusCode":200},"environments":[{"name":"Capital Reporting API","id":"6a7b000d-2563-4a11-83fb-6da7aa005fba","owner":"31144979","values":[{"key":"capital_api_host","value":"https://live-api.capital-iom.com","enabled":true,"type":"default"},{"key":"capital_api_bearer_token","value":"YOUR TOKEN HERE","enabled":true,"type":"default"}],"published":true}],"user":{"authenticated":false,"permissions":{"publish":false}},"run":{"button":{"js":"https://run.pstmn.io/button.js","css":"https://run.pstmn.io/button.css"}},"web":"https://www.getpostman.com/","team":{"logo":"https://res.cloudinary.com/postman/image/upload/t_team_logo_pubdoc/v1/team/5d6984077d274912e6fd632382c571f4db8736cc02c98bb8f9ba39e48df56acb","favicon":"https://capital-iom.com/favicon.ico"},"isEnvFetchError":false,"languages":"[{\"key\":\"csharp\",\"label\":\"C#\",\"variant\":\"HttpClient\"},{\"key\":\"csharp\",\"label\":\"C#\",\"variant\":\"RestSharp\"},{\"key\":\"curl\",\"label\":\"cURL\",\"variant\":\"cURL\"},{\"key\":\"dart\",\"label\":\"Dart\",\"variant\":\"http\"},{\"key\":\"go\",\"label\":\"Go\",\"variant\":\"Native\"},{\"key\":\"http\",\"label\":\"HTTP\",\"variant\":\"HTTP\"},{\"key\":\"java\",\"label\":\"Java\",\"variant\":\"OkHttp\"},{\"key\":\"java\",\"label\":\"Java\",\"variant\":\"Unirest\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"Fetch\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"jQuery\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"XHR\"},{\"key\":\"c\",\"label\":\"C\",\"variant\":\"libcurl\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Axios\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Native\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Request\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Unirest\"},{\"key\":\"objective-c\",\"label\":\"Objective-C\",\"variant\":\"NSURLSession\"},{\"key\":\"ocaml\",\"label\":\"OCaml\",\"variant\":\"Cohttp\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"cURL\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"Guzzle\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"HTTP_Request2\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"pecl_http\"},{\"key\":\"powershell\",\"label\":\"PowerShell\",\"variant\":\"RestMethod\"},{\"key\":\"python\",\"label\":\"Python\",\"variant\":\"http.client\"},{\"key\":\"python\",\"label\":\"Python\",\"variant\":\"Requests\"},{\"key\":\"r\",\"label\":\"R\",\"variant\":\"httr\"},{\"key\":\"r\",\"label\":\"R\",\"variant\":\"RCurl\"},{\"key\":\"ruby\",\"label\":\"Ruby\",\"variant\":\"Net::HTTP\"},{\"key\":\"shell\",\"label\":\"Shell\",\"variant\":\"Httpie\"},{\"key\":\"shell\",\"label\":\"Shell\",\"variant\":\"wget\"},{\"key\":\"swift\",\"label\":\"Swift\",\"variant\":\"URLSession\"}]","languageSettings":[{"key":"csharp","label":"C#","variant":"HttpClient"},{"key":"csharp","label":"C#","variant":"RestSharp"},{"key":"curl","label":"cURL","variant":"cURL"},{"key":"dart","label":"Dart","variant":"http"},{"key":"go","label":"Go","variant":"Native"},{"key":"http","label":"HTTP","variant":"HTTP"},{"key":"java","label":"Java","variant":"OkHttp"},{"key":"java","label":"Java","variant":"Unirest"},{"key":"javascript","label":"JavaScript","variant":"Fetch"},{"key":"javascript","label":"JavaScript","variant":"jQuery"},{"key":"javascript","label":"JavaScript","variant":"XHR"},{"key":"c","label":"C","variant":"libcurl"},{"key":"nodejs","label":"NodeJs","variant":"Axios"},{"key":"nodejs","label":"NodeJs","variant":"Native"},{"key":"nodejs","label":"NodeJs","variant":"Request"},{"key":"nodejs","label":"NodeJs","variant":"Unirest"},{"key":"objective-c","label":"Objective-C","variant":"NSURLSession"},{"key":"ocaml","label":"OCaml","variant":"Cohttp"},{"key":"php","label":"PHP","variant":"cURL"},{"key":"php","label":"PHP","variant":"Guzzle"},{"key":"php","label":"PHP","variant":"HTTP_Request2"},{"key":"php","label":"PHP","variant":"pecl_http"},{"key":"powershell","label":"PowerShell","variant":"RestMethod"},{"key":"python","label":"Python","variant":"http.client"},{"key":"python","label":"Python","variant":"Requests"},{"key":"r","label":"R","variant":"httr"},{"key":"r","label":"R","variant":"RCurl"},{"key":"ruby","label":"Ruby","variant":"Net::HTTP"},{"key":"shell","label":"Shell","variant":"Httpie"},{"key":"shell","label":"Shell","variant":"wget"},{"key":"swift","label":"Swift","variant":"URLSession"}],"languageOptions":[{"label":"C# - HttpClient","value":"csharp - HttpClient - C#"},{"label":"C# - RestSharp","value":"csharp - RestSharp - C#"},{"label":"cURL - cURL","value":"curl - cURL - cURL"},{"label":"Dart - http","value":"dart - http - Dart"},{"label":"Go - Native","value":"go - Native - Go"},{"label":"HTTP - HTTP","value":"http - HTTP - HTTP"},{"label":"Java - OkHttp","value":"java - OkHttp - Java"},{"label":"Java - Unirest","value":"java - Unirest - Java"},{"label":"JavaScript - Fetch","value":"javascript - Fetch - JavaScript"},{"label":"JavaScript - jQuery","value":"javascript - jQuery - JavaScript"},{"label":"JavaScript - XHR","value":"javascript - XHR - JavaScript"},{"label":"C - libcurl","value":"c - libcurl - C"},{"label":"NodeJs - Axios","value":"nodejs - Axios - NodeJs"},{"label":"NodeJs - Native","value":"nodejs - Native - NodeJs"},{"label":"NodeJs - Request","value":"nodejs - Request - NodeJs"},{"label":"NodeJs - Unirest","value":"nodejs - Unirest - NodeJs"},{"label":"Objective-C - NSURLSession","value":"objective-c - NSURLSession - Objective-C"},{"label":"OCaml - Cohttp","value":"ocaml - Cohttp - OCaml"},{"label":"PHP - cURL","value":"php - cURL - PHP"},{"label":"PHP - Guzzle","value":"php - Guzzle - PHP"},{"label":"PHP - HTTP_Request2","value":"php - HTTP_Request2 - PHP"},{"label":"PHP - pecl_http","value":"php - pecl_http - PHP"},{"label":"PowerShell - RestMethod","value":"powershell - RestMethod - PowerShell"},{"label":"Python - http.client","value":"python - http.client - Python"},{"label":"Python - Requests","value":"python - Requests - Python"},{"label":"R - httr","value":"r - httr - R"},{"label":"R - RCurl","value":"r - RCurl - R"},{"label":"Ruby - Net::HTTP","value":"ruby - Net::HTTP - Ruby"},{"label":"Shell - Httpie","value":"shell - Httpie - Shell"},{"label":"Shell - wget","value":"shell - wget - Shell"},{"label":"Swift - URLSession","value":"swift - URLSession - Swift"}],"layoutOptions":[{"value":"classic-single-column","label":"Single Column"},{"value":"classic-double-column","label":"Double Column"}],"versionOptions":[],"environmentOptions":[{"value":"0","label":"No Environment"},{"label":"Capital Reporting API","value":"31144979-6a7b000d-2563-4a11-83fb-6da7aa005fba"}],"canonicalUrl":"https://postman.capital-iom.com/view/metadata/2sAYBVhWtM"}