PHPackages                             prayermate/prayermate-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. prayermate/prayermate-api

ActiveLibrary[API Development](/categories/api)

prayermate/prayermate-api
=========================

PrayerMate Platform API

04PHP

Since Sep 25Pushed 7y ago2 watchersCompare

[ Source](https://github.com/andygeers/prayermate-client_php)[ Packagist](https://packagist.org/packages/prayermate/prayermate-api)[ RSS](/packages/prayermate-prayermate-api/feed)WikiDiscussions master Synced 1mo ago

READMEChangelogDependenciesVersions (1)Used By (0)

PrayerMate API
==============

[](#prayermate-api)

This PHP composer package is an API for working with the [PrayerMate platform](https://www.prayermate.net/).

PrayerMate is an app to help you pray and this API allows you interact with the platform.

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

[](#installation)

```
composer install prayermate/prayermate-api

```

Usage
-----

[](#usage)

You need to locate four pieces of information from the prayermate.net portal.

- Log in to the portal.
- Create a feed if you have not made one yet.
- Click `API Access` at the bottom of the right menu for the feed
- Scroll down to the HTTP Requests heading
- In the Basic Authorisation section copy your `$apiKey` (60 character hex string) and `$password` (60 character hex string).
- In the Posting New Content section, copy the copy the `$feedID` (integer?) and `$feedSlug` (38 character hex string) from the values in the json block.

The `$apiKey` and `$password` are global values for your account to access the API. The `$feedID` and `$feedSlug` are unique per feed.

```
$driver = new Driver\GuzzleDriver($apiKey, $password, $email);
$prayermate = new PrayerMateAPI($driver);
```

A *petition* is one piece of content: a prayer request in a feed. It can be plain text, or markdown if you enable Markdown by clicking the button at the bottom of the API Access page on the portal.

To see what is in your feed:

```
$petitions = $prayermate->getFeedContents($feedSlug);
```

To add a new request to the feed

```
$petition = new Petition('My prayer *Request* content', '2018-10-11');
$petition->setTitle('A test request');
$petition->setIsMarkdown();
$prayermate->setFeedContents($feedSlug, $feedID, gmdate('Y-m-d H:i:s'), [$petition]);
```

Note that feeds can have several different "styles" (configurations) eg Calendar, Newsletter, Day of the Month which you choose on creation. Follow the documentation on prayermate.net for more details. Watch out for `Petition`s with no date. These are "exclusive" which means they replace all the other petitions in the feed. This is handy for an API that pushes out daily updates and is not concerned for historic data. Read the documentation on the API page for your feed about handling multiple petitions carefully.

Development
-----------

[](#development)

- Unit Tests `composer phpunit`
- Static analysis `composer phpstan`

### ToDo

[](#todo)

- tls key pinning
- The Ruby Gem version [https://github.com/andygeers/prayermate\_api](https://github.com/andygeers/prayermate_api) has a couple of other endpoints but we have no documentation for those yet.

Contributing
------------

[](#contributing)

Currently development and usage is internal. Contact  to get involved.

Code of Conduct
---------------

[](#code-of-conduct)

Everyone interacting in the PrayerMateApi project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](CODE_OF_CONDUCT.md).

###  Health Score

19

—

LowBetter than 10% of packages

Maintenance20

Infrequent updates — may be unmaintained

Popularity3

Limited adoption so far

Community8

Small or concentrated contributor base

Maturity39

Early-stage or recently created project

 Bus Factor1

Top contributor holds 100% 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/6b01be5b996fa22f6e49ed9a1d3c55c44b883de66e4ee6ec8acdc4b51fc3697f?d=identicon)[pavarnos](/maintainers/pavarnos)

---

Top Contributors

[![pavarnos](https://avatars.githubusercontent.com/u/589595?v=4)](https://github.com/pavarnos "pavarnos (2 commits)")

### Embed Badge

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

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

###  Alternatives

[stripe/stripe-php

Stripe PHP Library

4.0k143.3M475](/packages/stripe-stripe-php)[twilio/sdk

A PHP wrapper for Twilio's API

1.6k92.9M270](/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.1M452](/packages/google-gax)

PHPackages © 2026

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