Use the .ir API from Iranian users and hosts for the best domestic route. Use the .com API from outside Iran.
https://api.donofa.irhttps://api.donofa.comwss://ws.donofa.com/app/AF5Ed2JKAF5Ed2JKUse Authorization: Api <API_KEY> for every HTTP endpoint below. Keep the key secret and never commit it to client code.
API keyApiheaderAuthorizationLegacy endpoints retained for integrations that have not moved to v2.
/api/v1/widgets/goalReturns the first non-deleted goal, ordered by descending sort value.
Send the API key in the Authorization header for this endpoint.
200Goal returned.
404The user has no non-deleted goal.
401Missing or invalid API key.
429Rate limit exceeded.
/api/v1/widgets/goalAlways returns a deprecation error. Use the v2 goal endpoints instead.
Send the API key in the Authorization header for this endpoint.
400This endpoint is deprecated.
401Missing or invalid API key.
429Rate limit exceeded.
/api/v1/widgets/timerReturns legacy timer state and the donation-to-seconds rate.
Send the API key in the Authorization header for this endpoint.
200Timer returned.
401Missing or invalid API key.
429Rate limit exceeded.
/api/v1/donatesReturns the authenticated user's filtered, paginated donations.
Send the API key in the Authorization header for this endpoint.
pagequeryPage number; default 1.
integerper_pagequeryItems per page; default 15.
integerfromAmount / toAmountqueryInclusive amount bounds.
numberfromDate / toDatequeryInclusive created date bounds.
datedaysqueryOnly records from the last N days.
integerstatusquery1 paid, 2 pending, or 3 refunded.
integertypequeryComma-separated donation types.
stringqquerySearch donor name or message.
stringorder_byqueryCreated date order; default desc.
asc | desclimitqueryOptional query limit.
integer200Donation page returned.
401Missing or invalid API key.
429Rate limit exceeded.
/api/v1/donates/lastReturns the latest 20 donations, newest first.
Send the API key in the Authorization header for this endpoint.
200Latest donations returned.
401Missing or invalid API key.
429Rate limit exceeded.
Current goal, donation, and timer endpoints.
/api/v2/goalsReturns all non-deleted goals, ordered by descending sort value.
Send the API key in the Authorization header for this endpoint.
200Goals returned.
401Missing or invalid API key.
429Rate limit exceeded.
/api/v2/goalsCreates a goal. Progress starts at the supplied initial value.
Send the API key in the Authorization header for this endpoint.
multipart/form-datatitlerequiredGoal title.
string (2-30)unitrequiredGoal unit; create only.
IRT | USD | pieceinitialrequiredInitial progress.
integer >= 0totalrequiredTarget total.
integer > 0media[]Up to four images.
image <= 4 MBmeta.product_linkOptional active product URL.
URLmeta.dynamicDynamic goal flag.
booleansourcesDonation/follow/sub/points source switches.
object200Goal created.
403The plan's maximum active-goal count was reached.
422A field failed validation.
401Missing or invalid API key.
429Rate limit exceeded.
/api/v2/goals/defaultReturns the first non-deleted goal by descending sort value.
Send the API key in the Authorization header for this endpoint.
200Default goal returned.
404The user has no non-deleted goal.
401Missing or invalid API key.
429Rate limit exceeded.
/api/v2/goals/{goal}Updates a goal owned by the authenticated user. Sending media replaces existing media.
Send the API key in the Authorization header for this endpoint.
multipart/form-datatitleGoal title.
string (2-30)initialInitial progress.
integer >= 0totalTarget total.
integer > 0media[]Up to four images.
image <= 4 MBmeta.product_linkOptional active product URL.
URLmeta.dynamicDynamic goal flag.
booleansourcesDonation/follow/sub/points source switches.
objectsortDisplay order.
integer >= 0200Goal updated and goal.updated broadcast.
403The goal belongs to another user.
404Goal ID does not exist.
422A field failed validation.
401Missing or invalid API key.
429Rate limit exceeded.
/api/v2/goals/{goal}/resetResets progress to initial and status to pending.
Send the API key in the Authorization header for this endpoint.
200Goal reset and goal.updated broadcast.
403The goal belongs to another user.
404Goal ID does not exist.
401Missing or invalid API key.
429Rate limit exceeded.
/api/v2/donatesReturns filtered, paginated donations in the current resource format.
Send the API key in the Authorization header for this endpoint.
page / per_pagequeryPage and page size; defaults 1 and 15.
integerfromAmount / toAmountqueryInclusive amount bounds.
numberfromDate / toDatequeryInclusive created date bounds.
datedaysqueryOnly records from the last N days.
integerstatusqueryDonation status value.
stringtypequeryComma-separated donation types.
stringqquerySearch donor name or message.
stringorder_byqueryCreated date order; default desc.
asc | desclimitqueryOptional query limit.
integer200Donation page returned.
401Missing or invalid API key.
429Rate limit exceeded.
/api/v2/donates/lastReturns latest donation statistics.
Send the API key in the Authorization header for this endpoint.
limitqueryMaximum results; default 10, capped at 100.
integer200Latest donations returned.
401Missing or invalid API key.
429Rate limit exceeded.
/api/v2/donates/topReturns highest donation statistics for a period.
Send the API key in the Authorization header for this endpoint.
limitqueryMaximum results; default 10, capped at 100.
integerperiodqueryStatistics period; default last30d.
stringaggregationqueryAggregate donors; default false.
true | false200Top donations returned.
401Missing or invalid API key.
429Rate limit exceeded.
/api/v2/timerReturns the authenticated user's timer.
Send the API key in the Authorization header for this endpoint.
200Timer returned.
401Missing or invalid API key.
429Rate limit exceeded.
/api/v2/timer/pausePauses the timer and broadcasts timer.updated.
Send the API key in the Authorization header for this endpoint.
200Timer action completed.
401Missing or invalid API key.
429Rate limit exceeded.
/api/v2/timer/resumeResumes the timer and broadcasts timer.updated.
Send the API key in the Authorization header for this endpoint.
200Timer action completed.
401Missing or invalid API key.
429Rate limit exceeded.
/api/v2/timer/resetResets the timer and broadcasts timer.updated.
Send the API key in the Authorization header for this endpoint.
200Timer action completed.
401Missing or invalid API key.
429Rate limit exceeded.
/api/v2/timer/extendAdds seconds to the timer and broadcasts timer.updated.
Send the API key in the Authorization header for this endpoint.
application/jsonsecondsrequiredSeconds to add.
integer > 0{
"seconds": 300
}200Timer extended.
422Seconds is missing, non-integer, or not positive.
401Missing or invalid API key.
429Rate limit exceeded.
Subscribe with Echo.channel('user.<API_KEY>') to receive user events.
user.<API_KEY>Connection setupReverb uses the Pusher protocol. With Laravel Echo, custom event names require the leading dot. With a native WebSocket client, subscribe after the connection is established.
.donate.createdUnwrapped donation object. Voice, TTS, goal, and withdrawable fields appear only when available.
.goal.updatedComplete updated goal resource.
.goal.completedComplete goal resource after the goal reaches its target.
.timer.updatedComplete updated timer resource.
.tts.createdTemporary URL for the newly created TTS audio.