API

auth

auth.
login

Login: Get an access token.

On success, token is a valid token and error is empty. On failure, token is empty and error is a message.

input
CredentialsIn
output
CredentialsOut

auth.
logout

Logout: Discard the access token.

misc

misc.
getApiVersion

Get version information of the API.
output
ApiVersion

misc.
getFortune

Get a fortune message.
output
string

misc.
getTime

Get server time.
output
Time

misc.
getHomepageStats

Get homepage stats.
output
HomepageStats

misc.
getLogo

Get Jutge.org logo as a PNG file.
output filesone

misc.
getAvatarPacks

Returns all packs of avatars.

Avatars are used in exams and contests to identify students or participants.

output
array of
string

misc.
getExamIcons

Returns all exam icons.

Exam icon are used in exams and contests to identify problems.

output
TagsDict

misc.
getColors

Returns color mappings using colornames notation.

Color mappings may be used to colorize keys in the frontends. Color names are as defined in https://github.com/timoxley/colornames

output
ColorMapping

misc.
getHexColors

Returns color mappings using hexadecimal color notation.

Color mappings may be used to colorize keys in the frontends.

output
ColorMapping

tables

tables.
get

Returns all tables.

Returns all compilers, countries, drivers, languages, proglangs, and verdicts in a single request. This data does not change often, so you should only request it once per session.

output
AllTables

tables.
getLanguages

Returns all languages.

Returns all languages as a dictionary of objects, indexed by id.

output
dict of
Language

tables.
getCountries

Returns all countries.

Returns all countries as a dictionary of objects, indexed by id.

output
dict of
Country

tables.
getCompilers

Returns all compilers.

Returns all compilers as a dictionary of objects, indexed by id.

output
dict of
Compiler

tables.
getDrivers

Returns all drivers.

Returns all drivers as a dictionary of objects, indexed by id.

output
dict of
Driver

tables.
getVerdicts

Returns all verdicts.

Returns all verdicts as a dictionary of objects, indexed by id.

output
dict of
Verdict

tables.
getProglangs

Returns all proglangs.

Returns all proglangs (porgramming languages) as a dictionary of objects, indexed by id.

output
dict of
Proglang

problems

problems.
getAllAbstractProblems

Get all available abstract problems.

Includes problems.

output
dict of
AbstractProblem

problems.
getAbstractProblems

Get available abstract problems whose keys are in `problem_nms`.

Includes problems.

input
string
output
dict of
AbstractProblem

problems.
getAbstractProblemsInList

Get available abstract problems that belong to a list.

Includes problems.

input
string
output
dict of
AbstractProblem

problems.
getAbstractProblem

Get an abstract problem.

Includes owner and problems

input
string
output
AbstractProblem

problems.
getAbstractProblemSuppl

Get supplementary information of an abstract problem.

Includes accepted compilers and accepted proglangs

input
string
output
AbstractProblemSuppl

problems.
getProblem

Get a problem.

Includes abstract problem, which includes owner

input
string
output
Problem

problems.
getProblemRich

Get a problem with more infos.

Includes abstract problem, which includes owner, statements, testcases, etc.

input
string
output
ProblemRich

problems.
getProblemSuppl

Get supplementary information of a problem.

Includes accepted compilers, accepted proglangs, official solutions checks and handler specifications

input
string
output
ProblemSuppl

problems.
getSampleTestcases

Get sample testcases of a problem.
input
string
output
array of
Testcase

problems.
getPublicTestcases

Get public testcases of a problem.

Public testcases are like sample testcases, but are not meant to be show in the problem statatement, because of their long length.

input
string
output
array of
Testcase

problems.
getHtmlStatement

Get Html statement of a problem.

Currently, this is suboptimal, but I already know how to improve it.

input
string
output
string

problems.
getTextStatement

Get Text statement of a problem.
input
string
output
string

problems.
getMarkdownStatement

Get Markdown statement of a problem.
input
string
output
string

problems.
getPdfStatement

Get PDF statement of a problem.
input
string
output filesone

problems.
getZipStatement

Get ZIP archive of a problem. This includes the PDF statement and sample testcases.
input
string
output filesone

student.keys

student.keys.
get

Get problem, courses (as enrolled and available) and list keys.
output
AllKeys

student.keys.
getProblems

Get problem keys.
output
array of
string

student.keys.
getEnrolledCourses

Get enrolled course keys.
output
array of
string

student.keys.
getAvailableCourses

Get available course keys.
output
array of
string

student.keys.
getLists

Get list keys.
output
array of
string

student.profile

student.profile.
get

Get the profile.
output
Profile

student.profile.
getAvatar

Returns the avatar as a PNG file.
output filesone

student.profile.
update

Update the profile
input
NewProfile

student.profile.
updateAvatar

Update the avatar with new PNG.
input filesone

student.profile.
updatePassword

Update password.

Receives the old password and the new one, and changes the password if the old one is correct and the new one strong enough.

input
NewPassword

student.dashboard

student.dashboard.
getAbsoluteRanking

Get the ranking of the user over all users in the system.
output
integer

student.dashboard.
getAllDistributions

Get all distributions.
output
AllDistributions

student.dashboard.
getCompilersDistribution

Get compilers distribution.
output
Distribution

student.dashboard.
getDashboard

Get dashboard.
output
Dashboard

student.dashboard.
getHeatmapCalendar

Get heatmap calendar of submissions.
output
HeatmapCalendar

student.dashboard.
getProglangsDistribution

Get programming languages distribution.
output
Distribution

student.dashboard.
getStats

Get dashboard stats.
output
Distribution

student.dashboard.
getLevel

Get fancy Jutge level.
output
string

student.dashboard.
getSubmissionsByHour

Get submissions by hour distribution.
output
Distribution

student.dashboard.
getSubmissionsByWeekDay

Get submissions by weekday distribution.
output
Distribution

student.dashboard.
getVerdictsDistribution

Get verdicts distribution.
output
Distribution

student.submissions

student.submissions.
indexForAbstractProblem

Get index of all submissions for an abstract problem.

Grouped by problem.

input
string
output
dict of
dict of
Submission

student.submissions.
indexForProblem

Get index of all submissions for a problem.
input
string
output
dict of
Submission

student.submissions.
getAll

Get all submissions.

Flat array of submissions in chronological order.

output
array of
Submission

student.submissions.
submit

Submit a solution to the Judge, easy interface.
input
problem_id
string
compiler_id
string
code
string
annotation
string
output
string

student.submissions.
submitFull

Submit a solution to the Judge, full interface.
input
NewSubmissionIn
input filesone
output
NewSubmissionOut

student.submissions.
get

Get a submission.
input
problem_id
string
submission_id
string
output
Submission

student.submissions.
getCodeAsB64

Get code for a submission as a string in base64.
input
problem_id
string
submission_id
string
output
string

student.submissions.
getCodeMetrics

Get code metrics for a submission as JSON.

See https://github.com/jutge-org/jutge-code-metrics for details.

input
problem_id
string
submission_id
string
output

student.submissions.
getAwards

Get list of awards ids for a submission.
input
problem_id
string
submission_id
string
output
array of
string

student.submissions.
getAnalysis

Get analysis of a submission.
input
problem_id
string
submission_id
string
output
array of
SubmissionAnalysis

student.submissions.
getTestcaseAnalysis

Get a (public) testcase analysis of a submission.
input
problem_id
string
submission_id
string
testcase
string
output
TestcaseAnalysis

student.courses

student.courses.
indexAvailable

Get index of all available courses.
output
dict of
BriefCourse

student.courses.
indexEnrolled

Get index of all enrolled courses.
output
dict of
BriefCourse

student.courses.
getAvailable

Get an available course.

Includes owner and lists.

input
string
output
Course

student.courses.
getEnrolled

Get an enrolled course.

Includes owner and lists.

input
string
output
Course

student.courses.
enroll

Enroll in an available course.
input
string

student.courses.
unenroll

Unenroll from an enrolled course.
input
string

student.lists

student.lists.
getAll

Get all lists.
output
dict of
BriefList

student.lists.
get

Get a list.

Includes items, owner.

input
string
output
List

student.statuses

student.statuses.
getAll

Get statuses for all problems.
output
dict of
AbstractStatus

student.statuses.
getForAbstractProblem

Get status for an abstract problem.
input
string
output
AbstractStatus

student.statuses.
getForProblem

Get status for a problem.
input
string
output
Status

student.awards

student.awards.
getAll

Get all awards.
output
dict of
BriefAward

student.awards.
get

Get an award.
input
string
output
Award

instructor.documents

instructor.documents.
index

Get index of all documents.
output
dict of
Document

instructor.documents.
get

Get a document.

The PDF file is not included in the response.

input
string
output
Document

instructor.documents.
getPdf

Get PDF of a document.
input
string
output filesone

instructor.documents.
create

Create a new document.
input
Document
input filesone

instructor.documents.
update

Update a document.
input
Document
input filesone

instructor.documents.
remove

Remove a document.
input
string

instructor.lists

instructor.lists.
index

Get index of all lists.
output
dict of
InstructorBriefList

instructor.lists.
get

Get a list.
input
string
output
InstructorList

instructor.lists.
create

Create a new list.
input
InstructorList

instructor.lists.
update

Update an existing list.
input
InstructorList

instructor.lists.
remove

Delete an existing list.
input
string

instructor.lists.
getArchived

Get the list of lists that are archived.

At some point, endpoints related to archiving lists should change as the archive bit will be an attribute of each list.

output
array of
string

instructor.lists.
archive

Archive a list.
input
string

instructor.lists.
unarchive

Unarchive a list.
input
string

instructor.courses

instructor.courses.
index

Get index of all courses.
output
dict of
InstructorBriefCourse

instructor.courses.
get

Get a course.
input
string
output
InstructorCourse

instructor.courses.
create

Create a new course.

Only invited students and tutors are taken into account. Enrolled and pending students and tutors are ignored, as these are managed by the system.

input
InstructorCourse

instructor.courses.
update

Update an existing course.

Only invited students and tutors are taken into account. Enrolled and pending students and tutors are ignored, as these are managed by the system.

input
InstructorCourse

instructor.courses.
remove

Delete an existing course.

A course should not be deleted. Ask a system administrator to remove it if you really need it.

input
string

instructor.courses.
sendInviteToStudents

Send invite email to pending students in the course.

Please do not abuse.

input
string

instructor.courses.
sendInviteToTutors

Send invite email to pending tutors in the course.

Please do not abuse.

input
string

instructor.courses.
getStudentProfiles

Get the profiles of the students enrolled in the course.
input
string
output
dict of
StudentProfile

instructor.courses.
getTutorProfiles

Get the profiles of the tutors enrolled in the course.
input
string
output
dict of
StudentProfile

instructor.courses.
getArchived

Get the list of courses that are archived.

At some point, endpoints related to archiving courses should change as the archive bit will be an attribute of each course.

output
array of
string

instructor.courses.
archive

Archive a course.
input
string

instructor.courses.
unarchive

Unarchive a course.
input
string

instructor.exams

instructor.exams.
index

Get index of all exams.
output
dict of
InstructorBriefExam

instructor.exams.
get

Get an exam.
input
string
output
InstructorExam

instructor.exams.
getDocuments

Get documents of an exam.
input
string
output
array of
InstructorExamDocument

instructor.exams.
getProblems

Get problems of an exam.
input
string
output
array of
InstructorExamProblem

instructor.exams.
getStudents

Get students of an exam.
input
string
output
array of
InstructorExamStudent

instructor.exams.
getStudent

Get an student of an exam.
input
exam_nm
string
email
string
output
InstructorExamStudent

instructor.exams.
getSubmissions

Get submissions of an exam.

This endpoint prepares a ZIP file to download the submissions of an exam. Preparing the ZIP file takes some time, an href link to the ZIP will be returned. This ZIP file will be available for download for a limited time.

input
exam_nm
string
options
InstructorExamSubmissionsOptions
output
Pack

instructor.exams.
getStatistics

Get statistics of an exam.
input
string
output
ExamStatistics

instructor.exams.
create

Create a new exam.
input
InstructorExamCreation

instructor.exams.
update

Update an existing exam.
input
InstructorExamUpdate

instructor.exams.
updateDocuments

Update documents of an exam.
input
exam_nm
string
document_nms
array of
string

instructor.exams.
updateCompilers

Update compilers of an exam.
input
exam_nm
string
compiler_ids
array of
string

instructor.exams.
updateProblems

Update problems of an exam.
input
exam_nm
string
problems
array of
InstructorExamProblem

instructor.exams.
updateStudents

Update students of an exam.
input
exam_nm
string
students
array of
InstructorExamStudent

instructor.exams.
addStudents

Add students to an exam.
input
exam_nm
string
students
array of
InstructorExamStudent

instructor.exams.
removeStudents

Remove students from an exam.
input
exam_nm
string
emails
array of
string

instructor.exams.
remove

Delete an existing exam.

Note: An exam can only be deleted if it has not started.

input
string

instructor.exams.
getArchived

Get the list of exams that are archived.

At some point, endpoints related to archiving exams should change as the archive bit will be an attribute of each exam.

output
array of
string

instructor.exams.
archive

Archive an exam.
input
string

instructor.exams.
unarchive

Unarchive an exam.
input
string

instructor.exams.
getRanking

Get the ranking.

Under development.

input
string
output
Ranking

instructor.problems

instructor.problems.
getOwnProblems

Get the list of own problems.
output
array of
string

instructor.problems.
getPasscode

Get the passcode of a problem.

Returns an empty string if the problem has no passcode.

input
string
output
string

instructor.problems.
setPasscode

Set or update the passcode of a problem.

The passcode must be at least 8 characters long and contain only alphanumeric characters. The passcode will be stored in the database in plain text.

input
problem_nm
string
passcode
string

instructor.problems.
removePasscode

Remove passcode of a problem.
input
string

instructor.problems.
sharePasscode

Share passcode to a list of users identified by their email.

No emails are sent. Emails that are not registered in the system are ignored.

input
problem_nm
string
emails
array of
string

instructor.problems.
deprecate

Deprecate a problem.
input
problem_nm
string
reason
string

instructor.problems.
undeprecate

Undeprecate a problem.
input
string

instructor.problems.
download

Download a problem as a ZIP file.

Quick and dirty implementation, should be improved. Returns a ZIP file with the abstract problem and all its problems.

input
string
output filesone

instructor.problems.
legacyCreate

Create a problem from a ZIP archive using old PHP code.

At some point, this endpoint will be deprecated. It is a bit slow (about one minute). Returns the problem_nm of the new problem. Does not provide any feedback.

input
string
input filesone
output
string

instructor.problems.
legacyUpdate

Update a problem from a ZIP archive using old PHP code.

At some point, this endpoint will be deprecated. It is a bit slow (about one minute). Does not provide any feedback.

input
string
input filesone

instructor.queries

instructor.queries.
getCourseProblemSubmissions

Get submissions for a problem in a course.

Returns a list of submissions for a given problem for all students of a given course. Each submission includes the email, time, problem name, problem id, verdict, and IP address. The list is ordered by email and time. Known as ricard01 in the past.

input
course_nm
string
problem_nm
string
output
SubmissionsQuery

instructor.queries.
getCourseListSubmissions

Get submissions for all problems in a list in a course.

Returns a list of submissions for all problems in a given list for all students of a given course. Each submission includes the email, time, problem name, problem id, verdict, and IP address. The list is ordered by email, problem id and time. Known as ricard02 in the past.

input
course_nm
string
list_nm
string
output
SubmissionsQuery

instructor.tags

instructor.tags.
index

Get list of all tags.
output
array of
string

instructor.tags.
getDict

Get all tags with their problems.
output
TagsDict

instructor.tags.
get

Get all problems with a given tag.
input
string
output
array of
string

admin.instructors

admin.instructors.
get

Get instructors.
output
InstructorEntries

admin.instructors.
add

Add an instructor.
input
email
string
username
string

admin.instructors.
remove

Remove an instructor.
input
string

admin.users

admin.users.
count

Count users
output
integer

admin.users.
create

Create a user
input
UserCreation

admin.users.
remove

Remove a user
input
string

admin.users.
setPassword

Set a password for a user
input
email
string
password
string
message
string

admin.users.
getAllWithEmail

Get all users (well, just email and name) whose email contains a specific string
input
string
output
UsersEmailsAndNames

admin.users.
getSpamUsers

Get a list of emails of spam users
output
array of
string

admin.users.
removeSpamUsers

Remove spam users
input
array of
string

admin.dashboard

admin.dashboard.
getAll

Get all admin dashboard items.
output
AdminDashboard

admin.dashboard.
getFreeDiskSpace

Get free disk space.
output
FreeDiskSpace

admin.dashboard.
getRecentConnectedUsers

Get recent connected users.
output
RecentConnectedUsers

admin.dashboard.
getRecentLoadAverages

Get recent load averages.
output
RecentLoadAverages

admin.dashboard.
getRecentSubmissions

Get recent submissions.
output
RecentSubmissions

admin.dashboard.
getSubmissionsHistograms

Get submissions histograms.
output
SubmissionsHistograms

admin.dashboard.
getZombies

Get zombies.
output
Zombies

admin.dashboard.
getUpcomingExams

Get upcoming exams
input
daysBefore
integer
daysAfter
integer
output
UpcomingExams

admin.queue

admin.queue.
getQueue

Get the last 100 submissions from the queue in descending chronological order.
output
SubmissionQueueItems

admin.queue.
getQueueZombies

Get the last 100 zombi submissions from the queue.
output
SubmissionQueueItems

admin.queue.
getQueueFatals

Get the last 100 fatal submissions from the queue.
output
SubmissionQueueItems

admin.queue.
getQueueSetterErrors

Get the last 100 setter error submissions from the queue.
output
SubmissionQueueItems

admin.tasks

admin.tasks.
purgeAuthTokens

Purge expired access tokens.

Purge expired access tokens (call it from time to time, it does not hurt)

admin.tasks.
clearCaches

Clear all memoization caches.

admin.tasks.
fatalizeIEs

Fatalize IE submissions.

admin.tasks.
fatalizePendings

Fatalize pending submissions.

admin.tasks.
resubmitIEs

Resubmit IE submissions.

admin.tasks.
resubmitPendings

Resubmit pending submissions.

admin.stats

admin.stats.
getCounters

Get counters.
output
dict of
number

admin.stats.
getDistributionOfVerdicts

Get distribution of verdicts.
output
dict of
number

admin.stats.
getDistributionOfVerdictsByYear

Get distribution of verdicts by year.
output
array of
dict of
number

admin.stats.
getDistributionOfCompilers

Get distribution of compilers.
output
dict of
number

admin.stats.
getDistributionOfProglangs

Get distribution of proglangs.
output
dict of
number

admin.stats.
getDistributionOfUsersByYear

Get distribution of registered users by year.
output
dict of
number

admin.stats.
getDistributionOfUsersByCountry

Get distribution of registered users by country.
output
dict of
number

admin.stats.
getDistributionOfUsersBySubmissions

Get distribution of registered users by submissions using a custom bucket size.
input
integer
output
dict of
number

admin.stats.
getRankingOfUsers

Get ranking of users.
input
integer
output
UserRanking

admin.stats.
getDistributionOfSubmissionsByHour

Get distribution of submissions by hour.
output
dict of
number

admin.stats.
getDistributionOfSubmissionsByProglang

Get distribution of submissions by proglang.
output
dict of
number

admin.stats.
getDistributionOfSubmissionsByCompiler

Get distribution of submissions by compiler.
output
dict of
number

admin.stats.
getDistributionOfSubmissionsByWeekday

Get distribution of submissions by weekday.
output
dict of
number

admin.stats.
getDistributionOfSubmissionsByYear

Get distribution of submissions by year.
output
dict of
number

admin.stats.
getDistributionOfSubmissionsByYearForProglang

Get distribution of submissions by year for a proglang.
input
string
output
dict of
number

admin.stats.
getDistributionOfSubmissionsByDay

Get distribution of submissions by day.
output
dict of
number

admin.stats.
getHeatmapCalendarOfSubmissions

Get heatmap calendar of submissions.
input
DateRange
output

admin.stats.
getDistributionOfDomains

Get distribution of domains of users' emails.
output
dict of
number

admin.problems

admin.problems.
getSolutions

Get list of proglangs for which the problem has an official solution.
input
string
output
array of
string

admin.problems.
getSolutionAsB64

Get official solution for a problem in proglang as a string in base64.
input
problem_id
string
proglang
string
output
string

admin.problems.
getSolutionAsFile

Get official solution for a problem in proglang as a file.
input
problem_id
string
proglang
string
output filesone

testing.check

testing.check.
checkUser

Checks that query actor is a user.

testing.check.
checkInstructor

Checks that query actor is an instructor.

testing.check.
checkAdmin

Checks that query actor is an admin.

testing.check.
throwError

Throw an exception of the given type.
input
string

testing.playground

testing.playground.
upload

Upload a file.
input
Name
input filesone
output
string

testing.playground.
negate

Get negative of an image.
input filesone
output filesone

testing.playground.
download

Download a file.
input
Name
output filesone

testing.playground.
download2

Download a file with a string.
input
Name
output
string
output filesone

testing.playground.
ping

Ping the server to get a pong string.
output
string

testing.playground.
toUpperCase

Returns the given string in uppercase.
input
string
output
string

testing.playground.
add2i

Returns the sum of two integers.
input
TwoInts
output
integer

testing.playground.
add2f

Returns the sum of two floats.
input
TwoFloats
output
number

testing.playground.
inc

increment two numbers.
input
TwoInts
output
TwoInts

testing.playground.
add3i

Returns the sum of three integers.
input
a
integer
b
integer
c
integer
output
integer

testing.playground.
something

Returns a type with defaults.
input
SomeType
output
SomeType