Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/fa0311/twitter-openapi-typescript
Implementation of Twitter internal API (Twitter graphql API) in TypeScript
https://github.com/fa0311/twitter-openapi-typescript
graphql openapi scraper twitter typescript undocumented unofficial
Last synced: about 2 months ago
JSON representation
Implementation of Twitter internal API (Twitter graphql API) in TypeScript
- Host: GitHub
- URL: https://github.com/fa0311/twitter-openapi-typescript
- Owner: fa0311
- License: other
- Created: 2023-05-21T17:17:32.000Z (over 1 year ago)
- Default Branch: master
- Last Pushed: 2024-06-07T02:04:33.000Z (4 months ago)
- Last Synced: 2024-07-25T18:18:53.378Z (about 2 months ago)
- Topics: graphql, openapi, scraper, twitter, typescript, undocumented, unofficial
- Language: TypeScript
- Homepage: https://www.npmjs.com/package/twitter-openapi-typescript
- Size: 979 KB
- Stars: 62
- Watchers: 6
- Forks: 9
- Open Issues: 11
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# twitter-openapi-typescript
[issues](https://github.com/fa0311/twitter-openapi-typescript/issues) / [discussions](https://github.com/fa0311/twitter-openapi/discussions)
## Table of Contents
This repository contains two packages.
- [twitter-openapi-typescript](./twitter-openapi-typescript) Package for human-friendly TypeScript
- [twitter-openapi-typescript-generated](./twitter-openapi-typescript-generated) TypeScript package automatically generated from [twitter-openapi](https://github.com/fa0311/twitter-openapi) by OpenAPI generator
```mermaid
graph LR
A[twitter-openapi]--Auto Generated-->B[twitter-openapi-typescript-generated]
B--Simplified handling-->C[twitter-openapi-typescript]
```
---
## twitter-openapi-typescript
Learn more about people-friendly TypeScript packages here.
[twitter-openapi-typescript/README.md](./twitter-openapi-typescript/README.md)
## twitter-openapi-typescript-generated
> Note! twitter-openapi-typescript-generated is a package for advanced users who are familiar with Twitter's API. In general, [twitter-openapi-typescript](./twitter-openapi-typescript) should be used!
Build
```shell
git clone https://github.com/fa0311/twitter-openapi-typescript.git
cd twitter-openapi-typescript-generated
```
```shell
openapi-generator-cli version # 6.5.0
```
```shell
java -jar tools/openapi-generator-cli.jar generate -g typescript-fetch -c tools/openapi-generator-config.yaml
npm run build
```
Setup
```shell
npm i twitter-openapi-typescript-generated
```
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)
Usage
[twitter-openapi-typescript-generated/README.md](./twitter-openapi-typescript-generated/README.md)