Code Plagiarism API BETA

Integrate your existing software or platform with Codequiry's source code plagiarism checker.

API Demonstration

Connect your account to run the live examples.

6. Getting a check's status

Now that you have started a check, it's time to retrieve its status and data.

Endpoint for getting check data

Getting the check status and submission data

You might want to get information about a check, such as the status and the submissions. This endpoint will give an overview of submission data as well. If the checks are completed, the scores will be shown with the submissions listed.

When sending the request, we will need to send the check_id:

check_id - The id of the check you wish to get

				curl -X POST \
  'https://codequiry.com/api/v1/check/get?check_id=YOUR_CHECK_ID' \
    -H 'apikey:  YOUR_API_KEY_HERE '
				
cURL Command
Sample Response (JSON Object)
				{
    "check": {
        "id": 2821,
        "name": "Java",
        "created_at": "2019-05-31 15:54:15",
        "updated_at": "2019-05-31 16:02:29",
        "status_id": 4,
        "job_id": 0
    },
    "status": "Checks completed",
    "submission_count": 3,
    "submissions": [
        {
            "id": 14587,
            "filename": "MiniFactorial-T3-ForWhile",
            "status_id": 4,
            "created_at": "2019-05-31 15:55:23",
            "updated_at": "2019-05-31 16:02:29",
            "result1": "0.00",
            "result2": "0.00",
            "result3": "0.00",
            "total_result": "48.65",
            "assignmentstatuses": {
                "id": 4,
                "status": "Checks completed",
                "icon": "icon dripicons-checkmark text-white",
                "color": "success",
                "created_at": null,
                "updated_at": null
            }
        },
        {
            "id": 14588,
            "filename": "MiniFactorial-T3-JumpLabel",
            "status_id": 4,
            "created_at": "2019-05-31 15:55:23",
            "updated_at": "2019-05-31 16:02:29",
            "result1": "0.00",
            "result2": "0.00",
            "result3": "0.00",
            "total_result": "0.00",
            "assignmentstatuses": {
                "id": 4,
                "status": "Checks completed",
                "icon": "icon dripicons-checkmark text-white",
                "color": "success",
                "created_at": null,
                "updated_at": null
            }
        },
        {
            "id": 14589,
            "filename": "MiniFactorial-T3-VariableBigInt",
            "status_id": 4,
            "created_at": "2019-05-31 15:55:23",
            "updated_at": "2019-05-31 16:02:29",
            "result1": "0.00",
            "result2": "0.00",
            "result3": "0.00",
            "total_result": "48.65",
            "assignmentstatuses": {
                "id": 4,
                "status": "Checks completed",
                "icon": "icon dripicons-checkmark text-white",
                "color": "success",
                "created_at": null,
                "updated_at": null
            }
        }
    ]
}
				
JSON Array
Error Format Response (422 error)
                {
    "error": "Invalid check_id provided"
}
                
JSON Array

Check status in realtime using SocketIO

See an example of realtime checking progress implementation with the Node.js Codequiry SDK

What's next

For optimal understanding of API usage, we recommend following this guide.

The API documentation is still actively being written, some information may be missing.