Monkeytype API
发布时间:2026-08-26 | 浏览:2
Users get check name get get personal bests get get tags get get stats get get profile post send forgot password email get get current test activity get get streak
get get personal bests
get get profile
post send forgot password email
get get current test activity
Test results get get results get get result by id get get last result
get get results
get get result by id
get get last result
Public get get speed histogram get get typing stats
get get speed histogram
get get typing stats
Leaderboards get get leaderboard get get leaderboard rank get get daily leaderboard get get weekly xp leaderboard
get get leaderboard
get get leaderboard rank
get get daily leaderboard
get get weekly xp leaderboard
PSAs get get psas
Quotes get is submission enabled
get is submission enabled
Server configuration get get configuration
get get configuration
Download OpenAPI specification :
Documentation for the endpoints provided by the Monkeytype API server.
Note that authentication is performed with the Authorization HTTP header in the format Authorization: ApeKey YOUR_APE_KEY
There is a rate limit of 30 requests per minute across all endpoints with some endpoints being more strict. Rate limit rates are shared across all ape keys.
User account data.
Checks to see if a username is available.
Rate limit: This operation can be called up to 60 times per minute for regular users.
Generic client error
Authentication required but not provided or invalid
Operation not permitted
Request validation failed
Rate limit exceeded
ApeKey is inactive
ApeKey is malformed
ApeKey rate limit exceeded
Generic server error
Endpoint disabled or server is under maintenance
Production server
Response samples
"message" : "string" ,
"data" : { "available" : true }
"available" : true
get personal bests
Get user's personal bests.
Rate limit: This operation can be called up to 60 times per hour for regular users.
Generic client error
Authentication required but not provided or invalid
Operation not permitted
Request validation failed
Rate limit exceeded
ApeKey is inactive
ApeKey is malformed
ApeKey rate limit exceeded
Generic server error
Endpoint disabled or server is under maintenance
Production server
Response samples
"message" : "string" ,
"data" : { "acc" : 100 , "consistency" : 100 , "difficulty" : "normal" , "lazyMode" : true , "language" : "english" , "punctuation" : true , "numbers" : true , "raw" : 0 , "wpm" : 0 , "timestamp" : 0 }
"consistency" : 100 ,
"difficulty" : "normal" ,
"lazyMode" : true ,
"language" : "english" ,
"punctuation" : true ,
"numbers" : true ,
"timestamp" : 0
Get the users tags.
Rate limit: This operation can be called up to 60 times per hour for regular users.
Generic client error
Authentication required but not provided or invalid
Operation not permitted
Request validation failed
Rate limit exceeded
ApeKey is inactive
ApeKey is malformed
ApeKey rate limit exceeded
Generic server error
Endpoint disabled or server is under maintenance
Production server
Response samples
"message" : "string" ,
"data" : [ { "_id" : "string" , "name" : "string" , "personalBests" : { "time" : { "property1" : [ { "acc" : 100 , "consistency" : 100 , "difficulty" : "normal" , "lazyMode" : true , "language" : "english" , "punctuation" : true , "numbers" : true , "raw" : 0 , "wpm" : 0 , "timestamp" : 0 } ] , "property2" : [ { "acc" : 100 , "consistency" : 100 , "difficulty" : "normal" , "lazyMode" : true , "language" : "english" , "punctuation" : true , "numbers" : true , "raw" : 0 , "wpm" : 0 , "timestamp" : 0 } ] } , "words" : { "property1" : [ { "acc" : 100 , "consistency" : 100 , "difficulty" : "normal" , "lazyMode" : true , "language" : "english" , "punctuation" : true , "numbers" : true , "raw" : 0 , "wpm" : 0 , "timestamp" : 0 } ] , "property2" : [ { "acc" : 100 , "consistency" : 100 , "difficulty" : "normal" , "lazyMode" : true , "language" : "english" , "punctuation" : true , "numbers" : true , "raw" : 0 , "wpm" : 0 , "timestamp" : 0 } ] } , "quote" : { "property1" : [ { "acc" : 100 , "consistency" : 100 , "difficulty" : "normal" , "lazyMode" : true , "language" : "english" , "punctuation" : true , "numbers" : true , "raw" : 0 , "wpm" : 0 , "timestamp" : 0 } ] , "property2" : [ { "acc" : 100 , "consistency" : 100 , "difficulty" : "normal" , "lazyMode" : true , "language" : "english" , "punctuation" : true , "numbers" : true , "raw" : 0 , "wpm" : 0 , "timestamp" : 0 } ] } , "custom" : { "property1" : [ { "acc" : 100 , "consistency" : 100 , "difficulty" : "normal" , "lazyMode" : true , "language" : "english" , "punctuation" : true , "numbers" : true , "raw" : 0 , "wpm" : 0 , "timestamp" : 0 } ] , "property2" : [ { "acc" : 100 , "consistency" : 100 , "difficulty" : "normal" , "lazyMode" : true , "language" : "english" , "punctuation" : true , "numbers" : true , "raw" : 0 , "wpm" : 0 , "timestamp" : 0 } ] } , "zen" : { "property1" : [ { "acc" : 100 , "consistency" : 100 , "difficulty" : "normal" , "lazyMode" : true , "language" : "english" , "punctuation" : true , "numbers" : true , "raw" : 0 , "wpm" : 0 , "timestamp" : 0 } ] , "property2" : [ { "acc" : 100 , "consistency" : 100 , "difficulty" : "normal" , "lazyMode" : true , "language" : "english" , "punctuation" : true , "numbers" : true , "raw" : 0 , "wpm" : 0 , "timestamp" : 0 } ] } } } ]
{ "_id" : "string" , "name" : "string" , "personalBests" : { "time" : { "property1" : [ { "acc" : 100 , "consistency" : 100 , "difficulty" : "normal" , "lazyMode" : true , "language" : "english" , "punctuation" : true , "numbers" : true , "raw" : 0 , "wpm" : 0 , "timestamp" : 0 } ] , "property2" : [ { "acc" : 100 , "consistency" : 100 , "difficulty" : "normal" , "lazyMode" : true , "language" : "english" , "punctuation" : true , "numbers" : true , "raw" : 0 , "wpm" : 0 , "timestamp" : 0 } ] } , "words" : { "property1" : [ { "acc" : 100 , "consistency" : 100 , "difficulty" : "normal" , "lazyMode" : true , "language" : "english" , "punctuation" : true , "numbers" : true , "raw" : 0 , "wpm" : 0 , "timestamp" : 0 } ] , "property2" : [ { "acc" : 100 , "consistency" : 100 , "difficulty" : "normal" , "lazyMode" : true , "language" : "english" , "punctuation" : true , "numbers" : true , "raw" : 0 , "wpm" : 0 , "timestamp" : 0 } ] } , "quote" : { "property1" : [ { "acc" : 100 , "consistency" : 100 , "difficulty" : "normal" , "lazyMode" : true , "language" : "english" , "punctuation" : true , "numbers" : true , "raw" : 0 , "wpm" : 0 , "timestamp" : 0 } ] , "property2" : [ { "acc" : 100 , "consistency" : 100 , "difficulty" : "normal" , "lazyMode" : true , "language" : "english" , "punctuation" : true , "numbers" : true , "raw" : 0 , "wpm" : 0 , "timestamp" : 0 } ] } , "custom" : { "property1" : [ { "acc" : 100 , "consistency" : 100 , "difficulty" : "normal" , "lazyMode" : true , "language" : "english" , "punctuation" : true , "numbers" : true , "raw" : 0 , "wpm" : 0 , "timestamp" : 0 } ] , "property2" : [ { "acc" : 100 , "consistency" : 100 , "difficulty" : "normal" , "lazyMode" : true , "language" : "english" , "punctuation" : true , "numbers" : true , "raw" : 0 , "wpm" : 0 , "timestamp" : 0 } ] } , "zen" : { "property1" : [ { "acc" : 100 , "consistency" : 100 , "difficulty" : "normal" , "lazyMode" : true , "language" : "english" , "punctuation" : true , "numbers" : true , "raw" : 0 , "wpm" : 0 , "timestamp" : 0 } ] , "property2" : [ { "acc" : 100 , "consistency" : 100 , "difficulty" : "normal" , "lazyMode" : true , "language" : "english" , "punctuation" : true , "numbers" : true , "raw" : 0 , "wpm" : 0 , "timestamp" : 0 } ] } } }
"_id" : "string" ,
"name" : "string" ,
"personalBests" : { "time" : { "property1" : [ { "acc" : 100 , "consistency" : 100 , "difficulty" : "normal" , "lazyMode" : true , "language" : "english" , "punctuation" : true , "numbers" : true , "raw" : 0 , "wpm" : 0 , "timestamp" : 0 } ] , "property2" : [ { "acc" : 100 , "consistency" : 100 , "difficulty" : "normal" , "lazyMode" : true , "language" : "english" , "punctuation" : true , "numbers" : true , "raw" : 0 , "wpm" : 0 , "timestamp" : 0 } ] } , "words" : { "property1" : [ { "acc" : 100 , "consistency" : 100 , "difficulty" : "normal" , "lazyMode" : true , "language" : "english" , "punctuation" : true , "numbers" : true , "raw" : 0 , "wpm" : 0 , "timestamp" : 0 } ] , "property2" : [ { "acc" : 100 , "consistency" : 100 , "difficulty" : "normal" , "lazyMode" : true , "language" : "english" , "punctuation" : true , "numbers" : true , "raw" : 0 , "wpm" : 0 , "timestamp" : 0 } ] } , "quote" : { "property1" : [ { "acc" : 100 , "consistency" : 100 , "difficulty" : "normal" , "lazyMode" : true , "language" : "english" , "punctuation" : true , "numbers" : true , "raw" : 0 , "wpm" : 0 , "timestamp" : 0 } ] , "property2" : [ { "acc" : 100 , "consistency" : 100 , "difficulty" : "normal" , "lazyMode" : true , "language" : "english" , "punctuation" : true , "numbers" : true , "raw" : 0 , "wpm" : 0 , "timestamp" : 0 } ] } , "custom" : { "property1" : [ { "acc" : 100 , "consistency" : 100 , "difficulty" : "normal" , "lazyMode" : true , "language" : "english" , "punctuation" : true , "numbers" : true , "raw" : 0 , "wpm" : 0 , "timestamp" : 0 } ] , "property2" : [ { "acc" : 100 , "consistency" : 100 , "difficulty" : "normal" , "lazyMode" : true , "language" : "english" , "punctuation" : true , "numbers" : true , "raw" : 0 , "wpm" : 0 , "timestamp" : 0 } ] } , "zen" : { "property1" : [ { "acc" : 100 , "consistency" : 100 , "difficulty" : "normal" , "lazyMode" : true , "language" : "english" , "punctuation" : true , "numbers" : true , "raw" : 0 , "wpm" : 0 , "timestamp" : 0 } ] , "property2" : [ { "acc" : 100 , "consistency" : 100 , "difficulty" : "normal" , "lazyMode" : true , "language" : "english" , "punctuation" : true , "numbers" : true , "raw" : 0 , "wpm" : 0 , "timestamp" : 0 } ] } }
"time" : { "property1" : [ { "acc" : 100 , "consistency" : 100 , "difficulty" : "normal" , "lazyMode" : true , "language" : "english" , "punctuation" : true , "numbers" : true , "raw" : 0 , "wpm" : 0 , "timestamp" : 0 } ] , "property2" : [ { "acc" : 100 , "consistency" : 100 , "difficulty" : "normal" , "lazyMode" : true , "language" : "english" , "punctuation" : true , "numbers" : true , "raw" : 0 , "wpm" : 0 , "timestamp" : 0 } ] } ,
"property1" : [ { "acc" : 100 , "consistency" : 100 , "difficulty" : "normal" , "lazyMode" : true , "language" : "english" , "punctuation" : true , "numbers" : true , "raw" : 0 , "wpm" : 0 , "timestamp" : 0 } ] ,
{ "acc" : 100 , "consistency" : 100 , "difficulty" : "normal" , "lazyMode" : true , "language" : "english" , "punctuation" : true , "numbers" : true , "raw" : 0 , "wpm" : 0 , "timestamp" : 0 }
"consistency" : 100 ,
"difficulty" : "normal" ,
"lazyMode" : true ,
"language" : "english" ,
"punctuation" : true ,
"numbers" : true ,
"timestamp" : 0
"property2" : [ { "acc" : 100 , "consistency" : 100 , "difficulty" : "normal" , "lazyMode" : true , "language" : "english" , "punctuation" : true , "numbers" : true , "raw" : 0 , "wpm" : 0 , "timestamp" : 0 } ]
{ "acc" : 100 , "consistency" : 100 , "difficulty" : "normal" , "lazyMode" : true , "language" : "english" , "punctuation" : true , "numbers" : true , "raw" : 0 , "wpm" : 0 , "timestamp" : 0 }
"consistency" : 100 ,
"difficulty" : "normal" ,
"lazyMode" : true ,
"language" : "english" ,
"punctuation" : true ,
"numbers" : true ,
"timestamp" : 0
"words" : { "property1" : [ { "acc" : 100 , "consistency" : 100 , "difficulty" : "normal" , "lazyMode" : true , "language" : "english" , "punctuation" : true , "numbers" : true , "raw" : 0 , "wpm" : 0 , "timestamp" : 0 } ] , "property2" : [ { "acc" : 100 , "consistency" : 100 , "difficulty" : "normal" , "lazyMode" : true , "language" : "english" , "punctuation" : true , "numbers" : true , "raw" : 0 , "wpm" : 0 , "timestamp" : 0 } ] } ,
"property1" : [ { "acc" : 100 , "consistency" : 100 , "difficulty" : "normal" , "lazyMode" : true , "language" : "english" , "punctuation" : true , "numbers" : true , "raw" : 0 , "wpm" : 0 , "timestamp" : 0 } ] ,
{ "acc" : 100 , "consistency" : 100 , "difficulty" : "normal" , "lazyMode" : true , "language" : "english" , "punctuation" : true , "numbers" : true , "raw" : 0 , "wpm" : 0 , "timestamp" : 0 }
"consistency" : 100 ,
"difficulty" : "normal" ,
"lazyMode" : true ,
"language" : "english" ,
"punctuation" : true ,
"numbers" : true ,
"timestamp" : 0
"property2" : [ { "acc" : 100 , "consistency" : 100 , "difficulty" : "normal" , "lazyMode" : true , "language" : "english" , "punctuation" : true , "numbers" : true , "raw" : 0 , "wpm" : 0 , "timestamp" : 0 } ]
{ "acc" : 100 , "consistency" : 100 , "difficulty" : "normal" , "lazyMode" : true , "language" : "english" , "punctuation" : true , "numbers" : true , "raw" : 0 , "wpm" : 0 , "timestamp" : 0 }
"consistency" : 100 ,
"difficulty" : "normal" ,
"lazyMode" : true ,
"language" : "english" ,
"punctuation" : true ,
"numbers" : true ,
"timestamp" : 0
"quote" : { "property1" : [ { "acc" : 100 , "consistency" : 100 , "difficulty" : "normal" , "lazyMode" : true , "language" : "english" , "punctuation" : true , "numbers" : true , "raw" : 0 , "wpm" : 0 , "timestamp" : 0 } ] , "property2" : [ { "acc" : 100 , "consistency" : 100 , "difficulty" : "normal" , "lazyMode" : true , "language" : "english" , "punctuation" : true , "numbers" : true , "raw" : 0 , "wpm" : 0 , "timestamp" : 0 } ] } ,
"property1" : [ { "acc" : 100 , "consistency" : 100 , "difficulty" : "normal" , "lazyMode" : true , "language" : "english" , "punctuation" : true , "numbers" : true , "raw" : 0 , "wpm" : 0 , "timestamp" : 0 } ] ,
{ "acc" : 100 , "consistency" : 100 , "difficulty" : "normal" , "lazyMode" : true , "language" : "english" , "punctuation" : true , "numbers" : true , "raw" : 0 , "wpm" : 0 , "timestamp" : 0 }
"consistency" : 100 ,
"difficulty" : "normal" ,
"lazyMode" : true ,
"language" : "english" ,
"punctuation" : true ,
"numbers" : true ,
"timestamp" : 0
"property2" : [ { "acc" : 100 , "consistency" : 100 , "difficulty" : "normal" , "lazyMode" : true , "language" : "english" , "punctuation" : true , "numbers" : true , "raw" : 0 , "wpm" : 0 , "timestamp" : 0 } ]
{ "acc" : 100 , "consistency" : 100 , "difficulty" : "normal" , "lazyMode" : true , "language" : "english" , "punctuation" : true , "numbers" : true , "raw" : 0 , "wpm" : 0 , "timestamp" : 0 }
"consistency" : 100 ,
"difficulty" : "normal" ,
"lazyMode" : true ,
"language" : "english" ,
"punctuation" : true ,
"numbers" : true ,
"timestamp" : 0
"custom" : { "property1" : [ { "acc" : 100 , "consistency" : 100 , "difficulty" : "normal" , "lazyMode" : true , "language" : "english" , "punctuation" : true , "numbers" : true , "raw" : 0 , "wpm" : 0 , "timestamp" : 0 } ] , "property2" : [ { "acc" : 100 , "consistency" : 100 , "difficulty" : "normal" , "lazyMode" : true , "language" : "english" , "punctuation" : true , "numbers" : true , "raw" : 0 , "wpm" : 0 , "timestamp" : 0 } ] } ,
"property1" : [ { "acc" : 100 , "consistency" : 100 , "difficulty" : "normal" , "lazyMode" : true , "language" : "english" , "punctuation" : true , "numbers" : true , "raw" : 0 , "wpm" : 0 , "timestamp" : 0 } ] ,
{ "acc" : 100 , "consistency" : 100 , "difficulty" : "normal" , "lazyMode" : true , "language" : "english" , "punctuation" : true , "numbers" : true , "raw" : 0 , "wpm" : 0 , "timestamp" : 0 }
"consistency" : 100 ,
"difficulty" : "normal" ,
"lazyMode" : true ,
"language" : "english" ,
"punctuation" : true ,
"numbers" : true ,
"timestamp" : 0
"property2" : [ { "acc" : 100 , "consistency" : 100 , "difficulty" : "normal" , "lazyMode" : true , "language" : "english" , "punctuation" : true , "numbers" : true , "raw" : 0 , "wpm" : 0 , "timestamp" : 0 } ]
{ "acc" : 100 , "consistency" : 100 , "difficulty" : "normal" , "lazyMode" : true , "language" : "english" , "punctuation" : true , "numbers" : true , "raw" : 0 , "wpm" : 0 , "timestamp" : 0 }
"consistency" : 100 ,
"difficulty" : "normal" ,
"lazyMode" : true ,
"language" : "english" ,
"punctuation" : true ,
"numbers" : true ,
"timestamp" : 0
"zen" : { "property1" : [ { "acc" : 100 , "consistency" : 100 , "difficulty" : "normal" , "lazyMode" : true , "language" : "english" , "punctuation" : true , "numbers" : true , "raw" : 0 , "wpm" : 0 , "timestamp" : 0 } ] , "property2" : [ { "acc" : 100 , "consistency" : 100 , "difficulty" : "normal" , "lazyMode" : true , "language" : "english" , "punctuation" : true , "numbers" : true , "raw" : 0 , "wpm" : 0 , "timestamp" : 0 } ] }
"property1" : [ { "acc" : 100 , "consistency" : 100 , "difficulty" : "normal" , "lazyMode" : true , "language" : "english" , "punctuation" : true , "numbers" : true , "raw" : 0 , "wpm" : 0 , "timestamp" : 0 } ] ,
{ "acc" : 100 , "consistency" : 100 , "difficulty" : "normal" , "lazyMode" : true , "language" : "english" , "punctuation" : true , "numbers" : true , "raw" : 0 , "wpm" : 0 , "timestamp" : 0 }
"consistency" : 100 ,
"difficulty" : "normal" ,
"lazyMode" : true ,
"language" : "english" ,
"punctuation" : true ,
"numbers" : true ,
"timestamp" : 0
"property2" : [ { "acc" : 100 , "consistency" : 100 , "difficulty" : "normal" , "lazyMode" : true , "language" : "english" , "punctuation" : true , "numbers" : true , "raw" : 0 , "wpm" : 0 , "timestamp" : 0 } ]
{ "acc" : 100 , "consistency" : 100 , "difficulty" : "normal" , "lazyMode" : true , "language" : "english" , "punctuation" : true , "numbers" : true , "raw" : 0 , "wpm" : 0 , "timestamp" : 0 }
"consistency" : 100 ,
"difficulty" : "normal" ,
"lazyMode" : true ,
"language" : "english" ,
"punctuation" : true ,
"numbers" : true ,
"timestamp" : 0
Gets a user's typing stats data.
Rate limit: This operation can be called up to 60 times per hour for regular users.
Generic client error
Authentication required but not provided or invalid
Operation not permitted
Request validation failed
Rate limit exceeded
ApeKey is inactive
ApeKey is malformed
ApeKey rate limit exceeded
Generic server error
Endpoint disabled or server is under maintenance
Production server
Response samples
"message" : "string" ,
"data" : { "completedTests" : 0 , "startedTests" : 0 , "timeTyping" : 0 }
"completedTests" : 0 ,
"startedTests" : 0 ,
"timeTyping" : 0
Gets a user's profile.
Rate limit: This operation can be called up to 100 times per hour for regular users.
Required configuration: This operation can only be called if the configuration for users.profiles.enabled is true .
Generic client error
Authentication required but not provided or invalid
Operation not permitted
Request validation failed
Rate limit exceeded
ApeKey is inactive
ApeKey is malformed
ApeKey rate limit exceeded
Generic server error
Endpoint disabled or server is under maintenance
Production server
Response samples
"message" : "string" ,
"data" : { "uid" : "string" , "name" : "string" , "banned" : true , "addedAt" : 0 , "discordId" : "string" , "discordAvatar" : "string" , "xp" : 0 , "lbOptOut" : true , "isPremium" : true , "inventory" : { "badges" : [ { "id" : 0 , "selected" : true } ] } , "allTimeLbs" : { "time" : { "property1" : { "property1" : { "rank" : 0 , "count" : 0 } , "property2" : { "rank" : 0 , "count" : 0 } } , "property2" : { "property1" : { "rank" : 0 , "count" : 0 } , "property2" : { "rank" : 0 , "count" : 0 } } } } , "testActivity" : { "testsByDays" : [ 0 ] , "lastDay" : 0 } , "typingStats" : { "completedTests" : 0 , "startedTests" : 0 , "timeTyping" : 0 } , "personalBests" : { "time" : { "property1" : [ { "acc" : 100 , "consistency" : 100 , "difficulty" : "normal" , "lazyMode" : true , "language" : "english" , "punctuation" : true , "numbers" : true , "raw" : 0 , "wpm" : 0 , "timestamp" : 0 } ] , "property2" : [ { "acc" : 100 , "consistency" : 100 , "difficulty" : "normal" , "lazyMode" : true , "language" : "english" , "punctuation" : true , "numbers" : true , "raw" : 0 , "wpm" : 0 , "timestamp" : 0 } ] } , "words" : { "property1" : [ { "acc" : 100 , "consistency" : 100 , "difficulty" : "normal" , "lazyMode" : true , "language" : "english" , "punctuation" : true , "numbers" : true , "raw" : 0 , "wpm" : 0 , "timestamp" : 0 } ] , "property2" : [ { "acc" : 100 , "consistency" : 100 , "difficulty" : "normal" , "lazyMode" : true , "language" : "english" , "punctuation" : true , "numbers" : true , "raw" : 0 , "wpm" : 0 , "timestamp" : 0 } ] } } , "streak" : 0 , "maxStreak" : 0 , "details" : { "bio" : "string" , "keyboard" : "string" , "socialProfiles" : { "twitter" : "string" , "github" : "string" , "website" : " http://example.com " } , "showActivityOnPublicProfile" : true } }
"uid" : "string" ,
"name" : "string" ,
"banned" : true ,
"addedAt" : 0 ,
"discordId" : "string" ,
"discordAvatar" : "string" ,
"lbOptOut" : true ,
"isPremium" : true ,
"inventory" : { "badges" : [ { "id" : 0 , "selected" : true } ] } ,
"badges" : [ { "id" : 0 , "selected" : true } ]
{ "id" : 0 , "selected" : true }
"selected" : true
"allTimeLbs" : { "time" : { "property1" : { "property1" : { "rank" : 0 , "count" : 0 } , "property2" : { "rank" : 0 , "count" : 0 } } , "property2" : { "property1" : { "rank" : 0 , "count" : 0 } , "property2" : { "rank" : 0 , "count" : 0 } } } } ,
"time" : { "property1" : { "property1" : { "rank" : 0 , "count" : 0 } , "property2" : { "rank" : 0 , "count" : 0 } } , "property2" : { "property1" : { "rank" : 0 , "count" : 0 } , "property2" : { "rank" : 0 , "count" : 0 } } }
"property1" : { "property1" : { "rank" : 0 , "count" : 0 } , "property2" : { "rank" : 0 , "count" : 0 } } ,
"property1" : { "rank" : 0 , "count" : 0 } ,
"property2" : { "rank" : 0 , "count" : 0 }
"property2" : { "property1" : { "rank" : 0 , "count" : 0 } , "property2" : { "rank" : 0 , "count" : 0 } }
"property1" : { "rank" : 0 , "count" : 0 } ,
"property2" : { "rank" : 0 , "count" : 0 }
"testActivity" : { "testsByDays" : [ 0 ] , "lastDay" : 0 } ,
"testsByDays" : [ 0 ] ,
"typingStats" : { "completedTests" : 0 , "startedTests" : 0 , "timeTyping" : 0 } ,
"completedTests" : 0 ,
"startedTests" : 0 ,
"timeTyping" : 0
"personalBests" : { "time" : { "property1" : [ { "acc" : 100 , "consistency" : 100 , "difficulty" : "normal" , "lazyMode" : true , "language" : "english" , "punctuation" : true , "numbers" : true , "raw" : 0 , "wpm" : 0 , "timestamp" : 0 } ] , "property2" : [ { "acc" : 100 , "consistency" : 100 , "difficulty" : "normal" , "lazyMode" : true , "language" : "english" , "punctuation" : true , "numbers" : true , "raw" : 0 , "wpm" : 0 , "timestamp" : 0 } ] } , "words" : { "property1" : [ { "acc" : 100 , "consistency" : 100 , "difficulty" : "normal" , "lazyMode" : true , "language" : "english" , "punctuation" : true , "numbers" : true , "raw" : 0 , "wpm" : 0 , "timestamp" : 0 } ] , "property2" : [ { "acc" : 100 , "consistency" : 100 , "difficulty" : "normal" , "lazyMode" : true , "language" : "english" , "punctuation" : true , "numbers" : true , "raw" : 0 , "wpm" : 0 , "timestamp" : 0 } ] } } ,
"time" : { "property1" : [ { "acc" : 100 , "consistency" : 100 , "difficulty" : "normal" , "lazyMode" : true , "language" : "english" , "punctuation" : true , "numbers" : true , "raw" : 0 , "wpm" : 0 , "timestamp" : 0 } ] , "property2" : [ { "acc" : 100 , "consistency" : 100 , "difficulty" : "normal" , "lazyMode" : true , "language" : "english" , "punctuation" : true , "numbers" : true , "raw" : 0 , "wpm" : 0 , "timestamp" : 0 } ] } ,
"property1" : [ { "acc" : 100 , "consistency" : 100 , "difficulty" : "normal" , "lazyMode" : true , "language" : "english" , "punctuation" : true , "numbers" : true , "raw" : 0 , "wpm" : 0 , "timestamp" : 0 } ] ,
{ "acc" : 100 , "consistency" : 100 , "difficulty" : "normal" , "lazyMode" : true , "language" : "english" , "punctuation" : true , "numbers" : true , "raw" : 0 , "wpm" : 0 , "timestamp" : 0 }
"consistency" : 100 ,
"difficulty" : "normal" ,
"lazyMode" : true ,
"language" : "english" ,
"punctuation" : true ,
"numbers" : true ,
"timestamp" : 0
"property2" : [ { "acc" : 100 , "consistency" : 100 , "difficulty" : "normal" , "lazyMode" : true , "language" : "english" , "punctuation" : true , "numbers" : true , "raw" : 0 , "wpm" : 0 , "timestamp" : 0 } ]
{ "acc" : 100 , "consistency" : 100 , "difficulty" : "normal" , "lazyMode" : true , "language" : "english" , "punctuation" : true , "numbers" : true , "raw" : 0 , "wpm" : 0 , "timestamp" : 0 }
"consistency" : 100 ,
"difficulty" : "normal" ,
"lazyMode" : true ,
"language" : "english" ,
"punctuation" : true ,
"numbers" : true ,
"timestamp" : 0
"words" : { "property1" : [ { "acc" : 100 , "consistency" : 100 , "difficulty" : "normal" , "lazyMode" : true , "language" : "english" , "punctuation" : true , "numbers" : true , "raw" : 0 , "wpm" : 0 , "timestamp" : 0 } ] , "property2" : [ { "acc" : 100 , "consistency" : 100 , "difficulty" : "normal" , "lazyMode" : true , "language" : "english" , "punctuation" : true , "numbers" : true , "raw" : 0 , "wpm" : 0 , "timestamp" : 0 } ] }
"property1" : [ { "acc" : 100 , "consistency" : 100 , "difficulty" : "normal" , "lazyMode" : true , "language" : "english" , "punctuation" : true , "numbers" : true , "raw" : 0 , "wpm" : 0 , "timestamp" : 0 } ] ,
{ "acc" : 100 , "consistency" : 100 , "difficulty" : "normal" , "lazyMode" : true , "language" : "english" , "punctuation" : true , "numbers" : true , "raw" : 0 , "wpm" : 0 , "timestamp" : 0 }
"consistency" : 100 ,
"difficulty" : "normal" ,
"lazyMode" : true ,
"language" : "english" ,
"punctuation" : true ,
"numbers" : true ,
"timestamp" : 0
"property2" : [ { "acc" : 100 , "consistency" : 100 , "difficulty" : "normal" , "lazyMode" : true , "language" : "english" , "punctuation" : true , "numbers" : true , "raw" : 0 , "wpm" : 0 , "timestamp" : 0 } ]
{ "acc" : 100 , "consistency" : 100 , "difficulty" : "normal" , "lazyMode" : true , "language" : "english" , "punctuation" : true , "numbers" : true , "raw" : 0 , "wpm" : 0 , "timestamp" : 0 }
"consistency" : 100 ,
"difficulty" : "normal" ,
"lazyMode" : true ,
"language" : "english" ,
"punctuation" : true ,
"numbers" : true ,
"timestamp" : 0
"maxStreak" : 0 ,
"details" : { "bio" : "string" , "keyboard" : "string" , "socialProfiles" : { "twitter" : "string" , "github" : "string" , "website" : " http://example.com " } , "showActivityOnPublicProfile" : true }
"bio" : "string" ,
"keyboard" : "string" ,
"socialProfiles" : { "twitter" : "string" , "github" : "string" , "website" : " http://example.com " } ,
"twitter" : "string" ,
"github" : "string" ,
"website" : " http://example.com "
"showActivityOnPublicProfile" : true
send forgot password email
Send a forgot password email.
Rate limit: This operation can be called up to 1 times per minute for regular users.
Generic client error
Authentication required but not provided or invalid
Operation not permitted
Request validation failed
Rate limit exceeded
ApeKey is inactive
ApeKey is malformed
ApeKey rate limit exceeded
Generic server error
Endpoint disabled or server is under maintenance
Production server
Request samples
"captcha" : "string" ,
"email" : " [email protected] "
Response samples
"message" : "string"
get current test activity
Get test activity for the last up to 372 days for the current user .
Rate limit: This operation can be called up to 60 times per hour for regular users.
Generic client error
Authentication required but not provided or invalid
Operation not permitted
Request validation failed
Rate limit exceeded
ApeKey is inactive
ApeKey is malformed
ApeKey rate limit exceeded
Generic server error
Endpoint disabled or server is under maintenance
Production server
Response samples
"message" : "string" ,
"data" : { "testsByDays" : [ 0 ] , "lastDay" : 0 }
"testsByDays" : [ 0 ] ,
Get user's streak data.
Rate limit: This operation can be called up to 60 times per hour for regular users.
Generic client error
Authentication required but not provided or invalid
Operation not permitted
Request validation failed
Rate limit exceeded
ApeKey is inactive
ApeKey is malformed
ApeKey rate limit exceeded
Generic server error
Endpoint disabled or server is under maintenance
Production server
Response samples
"message" : "string" ,
"data" : { "lastResultTimestamp" : 0 , "length" : 0 , "maxLength" : 0 , "hourOffset" : -11 }
"lastResultTimestamp" : 0 ,
"maxLength" : 0 ,
"hourOffset" : -11
User test results
Gets up to 1000 results.
Rate limit: This operation can be called up to 60 times per hour for regular users and up to 30 times per day with ApeKeys.
Timestamp of the earliest result to fetch. If omitted the most recent results are fetched.
Offset of the item at which to begin the response.
Limit results to the given amount.
Generic client error
Authentication required but not provided or invalid
Operation not permitted
Request validation failed
Rate limit exceeded
ApeKey is inactive
ApeKey is malformed
ApeKey rate limit exceeded
Generic server error
Endpoint disabled or server is under maintenance
Production server
Response samples
"message" : "string" ,
"data" : [ { "wpm" : 420 , "rawWpm" : 420 , "charStats" : null , "acc" : 50 , "mode" : "time" , "mode2" : "string" , "quoteLength" : 3 , "timestamp" : 0 , "testDuration" : 1 , "consistency" : 100 , "keyConsistency" : 100 , "uid" : "string" , "restartCount" : 0 , "incompleteTestSeconds" : 0 , "afkDuration" : 0 , "tags" : [ "string" ] , "bailedOut" : true , "blindMode" : true , "lazyMode" : true , "funbox" : [ "58008" ] , "language" : "english" , "difficulty" : "normal" , "numbers" : true , "punctuation" : true , "_id" : "string" , "isPb" : true } ]
{ "wpm" : 420 , "rawWpm" : 420 , "charStats" : null , "acc" : 50 , "mode" : "time" , "mode2" : "string" , "quoteLength" : 3 , "timestamp" : 0 , "testDuration" : 1 , "consistency" : 100 , "keyConsistency" : 100 , "uid" : "string" , "restartCount" : 0 , "incompleteTestSeconds" : 0 , "afkDuration" : 0 , "tags" : [ "string" ] , "bailedOut" : true , "blindMode" : true , "lazyMode" : true , "funbox" : [ "58008" ] , "language" : "english" , "difficulty" : "normal" , "numbers" : true , "punctuation" : true , "_id" : "string" , "isPb" : true }
"rawWpm" : 420 ,
"charStats" : null ,
"mode" : "time" ,
"mode2" : "string" ,
"quoteLength" : 3 ,
"timestamp" : 0 ,
"testDuration" : 1 ,
"consistency" : 100 ,
"keyConsistency" : 100 ,
"uid" : "string" ,
"restartCount" : 0 ,
"incompleteTestSeconds" : 0 ,
"afkDuration" : 0 ,
"tags" : [ "string" ] ,
"bailedOut" : true ,
"blindMode" : true ,
"lazyMode" : true ,
"funbox" : [ "58008" ] ,
"language" : "english" ,
"difficulty" : "normal" ,
"numbers" : true ,
"punctuation" : true ,
"_id" : "string" ,
get result by id
Get result by id.
Rate limit: This operation can be called up to 300 times per hour for regular users and up to 60 times per hour with ApeKeys.
Generic client error
Authentication required but not provided or invalid
Operation not permitted
Request validation failed
Rate limit exceeded
ApeKey is inactive
ApeKey is malformed
ApeKey rate limit exceeded
Generic server error
Endpoint disabled or server is under maintenance
Production server
Response samples
"message" : "string" ,
"data" : { "wpm" : 420 , "rawWpm" : 420 , "charStats" : null , "acc" : 50 , "mode" : "time" , "mode2" : "string" , "quoteLength" : 3 , "timestamp" : 0 , "testDuration" : 1 , "consistency" : 100 , "keyConsistency" : 100 , "chartData" : { "wpm" : [ 0 ] , "burst" : [ 0 ] , "err" : [ 0 ] } , "uid" : "string" , "restartCount" : 0 , "incompleteTestSeconds" : 0 , "afkDuration" : 0 , "tags" : [ "string" ] , "bailedOut" : true , "blindMode" : true , "lazyMode" : true , "funbox" : [ "58008" ] , "language" : "english" , "difficulty" : "normal" , "numbers" : true , "punctuation" : true , "_id" : "string" , "keySpacingStats" : { "average" : 0 , "sd" : 0 } , "keyDurationStats" : { "average" : 0 , "sd" : 0 } , "name" : "string" , "isPb" : true }
"rawWpm" : 420 ,
"charStats" : null ,
"mode" : "time" ,
"mode2" : "string" ,
"quoteLength" : 3 ,
"timestamp" : 0 ,
"testDuration" : 1 ,
"consistency" : 100 ,
"keyConsistency" : 100 ,
"chartData" : { "wpm" : [ 0 ] , "burst" : [ 0 ] , "err" : [ 0 ] } ,
"wpm" : [ 0 ] ,
"burst" : [ 0 ] ,
"uid" : "string" ,
"restartCount" : 0 ,
"incompleteTestSeconds" : 0 ,
"afkDuration" : 0 ,
"tags" : [ "string" ] ,
"bailedOut" : true ,
"blindMode" : true ,
"lazyMode" : true ,
"funbox" : [ "58008" ] ,
"language" : "english" ,
"difficulty" : "normal" ,
"numbers" : true ,
"punctuation" : true ,
"_id" : "string" ,
"keySpacingStats" : { "average" : 0 , "sd" : 0 } ,
"average" : 0 ,
"keyDurationStats" : { "average" : 0 , "sd" : 0 } ,
"average" : 0 ,
"name" : "string" ,
get last result
Gets a user's last saved result.
Rate limit: This operation can be called up to 60 times per hour for regular users.
Generic client error
Authentication required but not provided or invalid
Operation not permitted
Request validation failed
Rate limit exceeded
ApeKey is inactive
ApeKey is malformed
ApeKey rate limit exceeded
Generic server error
Endpoint disabled or server is under maintenance
Production server
Response samples
"message" : "string" ,
"data" : { "wpm" : 420 , "rawWpm" : 420 , "charStats" : null , "acc" : 50 , "mode" : "time" , "mode2" : "string" , "quoteLength" : 3 , "timestamp" : 0 , "testDuration" : 1 , "consistency" : 100 , "keyConsistency" : 100 , "chartData" : { "wpm" : [ 0 ] , "burst" : [ 0 ] , "err" : [ 0 ] } , "uid" : "string" , "restartCount" : 0 , "incompleteTestSeconds" : 0 , "afkDuration" : 0 , "tags" : [ "string" ] , "bailedOut" : true , "blindMode" : true , "lazyMode" : true , "funbox" : [ "58008" ] , "language" : "english" , "difficulty" : "normal" , "numbers" : true , "punctuation" : true , "_id" : "string" , "keySpacingStats" : { "average" : 0 , "sd" : 0 } , "keyDurationStats" : { "average" : 0 , "sd" : 0 } , "name" : "string" , "isPb" : true }
"rawWpm" : 420 ,
"charStats" : null ,
"mode" : "time" ,
"mode2" : "string" ,
"quoteLength" : 3 ,
"timestamp" : 0 ,
"testDuration" : 1 ,
"consistency" : 100 ,
"keyConsistency" : 100 ,
"chartData" : { "wpm" : [ 0 ] , "burst" : [ 0 ] , "err" : [ 0 ] } ,
"wpm" : [ 0 ] ,
"burst" : [ 0 ] ,
"uid" : "string" ,
"restartCount" : 0 ,
"incompleteTestSeconds" : 0 ,
"afkDuration" : 0 ,
"tags" : [ "string" ] ,
"bailedOut" : true ,
"blindMode" : true ,
"lazyMode" : true ,
"funbox" : [ "58008" ] ,
"language" : "english" ,
"difficulty" : "normal" ,
"numbers" : true ,
"punctuation" : true ,
"_id" : "string" ,
"keySpacingStats" : { "average" : 0 , "sd" : 0 } ,
"average" : 0 ,
"keyDurationStats" : { "average" : 0 , "sd" : 0 } ,
"average" : 0 ,
"name" : "string" ,
Public endpoints such as typing stats.
get speed histogram
get number of users personal bests grouped by wpm level (multiples of ten).
Rate limit: This operation can be called up to 60 times per minute for regular users.
Generic client error
Authentication required but not provided or invalid
Operation not permitted
Request validation failed
Rate limit exceeded
ApeKey is inactive
ApeKey is malformed
ApeKey rate limit exceeded
Generic server error
Endpoint disabled or server is under maintenance
Production server
Response samples
"message" : "string" ,
"data" : { "property1" : 0 , "property2" : 0 }
"property1" : 0 ,
"property2" : 0
get typing stats
get number of tests and time users spend typing.
Rate limit: This operation can be called up to 60 times per minute for regular users.
Generic client error
Authentication required but not provided or invalid
Operation not permitted
Request validation failed
Rate limit exceeded
ApeKey is inactive
ApeKey is malformed
ApeKey rate limit exceeded
Generic server error
Endpoint disabled or server is under maintenance
Production server
Response samples
"message" : "string" ,
"data" : { "timeTyping" : 0 , "testsCompleted" : 0 , "testsStarted" : 0 }
"timeTyping" : 0 ,
"testsCompleted" : 0 ,
"testsStarted" : 0
All-time and daily leaderboards of the fastest typers.
get leaderboard
Get all-time leaderboard.
Rate limit: This operation can be called up to 500 times per hour for regular users.
include only users from your friends list, defaults to false.
Generic client error
Authentication required but not provided or invalid
Operation not permitted
Request validation failed
Rate limit exceeded
ApeKey is inactive
ApeKey is malformed
ApeKey rate limit exceeded
Generic server error
Endpoint disabled or server is under maintenance
Production server
Response samples
"message" : "string" ,
"data" : { "count" : 0 , "pageSize" : 0 , "entries" : [ { "wpm" : 0 , "acc" : 100 , "timestamp" : 0 , "raw" : 0 , "consistency" : 0 , "uid" : "string" , "name" : "string" , "discordId" : "string" , "discordAvatar" : "string" , "rank" : 0 , "friendsRank" : 0 , "badgeId" : 0 , "isPremium" : true } ] }
"pageSize" : 0 ,
"entries" : [ { "wpm" : 0 , "acc" : 100 , "timestamp" : 0 , "raw" : 0 , "consistency" : 0 , "uid" : "string" , "name" : "string" , "discordId" : "string" , "discordAvatar" : "string" , "rank" : 0 , "friendsRank" : 0 , "badgeId" : 0 , "isPremium" : true } ]
{ "wpm" : 0 , "acc" : 100 , "timestamp" : 0 , "raw" : 0 , "consistency" : 0 , "uid" : "string" , "name" : "string" , "discordId" : "string" , "discordAvatar" : "string" , "rank" : 0 , "friendsRank" : 0 , "badgeId" : 0 , "isPremium" : true }
"timestamp" : 0 ,
"consistency" : 0 ,
"uid" : "string" ,
"name" : "string" ,
"discordId" : "string" ,
"discordAvatar" : "string" ,
"friendsRank" : 0 ,
"badgeId" : 0 ,
"isPremium" : true
get leaderboard rank
Get the rank of the current user on the all-time leaderboard.
Rate limit: This operation can be called up to 500 times per hour for regular users.
include only users from your friends list, defaults to false.
Generic client error
Authentication required but not provided or invalid
Operation not permitted
Request validation failed
Rate limit exceeded
ApeKey is inactive
ApeKey is malformed
ApeKey rate limit exceeded
Generic server error
Endpoint disabled or server is under maintenance
Production server
Response samples
"message" : "string" ,
"data" : { "wpm" : 0 , "acc" : 100 , "timestamp" : 0 , "raw" : 0 , "consistency" : 0 , "uid" : "string" , "name" : "string" , "discordId" : "string" , "discordAvatar" : "string" , "rank" : 0 , "friendsRank" : 0 , "badgeId" : 0 , "isPremium" : true }
"timestamp" : 0 ,
"consistency" : 0 ,
"uid" : "string" ,
"name" : "string" ,
"discordId" : "string" ,
"discordAvatar" : "string" ,
"friendsRank" : 0 ,
"badgeId" : 0 ,
"isPremium" : true
get daily leaderboard
Get daily leaderboard.
Rate limit: This operation can be called up to 500 times per hour for regular users.
Required configuration: This operation can only be called if the configuration for dailyLeaderboards.enabled is true .
include only users from your friends list, defaults to false.
Generic client error
Authentication required but not provided or invalid
Operation not permitted
Request validation failed
Rate limit exceeded
ApeKey is inactive
ApeKey is malformed
ApeKey rate limit exceeded
Generic server error
Endpoint disabled or server is under maintenance
Production server
Response samples
"message" : "string" ,
"data" : { "count" : 0 , "pageSize" : 0 , "entries" : [ { "wpm" : 0 , "acc" : 100 , "timestamp" : 0 , "raw" : 0 , "consistency" : 0 , "uid" : "string" , "name" : "string" , "discordId" : "string" , "discordAvatar" : "string" , "rank" : 0 , "friendsRank" : 0 , "badgeId" : 0 , "isPremium" : true } ] , "minWpm" : 0 }
"pageSize" : 0 ,
"entries" : [ { "wpm" : 0 , "acc" : 100 , "timestamp" : 0 , "raw" : 0 , "consistency" : 0 , "uid" : "string" , "name" : "string" , "discordId" : "string" , "discordAvatar" : "string" , "rank" : 0 , "friendsRank" : 0 , "badgeId" : 0 , "isPremium" : true } ] ,
{ "wpm" : 0 , "acc" : 100 , "timestamp" : 0 , "raw" : 0 , "consistency" : 0 , "uid" : "string" , "name" : "string" , "discordId" : "string" , "discordAvatar" : "string" , "rank" : 0 , "friendsRank" : 0 , "badgeId" : 0 , "isPremium" : true }
"timestamp" : 0 ,
"consistency" : 0 ,
"uid" : "string" ,
"name" : "string" ,
"discordId" : "string" ,
"discordAvatar" : "string" ,
"friendsRank" : 0 ,
"badgeId" : 0 ,
"isPremium" : true
get weekly xp leaderboard
Get weekly xp leaderboard.
Rate limit: This operation can be called up to 500 times per hour for regular users.
Required configuration: This operation can only be called if the configuration for leaderboards.weeklyXp.enabled is true .
include only users from your friends list, defaults to false.
Generic client error
Authentication required but not provided or invalid
Operation not permitted
Request validation failed
Rate limit exceeded
ApeKey is inactive
ApeKey is malformed
ApeKey rate limit exceeded
Generic server error
Endpoint disabled or server is under maintenance
Production server
Response samples
"message" : "string" ,
"data" : { "count" : 0 , "pageSize" : 0 , "entries" : [ { "uid" : "string" , "name" : "string" , "lastActivityTimestamp" : 0 , "timeTypedSeconds" : 0 , "discordId" : "string" , "discordAvatar" : "string" , "badgeId" : 0 , "isPremium" : true , "totalXp" : 0 , "rank" : 0 , "friendsRank" : 0 } ] }
"pageSize" : 0 ,
"entries" : [ { "uid" : "string" , "name" : "string" , "lastActivityTimestamp" : 0 , "timeTypedSeconds" : 0 , "discordId" : "string" , "discordAvatar" : "string" , "badgeId" : 0 , "isPremium" : true , "totalXp" : 0 , "rank" : 0 , "friendsRank" : 0 } ]
{ "uid" : "string" , "name" : "string" , "lastActivityTimestamp" : 0 , "timeTypedSeconds" : 0 , "discordId" : "string" , "discordAvatar" : "string" , "badgeId" : 0 , "isPremium" : true , "totalXp" : 0 , "rank" : 0 , "friendsRank" : 0 }
"uid" : "string" ,
"name" : "string" ,
"lastActivityTimestamp" : 0 ,
"timeTypedSeconds" : 0 ,
"discordId" : "string" ,
"discordAvatar" : "string" ,
"badgeId" : 0 ,
"isPremium" : true ,
"totalXp" : 0 ,
"friendsRank" : 0
Public service announcements.
Get list of public service announcements.
Rate limit: This operation can be called up to 60 times per minute for regular users.
Generic client error
Authentication required but not provided or invalid
Operation not permitted
Request validation failed
Rate limit exceeded
ApeKey is inactive
ApeKey is malformed
ApeKey rate limit exceeded
Generic server error
Endpoint disabled or server is under maintenance
Production server
Response samples
"message" : "string" ,
"data" : [ { "_id" : "string" , "message" : "string" , "date" : 0 , "level" : 0 , "sticky" : true } ]
{ "_id" : "string" , "message" : "string" , "date" : 0 , "level" : 0 , "sticky" : true }
"_id" : "string" ,
"message" : "string" ,
"sticky" : true
Quote ratings and new quote submissions
is submission enabled
Check if submissions are enabled.
Rate limit: This operation can be called up to 60 times per minute for regular users.
Generic client error
Authentication required but not provided or invalid
Operation not permitted
Request validation failed
Rate limit exceeded
ApeKey is inactive
ApeKey is malformed
ApeKey rate limit exceeded
Generic server error
Endpoint disabled or server is under maintenance
Production server
Response samples
"message" : "string" ,
"data" : { "isEnabled" : true }
"isEnabled" : true
Server configuration
Server configuration
get configuration
Get server configuration.
Generic client error
Authentication required but not provided or invalid
Operation not permitted
Request validation failed
Rate limit exceeded
ApeKey is inactive
ApeKey is malformed
ApeKey rate limit exceeded
Generic server error
Endpoint disabled or server is under maintenance
Production server
Response samples
"message" : "string" ,
"data" : { "maintenance" : true , "dev" : { "responseSlowdownMs" : 0 } , "quotes" : { "reporting" : { "enabled" : true , "maxReports" : 0 , "contentReportLimit" : 0 } , "submissionsEnabled" : true , "maxFavorites" : 0 } , "results" : { "savingEnabled" : true , "objectHashCheckEnabled" : true , "filterPresets" : { "enabled" : true , "maxPresetsPerUser" : 0 } , "limits" : { "regularUser" : 0 , "premiumUser" : 0 } , "maxBatchSize" : 0 } , "users" : { "signUp" : true , "lastHashesCheck" : { "enabled" : true , "maxHashes" : 0 } , "autoBan" : { "enabled" : true , "maxCount" : 0 , "maxHours" : 0 } , "profiles" : { "enabled" : true } , "discordIntegration" : { "enabled" : true } , "xp" : { "enabled" : true , "funboxBonus" : 0 , "gainMultiplier" : 0 , "maxDailyBonus" : 0 , "minDailyBonus" : 0 , "streak" : { "enabled" : true , "maxStreakDays" : 0 , "maxStreakMultiplier" : 0 } } , "inbox" : { "enabled" : true , "maxMail" : 0 } , "premium" : { "enabled" : true } } , "admin" : { "endpointsEnabled" : true } , "apeKeys" : { "endpointsEnabled" : true , "acceptKeys" : true , "maxKeysPerUser" : 0 , "apeKeyBytes" : 0 , "apeKeySaltRounds" : 0 } , "rateLimiting" : { "badAuthentication" : { "enabled" : true , "penalty" : 0 , "flaggedStatusCodes" : [ 0 ] } } , "dailyLeaderboards" : { "enabled" : true , "leaderboardExpirationTimeInDays" : 0 , "maxResults" : 0 , "validModeRules" : [ { "language" : "string" , "mode" : "string" , "mode2" : "string" } ] , "scheduleRewardsModeRules" : [ { "language" : "string" , "mode" : "string" , "mode2" : "string" } ] , "topResultsToAnnounce" : 0 , "xpRewardBrackets" : [ { "minRank" : 0 , "maxRank" : 0 , "minReward" : 0 , "maxReward" : 0 } ] } , "leaderboards" : { "minTimeTyping" : 0 , "weeklyXp" : { "enabled" : true , "expirationTimeInDays" : 0 , "xpRewardBrackets" : [ { "minRank" : 0 , "maxRank" : 0 , "minReward" : 0 , "maxReward" : 0 } ] } } , "connections" : { "enabled" : true , "maxPerUser" : 0 } }
"maintenance" : true ,
"dev" : { "responseSlowdownMs" : 0 } ,
"responseSlowdownMs" : 0
"quotes" : { "reporting" : { "enabled" : true , "maxReports" : 0 , "contentReportLimit" : 0 } , "submissionsEnabled" : true , "maxFavorites" : 0 } ,
"reporting" : { "enabled" : true , "maxReports" : 0 , "contentReportLimit" : 0 } ,
"enabled" : true ,
"maxReports" : 0 ,
"contentReportLimit" : 0
"submissionsEnabled" : true ,
"maxFavorites" : 0
"results" : { "savingEnabled" : true , "objectHashCheckEnabled" : true , "filterPresets" : { "enabled" : true , "maxPresetsPerUser" : 0 } , "limits" : { "regularUser" : 0 , "premiumUser" : 0 } , "maxBatchSize" : 0 } ,
"savingEnabled" : true ,
"objectHashCheckEnabled" : true ,
"filterPresets" : { "enabled" : true , "maxPresetsPerUser" : 0 } ,
"enabled" : true ,
"maxPresetsPerUser" : 0
"limits" : { "regularUser" : 0 , "premiumUser" : 0 } ,
"regularUser" : 0 ,
"premiumUser" : 0
"maxBatchSize" : 0
"users" : { "signUp" : true , "lastHashesCheck" : { "enabled" : true , "maxHashes" : 0 } , "autoBan" : { "enabled" : true , "maxCount" : 0 , "maxHours" : 0 } , "profiles" : { "enabled" : true } , "discordIntegration" : { "enabled" : true } , "xp" : { "enabled" : true , "funboxBonus" : 0 , "gainMultiplier" : 0 , "maxDailyBonus" : 0 , "minDailyBonus" : 0 , "streak" : { "enabled" : true , "maxStreakDays" : 0 , "maxStreakMultiplier" : 0 } } , "inbox" : { "enabled" : true , "maxMail" : 0 } , "premium" : { "enabled" : true } } ,
"signUp" : true ,
"lastHashesCheck" : { "enabled" : true , "maxHashes" : 0 } ,
"enabled" : true ,
"maxHashes" : 0
"autoBan" : { "enabled" : true , "maxCount" : 0 , "maxHours" : 0 } ,
"enabled" : true ,
"maxCount" : 0 ,
"profiles" : { "enabled" : true } ,
"enabled" : true
"discordIntegration" : { "enabled" : true } ,
"enabled" : true
"xp" : { "enabled" : true , "funboxBonus" : 0 , "gainMultiplier" : 0 , "maxDailyBonus" : 0 , "minDailyBonus" : 0 , "streak" : { "enabled" : true , "maxStreakDays" : 0 , "maxStreakMultiplier" : 0 } } ,
"enabled" : true ,
"funboxBonus" : 0 ,
"gainMultiplier" : 0 ,
"maxDailyBonus" : 0 ,
"minDailyBonus" : 0 ,
"streak" : { "enabled" : true , "maxStreakDays" : 0 , "maxStreakMultiplier" : 0 }
"enabled" : true ,
"maxStreakDays" : 0 ,
"maxStreakMultiplier" : 0
"inbox" : { "enabled" : true , "maxMail" : 0 } ,
"enabled" : true ,
"premium" : { "enabled" : true }
"enabled" : true
"admin" : { "endpointsEnabled" : true } ,
"endpointsEnabled" : true
"apeKeys" : { "endpointsEnabled" : true , "acceptKeys" : true , "maxKeysPerUser" : 0 , "apeKeyBytes" : 0 , "apeKeySaltRounds" : 0 } ,
"endpointsEnabled" : true ,
"acceptKeys" : true ,
"maxKeysPerUser" : 0 ,
"apeKeyBytes" : 0 ,
"apeKeySaltRounds" : 0
"rateLimiting" : { "badAuthentication" : { "enabled" : true , "penalty" : 0 , "flaggedStatusCodes" : [ 0 ] } } ,
"badAuthentication" : { "enabled" : true , "penalty" : 0 , "flaggedStatusCodes" : [ 0 ] }
"enabled" : true ,
"penalty" : 0 ,
"flaggedStatusCodes" : [ 0 ]
"dailyLeaderboards" : { "enabled" : true , "leaderboardExpirationTimeInDays" : 0 , "maxResults" : 0 , "validModeRules" : [ { "language" : "string" , "mode" : "string" , "mode2" : "string" } ] , "scheduleRewardsModeRules" : [ { "language" : "string" , "mode" : "string" , "mode2" : "string" } ] , "topResultsToAnnounce" : 0 , "xpRewardBrackets" : [ { "minRank" : 0 , "maxRank" : 0 , "minReward" : 0 , "maxReward" : 0 } ] } ,
"enabled" : true ,
"leaderboardExpirationTimeInDays" : 0 ,
"maxResults" : 0 ,
"validModeRules" : [ { "language" : "string" , "mode" : "string" , "mode2" : "string" } ] ,
{ "language" : "string" , "mode" : "string" , "mode2" : "string" }
"language" : "string" ,
"mode" : "string" ,
"mode2" : "string"
"scheduleRewardsModeRules" : [ { "language" : "string" , "mode" : "string" , "mode2" : "string" } ] ,
{ "language" : "string" , "mode" : "string" , "mode2" : "string" }
"language" : "string" ,
"mode" : "string" ,
"mode2" : "string"
"topResultsToAnnounce" : 0 ,
"xpRewardBrackets" : [ { "minRank" : 0 , "maxRank" : 0 , "minReward" : 0 , "maxReward" : 0 } ]
{ "minRank" : 0 , "maxRank" : 0 , "minReward" : 0 , "maxReward" : 0 }
"minRank" : 0 ,
"maxRank" : 0 ,
"minReward" : 0 ,
"maxReward" : 0
"leaderboards" : { "minTimeTyping" : 0 , "weeklyXp" : { "enabled" : true , "expirationTimeInDays" : 0 , "xpRewardBrackets" : [ { "minRank" : 0 , "maxRank" : 0 , "minReward" : 0 , "maxReward" : 0 } ] } } ,
"minTimeTyping" : 0 ,
"weeklyXp" : { "enabled" : true , "expirationTimeInDays" : 0 , "xpRewardBrackets" : [ { "minRank" : 0 , "maxRank" : 0 , "minReward" : 0 , "maxReward" : 0 } ] }
"enabled" : true ,
"expirationTimeInDays" : 0 ,
"xpRewardBrackets" : [ { "minRank" : 0 , "maxRank" : 0 , "minReward" : 0 , "maxReward" : 0 } ]
{ "minRank" : 0 , "maxRank" : 0 , "minReward" : 0 , "maxReward" : 0 }
"minRank" : 0 ,
"maxRank" : 0 ,
"minReward" : 0 ,
"maxReward" : 0
"connections" : { "enabled" : true , "maxPerUser" : 0 }
"enabled" : true ,
"maxPerUser" : 0
Endpoints for incoming webhooks.