Docs menu
Referrals API endpoint
List current user's referral events
Returns recent referral attribution records where the authenticated user is either the referrer or referred account.
/referrals/me/eventsOverview
Returns recent referral attribution records where the authenticated user is either the referrer or referred account.
Request schema
| Name | In | Type | Required | Enum | Example | Description |
|---|---|---|---|---|---|---|
| Authorization | header | string | Yes | JWT token in the form `Token <jwt>` | ||
| limit | query | integer | No | Maximum records to return, capped at 100 |
Authentication
Sign in first and send the returned JWT as Authorization: Token <jwt>, or use the console proxy with its httpOnly session cookie.
Billing
Endpoint usage is metered in credits. The plan prices, included credits, limits, and overage rates below match the active backend billing configuration.
- Credit cost
- 1 credit/request
- Charged response
- Successful 2xx responses
| Plan | Price | Included credits | Daily cap | Rate limit | Overage |
|---|---|---|---|---|---|
| Free | $0/mo | 2,000 | 500 daily credits | 5/min | No overage |
| Starter | $9/mo | 20,000 | 5,000 daily credits | 15/min | $0.75/1,000 overage credits when enabled |
| Growth | $29/mo | 100,000 | 25,000 daily credits | 45/min | $0.45/1,000 overage credits when enabled |
| Pro | $79/mo | 400,000 | No daily cap | 120/min | $0.30/1,000 overage credits |
| Business | $199/mo | 1,200,000 | No daily cap | 300/min | $0.20/1,000 overage credits |
| Enterprise | $499/mo | 5,000,000 | No daily cap | 1,000/min | $0.12/1,000 overage credits |
Infrastructure behavior
This endpoint is executed through Crawlora's managed scraping infrastructure.
- Proxy strategy: managed automatically where needed
- Browser rendering: enabled for supported targets that require rendered HTML or JavaScript execution
- Browser cluster: supported dynamic workloads can be routed through distributed browser instances
- Retry behavior: automatic retry/fallback may be used depending on endpoint type
- Challenge handling: challenged pages or unusable upstream HTML are detected and surfaced clearly when they cannot be used
- Billing: credits are charged only for successful 2xx responses
- Observability: responses include request context where available
Response behavior
- Records are sorted newest first. - Records expose the signed-in user's role in the referral instead of raw counterparty user IDs. - `status` is one of `attributed`, `rewarded`, `expired`, or `capped`.
Error behavior
Crawlora does not silently return bad data when the upstream page cannot be used.
| Status | Common failure case |
|---|---|
| 400 | Invalid input or missing required parameter |
| 429 | Plan or endpoint rate limit exceeded |
| 500 | Internal execution error |
| 502 | Upstream platform failed, returned unusable HTML, or served a challenge page that could not be resolved |
When possible, Crawlora returns structured error context so your integration can retry, back off, or inspect the request.
Failure responses
| Status | Description | Schema |
|---|---|---|
| 401 | Authentication required | #/definitions/app.Response |
| 500 | Internal server error | #/definitions/app.Response |
Example response
{
"code": 200,
"msg": "ok",
"data": {
"items": [
{
"id": "abc123",
"code": "A1B2C3D4E5F6",
"role": "referrer",
"status": "rewarded",
"reward_credits": 10000
}
]
}
}Request schema
No body schema
Response schema
#/definitions/referrals.referralsEventsResponseDoc
| Field | Type | Required | Enum | Bounds | Example | Description |
|---|---|---|---|---|---|---|
| items | array | No | ||||
| items[].campaign | string | No | spring-launch | |||
| items[].code | string | No | A1B2C3D4E5F6 | |||
| items[].created_at | string | No | ||||
| items[].expires_at | string | No | ||||
| items[].id | string | No | abc123 | |||
| items[].qualified_at | string | No | ||||
| items[].reward_credits | integer | No | 10000 | |||
| items[].rewarded_at | string | No | ||||
| items[].role | string | No | referrer, referred | referrer | ||
| items[].status | string | No | attributed, qualified, review_required, rewarded, expired, capped, failed, rejected | rewarded |
Code examples
Use environment variables for secrets and keep Crawlora API keys server-side.
curl -X GET "https://api.crawlora.net/api/v1/referrals/me/events?limit=10" \
-H "Authorization: Token $CRAWLORA_JWT"Responsible public web data workflows
Crawlora is designed for responsible structured public web data workflows. Customers are responsible for using Crawlora in compliance with applicable laws, third-party rights, target-platform rules, and Crawlora terms.
Read Crawlora terms