Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/nexterias/twitter-api-fetch
fetch-like implementation designed for X (formerly Twitter) API
https://github.com/nexterias/twitter-api-fetch
Last synced: 6 days ago
JSON representation
fetch-like implementation designed for X (formerly Twitter) API
- Host: GitHub
- URL: https://github.com/nexterias/twitter-api-fetch
- Owner: nexterias
- License: mit
- Created: 2022-11-27T15:59:11.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2024-03-19T16:39:29.000Z (10 months ago)
- Last Synced: 2024-04-17T04:58:30.653Z (9 months ago)
- Language: TypeScript
- Homepage:
- Size: 179 KB
- Stars: 2
- Watchers: 3
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Contributing: .github/CONTRIBUTING.md
- License: LICENSE
- Code of conduct: .github/CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# twitter-api-fetch
[](https://codecov.io/gh/nexterias/twitter-api-fetch)
[](https://github.com/nexterias/twitter-api-fetch/actions/workflows/tests.yml)
[](https://jsr.io/@nexterias/twitter-api-fetch)
[](https://jsr.io/@nexterias/twitter-api-fetch)
fetch-like implementation designed for Twitter API
## Usage
> [!Important]
> Since v3, [twitter-api-fetch](https://jsr.io/@nexterias/twitter-api-fetch) is now published in [JSR](https://jsr.io).
> If you are using [deno.land/x/twitter_api_fetch](https://deno.land/x/twitter_api_fetch) or [npm package](https://npmjs.com/package/twitter-api-fetch), please use JSR.
```bash
$ deno add @nexterias/twitter-api-fetch # Deno
$ bunx jsr add @nexterias/twitter-api-fetch # Bun
$ npx jsr add @nexterias/twitter-api-fetch # npm
$ yarn dlx jsr add @nexterias/twitter-api-fetch # yarn
$ pnpm dlx jsr add @nexterias/twitter-api-fetch # pnpm
```
```js
import { oauth1a } from "@nexterias/twitter-api-fetch";
const fetcher = await oauth1a({
consumerKey: "Your consumer key here.",
secretConsumerKey: "Your consumer key (secret) here.",
accessToken: "Your access token here.",
secretAccessToken: "Your access token (secret) here.",
});
const response = await fetcher("/2/tweets", {
method: "POST",
headers: {
"Content-Type": "application/json",
},
body: JSON.stringify({
text: "大いなる力には、大いなる責任が伴う",
}),
});
console.log(response);
console.log(await response.json());
```
### Cloudflare Workers
```ts
import { oauth1a } from "@nexterias/twitter-api-fetch";
export interface Env {
TWITTER_API_ACCESS_TOKEN: string;
TWITTER_API_SECRET_ACCESS_TOKEN: string;
TWITTER_API_CONSUMER_KEY: string;
TWITTER_API_SECRET_CONSUMER_KEY: string;
}
export default {
async fetch(
_request: Request,
env: Env,
_ctx: ExecutionContext,
): Promise {
const fetcher = await oauth1a({
accessToken: env.TWITTER_API_ACCESS_TOKEN,
consumerKey: env.TWITTER_API_CONSUMER_KEY,
secretAccessToken: env.TWITTER_API_SECRET_ACCESS_TOKEN,
secretConsumerKey: env.TWITTER_API_SECRET_CONSUMER_KEY,
});
const response = await fetcher(
"/2/users/910317474951786496/tweets",
{
cf: {
cacheTtl: 600,
},
},
);
if (!response.ok) {
return new Response(
JSON.stringify({ message: "Internal Server Error" }),
{ status: 500, headers: { "Content-Type": "application/json" } },
);
}
const tweets = await response.json();
console.log(tweets);
return new Response(JSON.stringify(tweets), {
headers: {
"Content-Type": "application/json",
},
});
},
};
```
## Authentication
- [x] OAuth 1.0a User Context
- [x] OAuth 2.0 Authorization Code Flow with PKCE
- [x] App only
- [x] Basic authentication
> **Note** Regarding **OAuth 2.0 Authorization Code Flow with PKCE**,
> `twitter-api-fetch` does not currently provide any functionality to assist in
> the process of issuing access tokens.
## License
```txt
MIT License
Copyright (c) 2022 The NEXTERIAS
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
```