Unofficial AlEx API Documentation

This API provides access to the official AlEx API but with some enhanced fields and no rate limits. Data can be retrieved in either JSON or CSV format.

Endpoint

https://theworm.me/api/daily.php

Request Method

GET

Parameters

Parameter	Required	Type	Description	Default	Example
`startDate`	Yes	String (YYYY-MM-DD)	The start date of the data range. Must be on or after 2024-01-01.	None	`2024-01-01`
`endDate`	Yes	String (YYYY-MM-DD)	The end date of the data range. Must be on or before today's date and after `startDate`	None	`2024-02-15`
`MA`	No	String (comma-separated)	A comma-separated list of Moving Average columns to include in the response. Valid values are: `3DMA_impr_count` `7DMA_impr_count` `14DMA_impr_count` `30DMA_impr_count` `3DMA_alkimi_revenue` `7DMA_alkimi_revenue` `14DMA_alkimi_revenue` `30DMA_alkimi_revenue`	None	`3DMA_impr_count,7DMA_alkimi_revenue`
`change`	No	String (comma-separated)	A comma-separated list of change columns to include. These represent the percentage change compared to the previous day. Valid values are: `revenue` (for `alkimi_revenue_change`) `impr` (for `impr_count_change`) `txn` (for `txn_count_change`)	None	`revenue,impr`
`format`	No	String	The desired output format. Valid values are `json` or `csv`.	`json`	`csv`

Response Format

JSON

When format=json (default), the API returns a JSON object with the following structure:

    {
        "status": "Success",
        "data": [
            {
                "date": "YYYY-MM-DD",
                "txn_count": (integer),
                "impr_count": (integer),
                "alkimi_revenue": (float),
                // ... other requested MA and change columns ...
            },
            // ... more data items ...
        ]
    }

CSV

When format=csv, the API returns a CSV file with the following structure:

    date,txn_count,impr_count,alkimi_revenue,...
    2024-01-01,100,1000,50.00,...
    2024-01-02,110,1100,55.00,...
    ...

The first row contains the header names, and subsequent rows contain the data for each date in the requested range.

Error Handling

If an error occurs, the API will return a JSON response with a 400 Bad Request status code and the following structure:

    {
        "status": "Error",
        "message": "Error message describing the issue."
    }

If a CSV format was requested, the API will return an error in plain text format:

        Error: Error message describing the issue.

Possible error messages include:

startDate and endDate parameters are required.
Invalid date format. Use YYYY-MM-DD.
Start date must be before end date.
Invalid MA parameter: [parameter name]
Invalid format. Use 'json' or 'csv'.

Example Requests

JSON Request

Get data from 2024-01-10 to 2024-01-15 with 7-day impression moving average and revenue change in JSON format:

    daily.php?startDate=2024-01-10&endDate=2024-01-15&MA=7DMA_impr_count&change=revenue

CSV Request

Get data from 2024-02-01 to 2024-02-29 with all 3-day and 14-day moving averages in CSV format:

    daily.php?startDate=2024-02-01&endDate=2024-02-29&MA=3DMA_impr_count,3DMA_alkimi_revenue,14DMA_impr_count,14DMA_alkimi_revenue&format=csv

Notes

All data is aggregated daily.
The txn_count, impr_count, and alkimi_revenue columns are always included in the response.
The moving average (MA) columns are calculated based on the preceding days (e.g., 7DMA is calculated using the data from the previous 7 days).
The change columns represent the percentage change compared to the previous day. A value of null indicates that there is no previous day's data for comparison. A value of Infinity means the value has grown from zero.
Dates are in GMT.