README.md

← Back to plugins index
💩 PoopMap plugin
This plugin displays statistics from a PoopMap account.
⚠️ Disclaimer	This plugin is not affiliated, associated, authorized, endorsed by, or in any way officially connected with PoopMap. All product and company names are trademarks™ or registered® trademarks of their respective holders.
Authors	@matievisthekat
Supported features → Full specification	📗 Classic template
	👤 Users
	🗝️ plugin_poopmap_token

➡️ Available options

Option	Description
plugin_poopmap	Enable poopmap plugin
type: boolean default: no
plugin_poopmap_token	PoopMap API token
🔐 Token type: token
plugin_poopmap_days	Time range
type: number default: 7 allowed values: 7 30 180 365

🗝️ Obtaining a PoopMap token

Install PoopMap app (iOS/Android) and create an account.

Navigate to your profile in the app

Tap "Share Profile" in the top right

Tap "Copy to Clipboard"

It should result in something like Haha, check out the places I've pooped on Poop Map https://api.poopmap.net/map?token=xxxxxxxxxx copied.

Extract the token query parameter from the link and use it in plugin_poopmap_token. This token will not expire and it will be able to access only public details.

ℹ️ Examples workflows

uses: lowlighter/metrics@latest
with:
  token: NOT_NEEDED
  plugin_poopmap_token: ${{ secrets.POOPMAP_TOKEN }}
  plugin_poopmap: yes