META

API reference

Introduction

RxAPI is able to serve update and funding information about any tool you’re developing/maintaining/releasing. When a script or application checks if an update is available, RxAPI stores some anonymous information and is able to serve some usage statistics. This data can not be used to identify or track individual users in any way; there’s no fingerprinting possible.

Update info

The update information is pulled from github repositories, using the release features. We may add support for Gitlab later.

Funding info

RxAPI also collects funding information from various sources, to summarize all the funds and supporters got by the organization. These are the current sources (we may add more later):

Statistics

For each request from a script or application, RxAPI stores the following information, if it is provided by the script or application:

We may add geographical data later (such as the country).

This data can be retrieved by a request to the API.

Script and application should check for update once a day and not more: that’s a reliable way to estimate the number of daily users.

Shields

RxAPI provides a specific endpoint to be used with shields.io. Read more details here.

Quote

RxAPI provides a special endpoint to get random quotes. Read more details here.

Usage

For the following documentation, we’re using our official RxLab server instance as an example. It is located at http://api.rxlab.io.

Update and funding information

Endpoint: http://api.rxlab.io

Request

Examples

Reply

RxAPI replies with a JSON object.

{
    "accepted":true,
    "success":true,
    "message":"Successful request.",
    "update":false,
    "name":"Duik",
    "donateURL":"http:\/\/donate.rxlab.info",
    "downloadURL":"https:\/\/rxlaboratory.org",
    "changelogURL":"https:\/\/rxlaboratory.org",
    "version":"16.2.30",
    "newName":"Duik Bassel.2 Update 30",
    "description":"The thirtieth update of Duik Bassel.2 fixes some auto-rig issues due to changes in the scripting API in After Effects 2021.\r\n\r\nAs always, it is strongly advised to update Duik as soon as you can.\r\n\r\nThe detailed list of what\u2019s new is available in the changelog [here](https:\/\/duik.rxlab.guide\/duik-16-changelog.html).\r\n\r\nHere is the [comprehensive documentation for Duik](https:\/\/duik.rxlab.guide), and here is the [reference for the Duik API](https:\/\/duik.rxlab.io\/).",
    "date":"2021-07-28T17:41:59Z",
    "monthlyFund":973.41,
    "fundingGoal":4000
}

If update is true, that means the script/application has a new update available.

Statistics

Endpoint: http://api.rxlab.io

Request

Examples

Reply

RxAPI replies with a JSON object, including an array of objects representing the scripts/applications for which it has some statistics.

{
    "accepted":true,
    "success":true,
    "message":"",
    "winCount":3391,
    "winRatio":77,
    "macCount":1034,
    "macRatio":23,
    "linuxCount":6,
    "linuxRatio":0,
    "userCount":4431,
    "apps":[
        {"name":"Duik","count":1996,"ratio":45,"host":"aftereffects"},
        {"name":"DuGR","count":1732,"ratio":39,"host":"after-effects"},
        {"name":"Ramses-Client","count":429,"ratio":10,"host":""},
        {"name":"DuSan","count":235,"ratio":5,"host":"aftereffects"},
        {"name":"DuBlast","count":37,"ratio":1,"host":"Blender"},
        {"name":"DuFlatnr","count":2,"ratio":0,"host":"photoshop"}
    ],
    "languages": [
        {"name":"English","code":"en","count":800,"ratio":80},
        {"name":"Fran├žais","code":"fr","count":200,"ratio":20}
    ]
}