PHPackages                             appwrite/appwrite - 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. appwrite/appwrite

ActiveLibrary[API Development](/categories/api)

appwrite/appwrite
=================

Appwrite is an open-source self-hosted backend server that abstracts and simplifies complex and repetitive development tasks behind a very simple REST API

27.1.0(3w ago)156334.5k—6.3%24[2 PRs](https://github.com/appwrite/sdk-for-php/pulls)4BSD-3-ClausePHPPHP >=8.2.0CI failing

Since Mar 9Pushed 3w ago14 watchersCompare

[ Source](https://github.com/appwrite/sdk-for-php)[ Packagist](https://packagist.org/packages/appwrite/appwrite)[ RSS](/packages/appwrite-appwrite/feed)WikiDiscussions main Synced 2w ago

READMEChangelog (10)Dependencies (11)Versions (87)Used By (4)

Appwrite PHP SDK
================

[](#appwrite-php-sdk)

[![License](https://camo.githubusercontent.com/74aebd1290ab656f2d635fbf306d5ef4ba9cc0ebd94b246f44e394c1838acd40/68747470733a2f2f696d672e736869656c64732e696f2f6769746875622f6c6963656e73652f61707077726974652f73646b2d666f722d7068702e7376673f7374796c653d666c61742d73717561726526763d31)](https://camo.githubusercontent.com/74aebd1290ab656f2d635fbf306d5ef4ba9cc0ebd94b246f44e394c1838acd40/68747470733a2f2f696d672e736869656c64732e696f2f6769746875622f6c6963656e73652f61707077726974652f73646b2d666f722d7068702e7376673f7374796c653d666c61742d73717561726526763d31)[![Version](https://camo.githubusercontent.com/4755a983476d9fdc0cbf305958961141a7166a47aca88f85be87530a50148659/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f61706925323076657273696f6e2d312e392e352d626c75652e7376673f7374796c653d666c61742d73717561726526763d31)](https://camo.githubusercontent.com/4755a983476d9fdc0cbf305958961141a7166a47aca88f85be87530a50148659/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f61706925323076657273696f6e2d312e392e352d626c75652e7376673f7374796c653d666c61742d73717561726526763d31)[![Build Status](https://camo.githubusercontent.com/35c9a1f34950f5ae09c4b260724006ef93cf502c5998900c22ac4c103ccbd830/68747470733a2f2f696d672e736869656c64732e696f2f7472617669732f636f6d2f61707077726974652f73646b2d67656e657261746f723f7374796c653d666c61742d737175617265)](https://travis-ci.com/appwrite/sdk-generator)[![Twitter Account](https://camo.githubusercontent.com/95a35a6a7b26a4a26b1e365e36ac3ddf1794b2796d2b91de2f37ccb81274ae9d/68747470733a2f2f696d672e736869656c64732e696f2f747769747465722f666f6c6c6f772f61707077726974653f636f6c6f723d303061636565266c6162656c3d74776974746572267374796c653d666c61742d737175617265)](https://twitter.com/appwrite)[![Discord](https://camo.githubusercontent.com/793c234f12541be170e68233083ccfc7e5966e80a054d84a3e14ec0670ee66a5/68747470733a2f2f696d672e736869656c64732e696f2f646973636f72642f3536343136303733303834353135313234343f6c6162656c3d646973636f7264267374796c653d666c61742d737175617265)](https://appwrite.io/discord)

**This SDK is compatible with Appwrite server version 1.9.x. For older versions, please check [previous releases](https://github.com/appwrite/sdk-for-php/releases).**

Appwrite is an open-source backend as a service server that abstracts and simplifies complex and repetitive development tasks behind a very simple to use REST API. Appwrite aims to help you develop your apps faster and in a more secure way. Use the PHP SDK to integrate your app with the Appwrite server to easily start interacting with all of Appwrite backend APIs and tools. For full API documentation and tutorials go to

[![Appwrite](https://github.com/appwrite/appwrite/raw/main/public/images/github.png)](https://github.com/appwrite/appwrite/raw/main/public/images/github.png)

Installation
------------

[](#installation)

To install via [Composer](http://getcomposer.org/):

```
composer require appwrite/appwrite
```

Requires PHP 8.2 or later.

Getting Started
---------------

[](#getting-started)

### Init your SDK

[](#init-your-sdk)

Initialize your SDK with your Appwrite server API endpoint and project ID which can be found in your project settings page and your new API secret Key from project's API keys section.

```
$client = new Client();

$client
    ->setEndpoint('https://[HOSTNAME_OR_IP]/v1') // Your API Endpoint
    ->setProject('5df5acd0d48c2') // Your project ID
    ->setKey('919c2d18fb5d4...a2ae413da83346ad2') // Your secret API key
    ->setSelfSigned() // Use only on dev mode with a self-signed SSL cert
;
```

### Make Your First Request

[](#make-your-first-request)

Once your SDK object is set, create any of the Appwrite service objects and choose any request to send. Full documentation for any service method you would like to use can be found in your SDK documentation or in the [API References](https://appwrite.io/docs) section.

```
$users = new Users($client);

$user = $users->create(ID::unique(), "email@example.com", "+123456789", "password", "Walter O'Brien");
```

### Full Example

[](#full-example)

```
use Appwrite\Client;
use Appwrite\ID;
use Appwrite\Services\Users;

$client = new Client();

$client
    ->setEndpoint('https://[HOSTNAME_OR_IP]/v1') // Your API Endpoint
    ->setProject('5df5acd0d48c2') // Your project ID
    ->setKey('919c2d18fb5d4...a2ae413da83346ad2') // Your secret API key
    ->setSelfSigned() // Use only on dev mode with a self-signed SSL cert
;

$users = new Users($client);

$user = $users->create(ID::unique(), "email@example.com", "+123456789", "password", "Walter O'Brien");
```

### Error Handling

[](#error-handling)

The Appwrite PHP SDK raises `AppwriteException` object with `message`, `code` and `response` properties. You can handle any errors by catching `AppwriteException` and present the `message` to the user or handle it yourself based on the provided error information. Below is an example.

```
$users = new Users($client);
try {
    $user = $users->create(ID::unique(), "email@example.com", "+123456789", "password", "Walter O'Brien");
} catch(AppwriteException $error) {
    echo $error->message;
}
```

### Learn more

[](#learn-more)

You can use the following resources to learn more and get help

- 🚀 [Getting Started Tutorial](https://appwrite.io/docs/getting-started-for-server)
- 📜 [Appwrite Docs](https://appwrite.io/docs)
- 💬 [Discord Community](https://appwrite.io/discord)
- 🚂 [Appwrite PHP Playground](https://github.com/appwrite/playground-for-php)

Contribution
------------

[](#contribution)

This library is auto-generated by Appwrite custom [SDK Generator](https://github.com/appwrite/sdk-generator). To learn more about how you can help us improve this SDK, please check the [contribution guide](https://github.com/appwrite/sdk-generator/blob/master/CONTRIBUTING.md) before sending a pull-request.

License
-------

[](#license)

Please see the [BSD-3-Clause license](https://raw.githubusercontent.com/appwrite/appwrite/master/LICENSE) file for more information.

###  Health Score

72

—

ExcellentBetter than 100% of packages

Maintenance95

Actively maintained with recent releases

Popularity54

Moderate usage in the ecosystem

Community34

Small or concentrated contributor base

Maturity89

Battle-tested with a long release history

 Bus Factor3

3 contributors hold 50%+ of commits

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.

###  Release Activity

Cadence

Every ~37 days

Recently: every ~12 days

Total

74

Last Release

24d ago

Major Versions

22.0.0 → 23.0.02026-04-16

23.1.1 → 24.0.02026-05-19

24.2.0 → 25.0.02026-06-01

25.1.0 → 26.0.02026-06-17

26.1.0 → 27.0.02026-07-13

PHP version history (4 changes)v0.1.0PHP >=5.3.0

v1.0.3PHP >=7.1.0

20.0.0PHP >=8.0.0

22.0.0PHP >=8.2.0

### Community

Maintainers

![](https://www.gravatar.com/avatar/023f08a9df59f81cc4a04b1cebd20f45ede5db53ef2f9e9ad3d75f4c69be66b8?d=identicon)[eldadfux](/maintainers/eldadfux)

---

Top Contributors

[![eldadfux](https://avatars.githubusercontent.com/u/1297371?v=4)](https://github.com/eldadfux "eldadfux (84 commits)")[![abnegate](https://avatars.githubusercontent.com/u/5857008?v=4)](https://github.com/abnegate "abnegate (72 commits)")[![ChiragAgg5k](https://avatars.githubusercontent.com/u/110609663?v=4)](https://github.com/ChiragAgg5k "ChiragAgg5k (56 commits)")[![christyjacob4](https://avatars.githubusercontent.com/u/20852629?v=4)](https://github.com/christyjacob4 "christyjacob4 (36 commits)")[![TorstenDittmann](https://avatars.githubusercontent.com/u/1759475?v=4)](https://github.com/TorstenDittmann "TorstenDittmann (21 commits)")[![ArnabChatterjee20k](https://avatars.githubusercontent.com/u/83803257?v=4)](https://github.com/ArnabChatterjee20k "ArnabChatterjee20k (20 commits)")[![premtsd-code](https://avatars.githubusercontent.com/u/182438090?v=4)](https://github.com/premtsd-code "premtsd-code (12 commits)")[![lohanidamodar](https://avatars.githubusercontent.com/u/6360216?v=4)](https://github.com/lohanidamodar "lohanidamodar (8 commits)")[![loks0n](https://avatars.githubusercontent.com/u/22452787?v=4)](https://github.com/loks0n "loks0n (8 commits)")[![stnguyen90](https://avatars.githubusercontent.com/u/1477010?v=4)](https://github.com/stnguyen90 "stnguyen90 (3 commits)")[![SoftCreatR](https://avatars.githubusercontent.com/u/81188?v=4)](https://github.com/SoftCreatR "SoftCreatR (2 commits)")[![TeamAppwrite](https://avatars.githubusercontent.com/u/56990844?v=4)](https://github.com/TeamAppwrite "TeamAppwrite (1 commits)")[![Meldiron](https://avatars.githubusercontent.com/u/19310830?v=4)](https://github.com/Meldiron "Meldiron (1 commits)")

---

Tags

appwritebaashacktoberfestphp

###  Code Quality

TestsPHPUnit

### Embed Badge

![Health badge](/badges/appwrite-appwrite/health.svg)

```
[![Health](https://phpackages.com/badges/appwrite-appwrite/health.svg)](https://phpackages.com/packages/appwrite-appwrite)
```

###  Alternatives

[appwrite/server-ce

End to end backend server for frontend and mobile apps.

56.9k115.4k](/packages/appwrite-server-ce)[docusign/esign-client

The Docusign PHP library makes integrating Docusign into your apps and websites a super fast and painless process. The library is open sourced on GitHub, look for the docusign-esign-php-client repository. Join the eSign revolution!

2108.3M13](/packages/docusign-esign-client)[lucasdotvin/laravel-soulbscription

A straightforward interface to handle subscriptions and features consumption.

709209.3k](/packages/lucasdotvin-laravel-soulbscription)[utopia-php/vcs

A simple library to integrate version control systems like GitHub, GitLab etc. to receive webhook events

14234.8k4](/packages/utopia-php-vcs)[pimax/fb-messenger-php

Facebook Messenger Bot PHP API

313188.5k2](/packages/pimax-fb-messenger-php)

PHPackages © 2026

[Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)