Share
Explore

QuikRun API Docs 🧑‍💻

🚀 Introduction

QuikRun is a cloud-based platform that allows you to compile code for multiple programming languages with ease. With its user-friendly interface, support for multiple programming languages, integration with no-code/low-code tools, and the ability to share and test your code, QuikRun can help you streamline your coding process and make your workflow more efficient.

🏃‍♂️ Getting Started

To get started with QuikRun, follow these simple steps:
Create an account on QuikRun: Head over to and sign up to get started. If you already have an account, simply .
Copy your authentication Token: Once you're logged in, go to your profile page and click on the "Reveal Token" button to obtain your authentication token.
Make API calls: Now that you have your authentication token, you can use it in any API call route to authenticate and compile your code.
Note: You can only make 10 API calls per day. If you want to increase the limit, please contact .
You can find the Postman collection & API documentation for QuikRun
.

🔐 Authentication

To pass Authentication, include the token obtained in the "Copy your authentication Token" step as a Bearer token in the Authorisation header of every API call. The header should look like this:
Authorization: Bearer <API_TOKEN>

🎯 Endpoints

👤 Endpoint 1 (Signup User)

Method: POST
Endpoint: https://api.nparashar150.com/user/signup
Description: This endpoint creates a new account for the user. Welcome aboard! 🚢
Request Body:
{ "email": "email", "password": "password", "name": "name"}
Response:
{ "message": "User created successfully", "data": { "uid": "", "email": "", "name": "", "membership": { "maxRequestsPerDay": 9, "name": "Free" }, "accessToken": "", "expiresIn": "", "refreshToken": "" }}

🔑 Endpoint 2 (Login User)

Method: POST
Endpoint: https://api.nparashar150.com/user/login
Description: This endpoint returns the access and refresh tokens for the user upon successful login.
Request Body:
{ "email": "email", "password": "password"}
Response:
{ "message": "User logged in successfully", "data": { "uid": "", "email": "", "name": "", "accessToken": "", "expiresIn": "", "refreshToken": "" }}

📋 Endpoint 3 (Get Plans)

Method: GET
Endpoint: https://api.nparashar150.com/plans
Description: Returns the list of active plans.
Parameters:
token_type: refresh_token
Response:
[ { "name": "Free", "maxRequestsPerDay": 10 }, { "name": "Pro", "maxRequestsPerDay": 100 }, { "name": "Enterprise", "maxRequestsPerDay": 1000 }]

🌐 Endpoint 4 (Get Languages)

Method: GET
Endpoint: https://api.nparashar150.com/languages?token_type=refresh_token
Description: Returns the list of actively supported languages**.**
Parameters:
token_type: refresh_token
Response:
{ "languages": [ { "id": 1, "name": "Javascript", "language": "javascript", "isActive": true, "extension": "js" }, { "id": 2, "name": "Python", "language": "python", "isActive": true, "extension": "py" }, { "id": 3, "name": "Ruby", "language": "ruby", "isActive": true, "extension": "rb" }, { "id": 10, "name": "TypeScript", "language": "typescript", "isActive": true, "extension": "ts" } ]}

💻 Endpoint 5 (Create Submission)

Method: POST
Endpoint: https://api.nparashar150.com/submissions/create?token_type=refresh_token
Description: This endpoint returns the response for the code and language ID passed to it.
Parameters:
token_type: refresh_token
Request Body:
{ "code": "const axios = (await import(\\"axios\\")).default;\\nconst getSampleData = async () => {\\n try {\\n const { data: quikRunPing } = await axios.get(\\"<https://quikrun.free.beeceptor.com>\\");\\n return quikRunPing;\\n } catch (error) {\\n return error;\\n }\\n}\\n\\nreturn getSampleData()\\n", "languageId": 1}
Response:
{ "message": "", "raw_stdout": "{\\"output\\":{\\"message\\":\\"Welcome to QuikRun!\\"},\\"logs\\":[]}\\n", "error": null, "stdout": { "output": { "message": "Welcome to QuikRun!" }, "logs": [] }}

💻 Endpoint 6 (Create Submission by Id)

Method: POST
Endpoint: https://api.nparashar150.com/submissions/create-by-id?token_type=refresh_token
Description: This endpoint returns the response for the snippet ID and language ID passed to it.
Parameters:
token_type: refresh_token
Request Body:
{ "languageId": 3, "snippetId": "d18c2b48-3cee-4d93-bd36-b57ad2461272"}
Response:
{ "message": "", "raw_stdout": "{\\n \\"output\\": [\\n [\\n {\\n \\"message\\": \\"Welcome to QuikRun!\\"\\n }\\n ]\\n ],\\n \\"logs\\": [\\n [\\n {\\n \\"message\\": \\"Welcome to QuikRun!\\"\\n }\\n ]\\n ]\\n}\\n", "error": null, "stdout": { "output": [ [ { "message": "Welcome to QuikRun!" } ] ], "logs": [ [ { "message": "Welcome to QuikRun!" } ] ] }}

🕰️ Rate Limiting

As a measure to maintain the stability and reliability of the QuikRun API, there is a rate limit of 30 API calls per minute. This rate limit applies to all users, regardless of their plan or level of access. It is important to note that exceeding the rate limit may result in errors or even suspension of API access. To ensure optimal performance and avoid disruptions to your workflow, we recommend that you adhere to the rate limit and adjust your use of the API accordingly. If you require a higher rate limit, please reach out to us at to discuss your needs and explore potential solutions.

📦 Packages for Snippets

To ensure the smooth execution of your code snippets, having the right set of packages installed is crucial. We offer a comprehensive list of popular packages that we support and can be directly used in your snippets. Click on the following link to access the list of supported packages:
.
Here are some example snippets that demonstrate how to use packages with various programming languages:
JavaScript: Check out this example for using npm packages in JS:
TypeScript: Take a look at this example for using npm packages in TS:
Python: Here's an example for using pip modules in Py:
Ruby: Finally, you can use this example for using gem packages in Rb:
QuikRun Playground Example.mov
4.6 MB

🙌 Conclusion

In this document, we have described how to get started with QuikRun, including authentication, and provided details of its endpoints. These endpoints include creating a new account, logging in, getting active plans, getting active languages, and creating a submission.
If you encounter any issues or require further information about QuikRun, please contact . We hope you enjoy using QuikRun to make your coding experience more enjoyable and efficient!

Want to print your doc?
This is not the way.
Try clicking the ⋯ next to your doc name or using a keyboard shortcut (
CtrlP
) instead.