https://github.com/fa0311/twitter-openapi
OpenAPI(Swagger) specification of Twitter Internal API (Twitter graphql API)
https://github.com/fa0311/twitter-openapi
documentation graphql openapi scraper twitter undocumented unofficial
Last synced: about 1 month ago
JSON representation
OpenAPI(Swagger) specification of Twitter Internal API (Twitter graphql API)
- Host: GitHub
- URL: https://github.com/fa0311/twitter-openapi
- Owner: fa0311
- License: other
- Created: 2023-04-07T15:03:04.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2025-03-11T18:03:52.000Z (about 2 months ago)
- Last Synced: 2025-03-28T20:12:53.952Z (about 1 month ago)
- Topics: documentation, graphql, openapi, scraper, twitter, undocumented, unofficial
- Language: Python
- Homepage:
- Size: 855 KB
- Stars: 126
- Watchers: 5
- Forks: 12
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
# Twitter OpenAPI
Twitter OpenAPI(Swagger) specification
[issues](https://github.com/fa0311/twitter-openapi/issues) / [discussions](https://github.com/fa0311/twitter-openapi/discussions)
- [Python](https://github.com/fa0311/twitter_openapi_python)
- [Dart](https://github.com/fa0311/twitter_openapi_dart)
- [TypeScript](https://github.com/fa0311/twitter-openapi-typescript)
- [React Documents](https://github.com/fa0311/twitter-openapi-docs)
## Usage
```shell
openapi-generator-cli generate -g -i https://raw.githubusercontent.com/fa0311/twitter-openapi/main/dist/docs/openapi-3.0.yaml -o ./generated
```
There are several outputs, but the one that most closely follows the OpenAPI specification is `dist/docs`.
However, a lot of syntax that is not supported by some generators is used.
You can also modify the hook to make the generated results more user-friendly. [build_config.py](./tools/build_config.py)
Note that the license also inherits to the output.
## Contribute
[CONTRIBUTING.md](./CONTRIBUTING.md)
### build
```shell
python -V # Python 3.10.8
pip install -r requirements.txt
python tools/build.py
```
## License
This project is dual licensed. You can choose one of the following licenses:
- [Custom License](./LICENSE)
- [GNU Affero General Public License v3.0](./LICENSE.AGPL)