{"activeVersionTag":"latest","latestAvailableVersionTag":"latest","collection":{"info":{"_postman_id":"8959ed9a-8f67-4635-a1ed-86c7306378e2","name":"Octo Browser API","description":"# General information\n\n### Get API Token\n\n\n\n### Swagger schemas can be found [here
](https://swagger.octobrowser.net/)\n\n### Alternative API endpoints\n\nYou can use alternative API endpoints if you're provider is blocking recommended one\n\n`https://app.octobrowser-mirror1.com` \n`https://app.octobrowser-mirror1.net` \n`https://app.octobrowser-mirror1.org`\n\n### Rate Limits and 429 errors.\n\nPlease check status codes for 429 code: different teams have different limits that depend on subscription level. All limits are shared within the **team.**\n\nIf you need higher limits, you can upgrade your subscription to a higher level.\n\nIf you need higher limits than those available with the **Advanced** subscription, please contact our Technical Support.\n\nIf you get code 429, **stop all requests and pause** for `retry-after` (from headers) seconds.\n\nNot respecting or ignoring 429 responses may result in us enforcing stricter API limits for your team.\n\nYou can also check remaining requests and rate limit reset time by inspecting appropriate headers.\n\nCertain API requests may involve more complex processing and, as a result, may cost more than one request point from the RPM (Requests Per Minute) or RPH (Requests Per Hour) limits for their execution. This serves to ensure fair usage and optimal performance for all users.\n\n``` bash\nRetry-After: 0 # if 0, you can send the next request\nX-Ratelimit-Limit: 200 # RPM (requests per minute) limit\nX-Ratelimit-Limit-Hour: 3000 # RPH (requests per hour) limit\nX-Ratelimit-Remaining: 4 # remaining RPM\nX-Ratelimit-Remaining-Hour: 2999 # remaining RPH\nX-Ratelimit-Reset: 1671789217 # unix timestamp\n\n ```\n\n#### Current limits for subscription plans\n\n| **Plan** | **RPM** | **RPH** |\n| --- | --- | --- |\n| Base | 50 | 500 |\n| Team | 100 | 1500 |\n| Advanced | 200, expandable up to 1,000 | 3,000, expandable up to 50,000 |\n\nIf you require limits exceeding 1,000 RPM and 50,000 RPH, please contact our Support.\n\n#### One-time profiles\n\nOcto has support for **one-time profiles** that:\n\n- have faster creation/start time\n \n- are removed and not synchronized; they are faster to stop and don't clutter the profile list\n \n- are suitable for certain workloads, such as scraping tasks.\n \n\nOne request POST One-time profile is counted as 4 requests when calculating RPM/RPH limits.\n\n### **How to run Octo Browser client in the \"headless\" mode:**\n\n**Linux**\n\n- open the Terminal in the folder where _OctoBrowser.AppImage_ is located\n \n- run the command OCTO_HEADLESS=1 ./OctoBrowser.AppImage\n \n\n**Windows**\n\n- open powershell terminal\n \n- run the command $env:OCTO_HEADLESS = \"1\"; start 'C:\\\\Program Files\\\\Octo Browser\\\\Octo Browser.exe'\n \n\n**macOS**\n\n- open the Terminal\n \n- run the command - OCTO_HEADLESS=1 open -a \"Octo Browser\"\n \n\n### Silent installation\n\n**Windows**\n\nTo perform a \"silent\" Octo Browser installation using the terminal, run the .exe installer with the \"qn\" flag. \nExample for Powershell:\n\n``` powershell\n& '.\\Octo_Browser_latest_win.exe' /qn\n\n ```\n\n**macOS**\n\n``` bash\nhdiutil attach ./Octo_Browser_latest_mac_arm64.dmg\ncp -R /Volumes/Octo\\ Browser/Octo\\ Browser.app /Applications\nhdiutil unmount /Volumes/Octo\\ BrowserEndFragment\n\n ```","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","isPublicCollection":false,"owner":"1801428","team":2761046,"collectionId":"8959ed9a-8f67-4635-a1ed-86c7306378e2","publishedId":"UVC6i6eA","public":true,"publicUrl":"https://documenter-api.postman.tech/view/1801428/UVC6i6eA","privateUrl":"https://go.postman.co/documentation/1801428-8959ed9a-8f67-4635-a1ed-86c7306378e2","customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"EF5B25"},"documentationLayout":"classic-double-column","customisation":null,"version":"8.10.1","publishDate":"2022-11-01T15:21:36.000Z","activeVersionTag":"latest","documentationTheme":"light","metaTags":{},"logos":{}},"statusCode":200},"environments":[{"name":"production","id":"26821578-cecd-4f78-90d1-4dfb2d04c447","owner":"1801428","values":[{"key":"API_TOKEN","value":"","enabled":true},{"key":"PROFILE_UUID","value":"","enabled":true},{"key":"TAG_UUID","value":"","enabled":true},{"key":"PROXY_UUID","value":"","enabled":true},{"key":"baseUrl","value":"https://app.octobrowser.net","enabled":true},{"key":"localUrl","value":"http://localhost:58888","enabled":true}],"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/94ad277c7d8d1b9f2125e6c5df87272bfbc16e513ad405f700c552f8eb232215","favicon":"https://res.cloudinary.com/postman/image/upload/v1638367187/team/hk2byz7jqqkyzev8b0ot.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":"production","value":"1801428-26821578-cecd-4f78-90d1-4dfb2d04c447"}],"canonicalUrl":"https://documenter.gw.postman.com/view/metadata/UVC6i6eA"}