{"activeVersionTag":"latest","latestAvailableVersionTag":"latest","collection":{"info":{"_postman_id":"94cf7ace-02e5-46bd-9ceb-c3d5fc1eb030","name":"Foresight","description":"Foresight REST API allows you to access and manipulate data on Foresight end.\n\n**API is under development and new features will be added over time.**\n\n# Overview\n\nAvailable version: [https://foresight-api.bigtime.net/beta/](https://foresight-api.bigtime.net/beta/)\n\n# Authentication\n\nApi use OAuth2.0 authorization. You must authorize Application in order to use API.\n\nOnly the \"client credentials\" grant type is available.\n\nToken endpoint:  \n[https://foresight-api.bigtime.net/auth/token/](https://foresight-api.bigtime.net/auth/token/)\n\nTo learn about OAuth2 you can read one of\n\n<a href=\"https://www.google.com/search?q=oauth2+tutorial\">many</a>\n\ntutorials on the internet.\n\n### Scopes\n\n- read - read scope\n    \n- write - write scope\n    \n- finance - finance data access\n    \n\n# Pagination\n\nEvery endpoint which return list is paginated.  \nPage size is set to 50 items.\n\nsample paginated response\n\n``` json\n{\n    \"paging\": {\n        \"page\": 1,\n        \"pageSize\": 50,\n        \"totalResults\": 150\n    },\n    \"items\": [...]\n}\n\n ```\n\n**totalResults** - total items count\n\n**pageSize** - max number of objects in one page\n\n**page** - page numeber\n\n**items** - array of returned objects\n\n# Additional Notes\n\nPlease be aware that all requests should end with a slash \"/\"\n\n# Rate limits\n\n60 requests/minute\n\nException Code 429 if exceeded\n\n# BigTime Related\n\n## Fetch related Header\n\nTo ensure that BigTime dependencies are properly handled in requests, you must set the `X-Enable-Synchronous-Related-Fetch` header to True. If this header is missing, the dependency might not yet be available in the system. Enabling this header allows the system to wait for or pull the necessary dependency from BigTime, ensuring smooth and accurate processing of the request.  \nBigTime related data is fetched based on the SID field. If the SID does not exist or if the request times out (with a timeout period of 30 seconds), an error 424 will occur.\n\n## SID and UUID usage\n\nWe allow the use of both SID (BigTime related field identifier) and UUID for identification purposes. In many URLs, you can use either an SID or a UUID in a single field, providing flexibility in how resources are accessed. Fields are described as `entity_name_sid_or_uuid`.  \nIn the case of POST and PATCH requests, it is important to note that you cannot include both SID and UUID simultaneously, as these requests typically require only one form of identifier to avoid conflicts and ensure data integrity.\n\n### Exceptions\n\n- **400 Bad Request:** This error occurs when the request is malformed or contains invalid parameters. Ensure all required fields are correctly provided and properly formatted.\n    \n- **404 Not Found:** This error indicates that the requested resource could not be found. Verify the URL and ensure the resource exists.\n    \n- **424 Failed Dependency:** This error is triggered when the SID does not exist or if there is a timeout in fetching the necessary data from BigTime. Ensure the SID is valid and retry if the error persists.\n    \n- **429 Too Many Requests:** This error occurs when too many requests are sent in a given amount of time, exceeding the rate limit. To resolve this, reduce the frequency of requests and try again later. Current Rate Limits: 60 requests/minute","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","isPublicCollection":false,"owner":"10359207","team":702134,"collectionId":"94cf7ace-02e5-46bd-9ceb-c3d5fc1eb030","publishedId":"2sA2xfYYxC","public":true,"publicUrl":"https://developer.foresight.bigtime.net","privateUrl":"https://go.postman.co/documentation/10359207-94cf7ace-02e5-46bd-9ceb-c3d5fc1eb030","customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"},"documentationLayout":"classic-double-column","customisation":{"metaTags":[{"name":"description","value":""},{"name":"title","value":""}],"appearance":{"default":"light","themes":[{"name":"dark","logo":"https://content.pstmn.io/e278d4c4-5171-4ca7-ac78-8bd5f1e35641/QmlnVGltZVJNLUxvZ28tR3JheVNjYWxlX1doaXRlX05vQ2xlYXJTcGFjZS5wbmc=","colors":{"top-bar":"212121","right-sidebar":"303030","highlight":"FF6C37"}},{"name":"light","logo":"https://content.pstmn.io/2dfa0c92-e793-45ea-bf98-74d820c655ae/QmlnVGltZVJNLUxvZ28tRnVsbENvbG9yX05vQ2xlYXJTcGFjZS5wbmc=","colors":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"}}]}},"version":"8.11.4","publishDate":"2025-08-14T14:37:58.000Z","activeVersionTag":"latest","documentationTheme":"light","metaTags":{"title":"","description":""},"logos":{"logoLight":"https://content.pstmn.io/2dfa0c92-e793-45ea-bf98-74d820c655ae/QmlnVGltZVJNLUxvZ28tRnVsbENvbG9yX05vQ2xlYXJTcGFjZS5wbmc=","logoDark":"https://content.pstmn.io/e278d4c4-5171-4ca7-ac78-8bd5f1e35641/QmlnVGltZVJNLUxvZ28tR3JheVNjYWxlX1doaXRlX05vQ2xlYXJTcGFjZS5wbmc="}},"statusCode":200},"environments":[],"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/1dcdb3af0091502a8d1590a793777bf35fe0ef3f702ebc69f98728be40eb3f42","favicon":"https://bigtime.net/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"}],"canonicalUrl":"https://developer.foresight.bigtime.net/view/metadata/2sA2xfYYxC"}