{"templateId":"markdown","sharedDataIds":{"sidebar":"sidebar-sidebars.yaml"},"props":{"metadata":{"markdoc":{"tagList":[]},"type":"markdown"},"seo":{"title":"API Overview","llmstxt":{"hide":false,"sections":[{"title":"Table of contents","includeFiles":["**/*"],"excludeFiles":[]}],"excludeFiles":[]}},"dynamicMarkdocComponents":[],"compilationErrors":[],"ast":{"$$mdtype":"Tag","name":"article","attributes":{},"children":[{"$$mdtype":"Tag","name":"Heading","attributes":{"level":1,"id":"api-overview","__idx":0},"children":["API Overview"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Welcome to the MoreLogin API documentation. This section will help you integrate MoreLogin's core capabilities directly into your software."]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"overview","__idx":1},"children":["Overview"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Who is it for?"]}," ","Developers, software engineers, and automation engineers who want to build custom integrations, scripts, or backend services that programmatically control MoreLogin resources."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["What can it do?"]}," ","MoreLogin provides two types of APIs:"]},{"$$mdtype":"Tag","name":"ol","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Local API (",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["http://127.0.0.1:40000"]},")"]}]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Capabilities"]},": Automate anti-detection browser profiles directly on your local machine (create, start, stop, proxy management) AND manage local Cloud Phone instances."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Environment"]},": Runs locally alongside the MoreLogin desktop app (no internet required for API calls)."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Integration"]},": Supports Selenium, Puppeteer, Playwright."]}]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Open API (",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["https://api.MoreLogin.com"]},")"]}]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Capabilities"]},": Manage cloud phone instances remotely (create, control, install apps, transfer files)."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Environment"]},": Remote cloud API accessible from anywhere."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Integration"]},": Supports batch operations and OAuth2 authentication."]}]}]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["How to start?"]}]},{"$$mdtype":"Tag","name":"ol","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Read the ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/api-reference/getting-started/authentication"},"children":["Authentication Guide"]}," to get your credentials."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Follow the ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/api-reference/getting-started/quickstart"},"children":["Quickstart"]}," to make your first API call in 5 minutes."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Dive into the reference:",{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["→ ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/api-reference/browser"},"children":["Go to Browser API Reference (Local API)"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["→ ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/api-reference/cloud-phone"},"children":["Go to Cloud Phone API Reference (Open API)"]}]}]}]}]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"quick-links","__idx":2},"children":["Quick Links"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Topic"},"children":["Topic"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Description"},"children":["Description"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/api-reference/getting-started/authentication"},"children":["Authentication"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["How to authenticate with both Local API and Open API"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/api-reference/getting-started/quickstart"},"children":["Quickstart"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Run your first API call in 5 minutes"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/api-reference/getting-started/error-codes"},"children":["Error Codes"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Common error codes and troubleshooting"]}]}]}]}]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"requirements","__idx":3},"children":["Requirements"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Local API"]},": MoreLogin desktop app v2.15.0+ installed and running"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Open API"]},": API ID and API Key from MoreLogin dashboard"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Docker"]},": Docker Engine 20.10+ (for Docker deployment only)"]}]}]},"headings":[{"value":"API Overview","id":"api-overview","depth":1},{"value":"Overview","id":"overview","depth":2},{"value":"Quick Links","id":"quick-links","depth":2},{"value":"Requirements","id":"requirements","depth":2}],"frontmatter":{"seo":{"title":"API Overview"}},"lastModified":"2026-05-13T06:44:05.000Z","pagePropGetterError":{"message":"","name":""}},"slug":"/api-reference/getting-started","userData":{"isAuthenticated":false,"teams":["anonymous"]},"isPublic":true}