Alkimi Public API
  1. public
Alkimi Public API
  • public
    • Get Data
      GET
  1. public

Get Data

GET
/api/v1/public/data
PublicApi

Community Data API Documentation#

Overview#

The Community Data API provides access to aggregated community statistics including transaction counts, impression counts, and revenue data. Access to the API is rate-limited to ensure fair usage for all clients.

Endpoint#

Query Parameters#

ParameterRequiredDescriptionFormat
startDateYesStart date of the requested periodYYYY-MM-DD
endDateYesEnd date of the requested periodYYYY-MM-DD

Rate Limiting#

To ensure fair usage, the API implements rate limiting. Current limits are tracked via response headers:
X-RateLimit-Remaining: Number of requests remaining in the current time window
X-RateLimit-Reset: Unix timestamp when the rate limit resets
X-Daily-Quota-Remaining: Number of requests remaining for the current day

Constraints#

Maximum date range: 31 days
End date must not be before start date
Dates must be in YYYY-MM-DD format

Response Format#

Success Response (200 OK)#

{
  "status": "Success",
  "data": [
    {
      "date": "2024-12-18",
      "txn_count": 1000,
      "impr_count": 5000,
      "alkimi_revenue": 150.75
    }
  ]
}

Response Fields#

FieldTypeDescription
datestringDate in YYYY-MM-DD format
txn_countnumberNumber of transactions
impr_countnumberNumber of impressions
alkimi_revenuenumberRevenue amount

Error Responses#

Invalid Request (400)#

Returned when the request parameters are invalid.
{
   "code": "ALK1005",
   "message":
      "Invalid Request Parameter – One or more parameters in the request are invalid.",
}

Rate Limit Exceeded (429)#

Returned when rate limit or daily quota is exceeded.
{
  "code": "ALK1010",
  "message":
      "Rate Limit Exceeded – Too many requests in a given amount of time.",
}

Example Requests#

cURL#

JavaScript#

Python#

Best Practices#

1.
Monitor rate limit headers to avoid hitting limits
2.
Implement exponential backoff when rate limits are hit
3.
Keep date ranges within the 31-day limit
4.
Always use YYYY-MM-DD format for dates
5.
Cache responses when appropriate

Support#

For API support or questions, please contact support

Request

Query Params
startDate
string 
optional
starting date from which you want to fetch data
Example:
2025-01-11
endDate
string 
optional
ending date upto which you want to fetch data
Example:
2025-01-16

Request samples

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request GET 'https://api.alkimi.org/api/v1/public/data?startDate=2025-01-11&endDate=2025-01-16'

Responses

🟢200OK
application/json
Body
Resposne
status
string 
required
sucess status
data
array [object {4}] 
required
array of transaction count , impression count and alkimi revenue
date
string 
optional
date for which data is shown
txn_count
integer 
optional
transaction count for same day
impr_count
integer 
optional
impression count for day
alkimi_revenue
number 
optional
alkmi revenue for date
Example
{
  "status": "string",
  "data": [
    {
      "date": "string",
      "txn_count": 0,
      "impr_count": 0,
      "alkimi_revenue": 0
    }
  ]
}
Modified at 2025-01-31 10:17:55
Built with