An open API service indexing awesome lists of open source software.

https://github.com/averagemarcus/twitter-profile-pic


https://github.com/averagemarcus/twitter-profile-pic

Last synced: over 1 year ago
JSON representation

Awesome Lists containing this project

README

          

![twitter-profile-pic](logo.png)

> 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:
```

```
Result:

![](https://twitter-profile-pic.cluster.fun/marcus_noble_?size=normal)

## 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=
```