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

Parameter	Required	Description	Format
startDate	Yes	Start date of the requested period	YYYY-MM-DD
endDate	Yes	End date of the requested period	YYYY-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

Field	Type	Description
date	string	Date in YYYY-MM-DD format
txn_count	number	Number of transactions
impr_count	number	Number of impressions
alkimi_revenue	number	Revenue 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

Monitor rate limit headers to avoid hitting limits

Implement exponential backoff when rate limits are hit

Keep date ranges within the 31-day limit

Always use YYYY-MM-DD format for dates

Cache responses when appropriate

Support

For API support or questions, please contact support

Get Data

Community Data API Documentation

Overview

Endpoint

Query Parameters

Rate Limiting

Constraints

Response Format

Success Response (200 OK)

Response Fields

Error Responses

Invalid Request (400)

Rate Limit Exceeded (429)

Example Requests

cURL

JavaScript

Python

Best Practices

Support

Request

Request samples

Responses

Get Data

Community Data API Documentation#

Overview#

Endpoint#

Query Parameters#

Rate Limiting#

Constraints#

Response Format#

Success Response (200 OK)#

Response Fields#

Error Responses#

Invalid Request (400)#

Rate Limit Exceeded (429)#

Example Requests#

cURL#

JavaScript#

Python#

Best Practices#

Support#

Request

Request samples

Responses

Community Data API Documentation

Overview

Endpoint

Query Parameters

Rate Limiting

Constraints

Response Format

Success Response (200 OK)

Response Fields

Error Responses

Invalid Request (400)

Rate Limit Exceeded (429)

Example Requests

cURL

JavaScript

Python

Best Practices

Support