PHPackages splitbrain/remarkable-api - PHPackages - PHPackages [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register) 1. [Directory](/) 2. / 3. [API Development](/categories/api) 4. / 5. splitbrain/remarkable-api AbandonedArchivedLibrary[API Development](/categories/api) splitbrain/remarkable-api ========================= PHP Implementation of the reMarkable file API 42546825[13 issues](https://github.com/splitbrain/ReMarkableAPI/issues)PHP Since Apr 24Pushed 3y ago22 watchersCompare [ Source](https://github.com/splitbrain/ReMarkableAPI)[ Packagist](https://packagist.org/packages/splitbrain/remarkable-api)[ RSS](/packages/splitbrain-remarkable-api/feed)WikiDiscussions master Synced 5d ago READMEChangelogDependenciesVersions (1)Used By (0) reMarkable File Sync API ======================== [](#remarkable-file-sync-api) Goal of this project is to figure out and document the API which is used by the [reMarkable Paper Tablet](https://remarkable.com/) for syncing documents between the device, the desktop and mobile clients and the cloud service. A sample client implementation in PHP is also part of the project. The API allows you to exchange files with your reMarkable tablet without the need to be in the same network or have physical access to the device. This makes it possible to create your own cloud services. Eg. tools that periodically sync files to other services like Dropbox or you could add automatic export to reMarkable in your tools. API Documentation ----------------- [](#api-documentation) I did my best to document what I cold figure out about the reMarkable File Sync API in the wiki: [API Documentation](https://github.com/splitbrain/ReMarkableAPI/wiki) It should give you a good starting point when implementing your own client. You can also run the command line client in this repository (see below) with the `--loglevel debug` option to see the API calls in action. Please feel free to extend and improve the documentation. PHP API Client Library ---------------------- [](#php-api-client-library) This repository implements a PHP client to talk to the reMarkable file API. To use it in your projects, install via [composer](https://getcomposer.org/) (currently only `dev-master` is available, versioning will be introduced later). ``` composer require splitbrain/remarkable-api ``` The library consists of three classes: - `splitbrain\ReMarkableAPI\ReMarkableAPI` - this the main API interface, implementing the calls as described in the [wiki](https://github.com/splitbrain/ReMarkableAPI/wiki) - `splitbrain\ReMarkableAPI\ReMarkableFS` - the reMarkable stores all info in a flat hierarchy with documents identified by UUIDs only. This class makes the items accessible by path names (using `/` as a directory separator) - `splitbrain\ReMarkableAPI\Client` - this is just a thin wrapper around the Guzzle HTTP client which adds logging and handles authentication After instantiating the `ReMarkableAPI` object, you need to call either `register()` or `init()` on it before you can issue any of the other calls. The first call will register your client through a [8 char code](https://my.remarkable.com/device/connect/desktop/) and return an API token. You need to save that token somewhere and pass it to `init()` for subsequent calls. Have a look at the command line client in `remarkable.php` to see how to use it all. Command Line Client ------------------- [](#command-line-client) To demonstrate the use of the PHP client library a command line script is included in the project. To use it, clone this project, then initialize the dependencies with [composer](https://getcomposer.org/): ``` composer install ``` Run the following to get a help screen on the usage: ``` ./remarkable.php -h ``` Currently the following commands are implemented: - `register` - register this application as a new device - `list` - list all available files - `delete` - delete a folder or document - `mkdir` - create new folders - `upload` - upload a new PDF - `download` - download a Document ### Health Score 25 — LowBetter than 37% of packages Maintenance19 Infrequent updates — may be unmaintained Popularity34 Limited adoption so far Community23 Small or concentrated contributor base Maturity22 Early-stage or recently created project Bus Factor1 Top contributor holds 80.5% of commits — single point of failure How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window. **Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores. **Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement. **Maturity (30%)** — Project age, version count, PHP version support, and release stability. ### Community Maintainers ![](https://www.gravatar.com/avatar/2851a48718937a41d7cc7ea185ec0ad95f3d5e4892e1693ed4f19b08a3f1e4ca?d=identicon)[splitbrain](/maintainers/splitbrain) --- Top Contributors [![splitbrain](https://avatars.githubusercontent.com/u/86426?v=4)](https://github.com/splitbrain "splitbrain (33 commits)")[![dependabot[bot]](https://avatars.githubusercontent.com/in/29110?v=4)](https://github.com/dependabot[bot] "dependabot[bot] (3 commits)")[![michaelmior](https://avatars.githubusercontent.com/u/82501?v=4)](https://github.com/michaelmior "michaelmior (1 commits)")[![nemiah](https://avatars.githubusercontent.com/u/1369437?v=4)](https://github.com/nemiah "nemiah (1 commits)")[![tkukurin](https://avatars.githubusercontent.com/u/297847?v=4)](https://github.com/tkukurin "tkukurin (1 commits)")[![nasamuffin](https://avatars.githubusercontent.com/u/1606826?v=4)](https://github.com/nasamuffin "nasamuffin (1 commits)")[![dixonary](https://avatars.githubusercontent.com/u/7945623?v=4)](https://github.com/dixonary "dixonary (1 commits)") --- Tags apiremarkable-tabletsync ### Embed Badge ![Health badge](/badges/splitbrain-remarkable-api/health.svg) ``` [![Health](https://phpackages.com/badges/splitbrain-remarkable-api/health.svg)](https://phpackages.com/packages/splitbrain-remarkable-api) ``` ### Alternatives [stripe/stripe-php Stripe PHP Library 4.0k143.3M480](/packages/stripe-stripe-php)[twilio/sdk A PHP wrapper for Twilio's API 1.6k92.9M272](/packages/twilio-sdk)[knplabs/github-api GitHub API v3 client 2.2k15.8M187](/packages/knplabs-github-api)[facebook/php-business-sdk PHP SDK for Facebook Business 90121.9M34](/packages/facebook-php-business-sdk)[meilisearch/meilisearch-php PHP wrapper for the Meilisearch API 73813.7M114](/packages/meilisearch-meilisearch-php)[google/gax Google API Core for PHP 263103.1M454](/packages/google-gax) PHPackages © 2026 [Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)