BrainlyAPI 🌩️
Now some commands have been divided into sections and must be installed separately
Now you can use "find question highlight" to search for the highlighted questions
Notes ‼️
- This is not the official library from brainly.com
- This version is not stable yet
- This library is still under development
- PLEASE DO NOT USE THIS LIBRARY FOR NEGATIVE PURPOSE
⚠️ ‼️ - What about documentation? The documentation will be generated as soon as some library components are ready to use
Let's Try with Experimental Mode 😎
const { BrainlyAPI, Server } = require('brainly-api');
BrainlyAPI.startWorker({ experimental: true, server: Server.ID }, async brainly => {
// find question
console.log(await brainly.findQuestion('Indonesian!!'));
});
List of Available Locations 📍
Example:
const { Server } = require('brainly-api');
Server.{Code}| Code | Name | Refers to |
|---|---|---|
| PL | Poland |
brainly.pl |
| RU | Russian Federation (the) | znanija.com |
| ES | Spain | brainly.lat |
| PT | Portugal |
brainly.com.br |
| TR | Turkey | eodev.com |
| RO | Romania |
brainly.ro |
| ID | Indonesia |
brainly.co.id |
| HI | India |
brainly.in |
| PH | Philippines (the) |
brainly.ph |
| US | United States of America (the) |
brainly.com (deprecated) |
Source
List of Features 😲
All the features below can only be used anonymously (temporarily disabled in auth mode)
All the available features are still under development and will continue to be improved.
| Feature | Method | Status |
|---|---|---|
| Find question | findQuestion | |
| Find question by id | ||
| Find question highlight | findQuestionHighlight | |
| Fetch user profile | fetchUserProfile |
Using CLI Tools 💻
$ npx brainly-api
Brainly API Tools (@brainly-api-tools) ‼️
Brainly api makes helper tools to simplify the development process. Here is a list of tools that can be used:
- @brainly-api-tools/example-list
- @brainly-api-tools/portable-server
- If you have other tools, you can contact me to be included in the list
Enable Random User Agents ❓
The random user agent can be activated by installing the random-useragent library.
API
AnonymousWorker
AnonymousWorker.findQuestion(question: string)
Used to search for questions based on the server and search queries.
AnonymousWorker.findQuestionById(id: string)
Used to search for questions based on the server and id.
AnonymousWorker.fetchUserProfile(userId: string)
Under development
AnonymousWorker.findQuestionHighlight(lesson: number)
Used to search for highlight questions based on the server and lesson type.
Troubleshooting 😠
Deploy to the server
Many people say that brainly-api has problems when deploying to Heroku. This was not caused by a flaw in the program, but from the security of the Brainly itself. They use Cloudflare for security. As another experiment, brainly-api works well with Microsoft Azure. If you have any suggestions for deploying brainly-api for free, you can do a pull request.
US Server restricted anywhere
Usually, many people ask why when the test on localhost is running well while on hosting it gives a 403 error. However, in this case, if you use US as the server then it will not work well on local and hosting. This is due to the security of Cloudflare.
Who Uses it ❓
Currently no project names are displayed. If you want your project name included here, then contact me with the following format:
- projectname: your project name
- projectlink: your project link
- projectlogo(optional): your project logo (600x400) or lower
Contact me ☎️
Code of Conduct 👥
See code of conduct
Support My Other Project 🔗
Contributing 📝
Thank you for wanting to contribute to this project. The contribution page can be found on contribution page
License 🔓
Licensed under MIT License
See package license