57 lines
1.7 KiB
Markdown
57 lines
1.7 KiB
Markdown
|
|
|
|
> Get a twitter profile pic using a given handle
|
|
|
|
Available at https://twitter-profile-pic.cluster.fun/
|
|
|
|
## Features
|
|
|
|
* Multiple image size support (currently supported: `normal`, `bigger`, `mini`, `original`, `200x200`, `400x400`)
|
|
* JSON support using `application/json` content type header
|
|
* Returns a default profile pic for unknown users
|
|
|
|
## Example: HTML
|
|
|
|
Code:
|
|
```
|
|
<img src="https://twitter-profile-pic.cluster.fun/marcus_noble_?size=normal" />
|
|
```
|
|
Result:
|
|
|
|
|
|
|
|
## Example: JSON
|
|
cURL Request:
|
|
```
|
|
curl -X GET \
|
|
https://twitter-profile-pic.cluster.fun/marcus_noble_ \
|
|
-H 'cache-control: no-cache' \
|
|
-H 'content-type: application/json' \
|
|
-H 'postman-token: 680d968e-9b13-85c8-f7d5-9b48a333702f'
|
|
```
|
|
|
|
Result:
|
|
```
|
|
{
|
|
"normal": "https://pbs.twimg.com/profile_images/776738772759277569/hfaM5zhA_normal.jpg",
|
|
"bigger": "https://pbs.twimg.com/profile_images/776738772759277569/hfaM5zhA_bigger.jpg",
|
|
"mini": "https://pbs.twimg.com/profile_images/776738772759277569/hfaM5zhA_mini.jpg",
|
|
"original": "https://pbs.twimg.com/profile_images/776738772759277569/hfaM5zhA.jpg",
|
|
"200x200": "https://pbs.twimg.com/profile_images/776738772759277569/hfaM5zhA_200x200.jpg",
|
|
"400x400": "https://pbs.twimg.com/profile_images/776738772759277569/hfaM5zhA_400x400.jpg"
|
|
}
|
|
```
|
|
|
|
## Requirements
|
|
|
|
[Redis](https://redis.io/) is required if caching is wanted. You will also need Twitter credentials that can be created here: [https://apps.twitter.com/](https://apps.twitter.com/)
|
|
|
|
Environment Variables:
|
|
```
|
|
TWITTER_CONSUMER_KEY=
|
|
TWITTER_CONSUMER_SECRET=
|
|
TWITTER_ACCESS_TOKEN_KEY=
|
|
TWITTER_ACCESS_TOKEN_SECRET=
|
|
REDIS_URL=
|
|
```
|