Skip to main content
GET
/
fee-share
/
token
/
claim-events
Get token claim events
curl --request GET \
  --url https://public-api-v2.bags.fm/api/v1/fee-share/token/claim-events \
  --header 'x-api-key: <api-key>'
{
  "success": true,
  "response": {
    "events": [
      {
        "wallet": "<string>",
        "isCreator": true,
        "amount": "<string>",
        "signature": "<string>",
        "timestamp": "<string>"
      }
    ]
  }
}

Documentation Index

Fetch the complete documentation index at: https://docs.bags.fm/llms.txt

Use this file to discover all available pages before exploring further.

Retrieve claim events for a specific token. This endpoint supports two query modes to give you flexibility in how you fetch claim data.

​
Query Modes

​
Offset Mode (Default)

Use offset-based pagination to retrieve claim events in batches. This is the default mode and is backward compatible with previous API versions. 
curl --request GET \
  --url 'https://public-api-v2.bags.fm/api/v1/fee-share/token/claim-events?tokenMint=YOUR_TOKEN_MINT&mode=offset&limit=50&offset=0' \
  --header 'x-api-key: YOUR_API_KEY'
​
mode
string
default:"offset"
Set to offset or omit entirely for pagination mode.
​
limit
integer
default:"100"
Maximum number of events to return (1-100).
​
offset
integer
default:"0"
Number of events to skip for pagination.

​
Time Mode

Use time-based filtering to retrieve all claim events within a specific time range. Useful for analytics dashboards, scheduled reports, or syncing historical data. 
curl --request GET \
  --url 'https://public-api-v2.bags.fm/api/v1/fee-share/token/claim-events?tokenMint=YOUR_TOKEN_MINT&mode=time&from=1704067200&to=1706745600' \
  --header 'x-api-key: YOUR_API_KEY'
​
mode
string
required
Must be set to time for time-based filtering.
​
from
integer
required
Start unix timestamp (inclusive). Must be greater than or equal to 0.
​
to
integer
required
End unix timestamp (inclusive). Must be greater than or equal to from.
When using time mode, the from timestamp must be less than or equal to to. The API will return an error if this constraint is violated.

​
Use Cases

  • Offset Mode: Best for building paginated UIs, real-time feeds, or when you need the most recent events.
  • Time Mode: Best for analytics, generating reports for specific periods, auditing, or syncing claim history.
For a complete implementation example, see the Get Token Claim Events how-to guide.

Authorizations

​
x-api-key
string
header
required

API key authentication. Provide your API key as the header value.

Query Parameters

​
tokenMint
string
required

Public key of the token mint

​
mode
enum<string>
default:offset

Query mode: 'offset' for pagination (default), 'time' for time-based filtering

Available options:
offset,
time
​
limit
integer
default:100

Maximum number of events to return (1-100, default: 100). Only used with mode=offset

Required range: 1 <= x <= 100
​
offset
integer
default:0

Number of events to skip for pagination (default: 0). Only used with mode=offset

Required range: x >= 0
​
from
integer

Start unix timestamp (inclusive). Required when mode=time

Required range: x >= 0
​
to
integer

End unix timestamp (inclusive). Required when mode=time. Must be greater than or equal to 'from'

Required range: x >= 0

Response

Successfully retrieved token claim events

​
success
boolean
required
Example:

true

​
response
object