Pinggy API Documentation

What is Pinggy?

Pinggy is an app that lets you share what you are doing with your friends & family in 160 characters.

Purpose of this document

The purpose of this document is to highlight how to make API requests to Pinggy service using API keys. This can be particularly helpful if you want to automate updating your status.

API documentation

Pre-requisites: You need to get an API key from https://ping.gy/settings.

We currently support the below APIs.

1. Update your status

curl -X POST 'https://ping.gy/api/status' \
-H 'content-type: application/json' \
-H 'x-api-key: API_KEY_GOES_HERE' \
-d '{"text": "Automating Pinggy using APIs"}'

This method currently supports the following content types: x-www-form-urlencoded & application/json. API Key has to be set in the x-api-key header.

Sample response

{
    "message": "New status has been updated",
    "status": {
        "handle": "vasanth",
        "status": "Happy Friday",
        "statusDate": "2022-10-29T00:31:22.865Z",
        "mentions": [],
        "statusHash": "2dcf841334c3c1e16e4a7eb642917735b4b045cc0357af22da18e1381f99df10"
    }
}

2. Fetch your home feed

curl -X GET 'https://ping.gy/api/status'
-H 'x-api-key: API_KEY_GOES_HERE'

API Key has to be set in the x-api-key header.

Sample response

{
    "statuses": [
        {
            "_id": "632d096b59a70abf5dfb792c",
            "handle": "vasanth",
            "status": "Happy Friday",
            "statusDate": "2022-10-29T00:31:22.865Z",
            "statusHash": "2dcf841334c3c1e16e4a7eb642917735b4b045cc0357af22da18e1381f99df10",
            "mentions": [],
            "isAdded": false
        },
        {
            "_id": "6355491d3fe6b8bb2b1f718e",
            "handle": "thomas",
            "status": "Testing pinggy @vasanth",
            "statusDate": "2022-10-25T01:28:02.221Z",
            "statusHash": "2572a4f3775e7e26508d8ca75dda05b90734095b06f59913271d995d8cdf1b80",
            "mentions": [
                {
                    "_id": "632d096b59a70abf5dfb792c",
                    "handle": "vasanth"
                }
            ],
            "isAdded": true
        }
    ]
}

3. Fetch your details

curl -X GET 'https://ping.gy/api/me'
-H 'x-api-key: API_KEY_GOES_HERE'

API Key has to be set in the x-api-key header.

Sample response

{
    "name": "Vasanth V",
    "handle": "vasanth",
    "email": "[email protected]",
    "status": "Happy Friday",
    "statusDate": "2022-10-29T00:31:22.865Z",
    "enabledNotifications": false
}

Automation

If you would like to automate your statuses, you can use services like IFTTT, Zapier etc.

  1. IFTTT - Configure the applet using maker webhooks.
  2. Zapier - You can use the Pinggy service which is found here: https://zapier.com/developer/public-invite/171246/2e240e9b881b31bd07f6eab1a589d831/

Help & Support

If you need any help with the documentation feel free to contact us @ [email protected]