https://github.com/yashkarthik/farcaster-directory

Find your Twitter friends on Farcaster.
https://github.com/yashkarthik/farcaster-directory

farcaster twitter

Last synced: 20 days ago
JSON representation

Find your Twitter friends on Farcaster.

• Host: GitHub
• URL: https://github.com/yashkarthik/farcaster-directory
• Owner: YashKarthik
• Created: 2023-01-04T14:45:42.000Z (almost 2 years ago)
• Default Branch: main
• Last Pushed: 2023-02-22T04:31:30.000Z (over 1 year ago)
• Last Synced: 2024-10-06T17:36:25.070Z (about 1 month ago)
• Topics: farcaster, twitter
• Language: TypeScript
• Homepage: https://directory.yashkarthik.xyz
• Size: 462 KB
• Stars: 4
• Watchers: 3
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# [Farcaster Directory](https://directory.yashkarthik.xyz)

A directory of Farcaster accounts and their respective Twitter accounts, making it easy find your

Twitter friends on Farcaster.

Head to [directory.yashkarthik.xyz](https://directory.yashkarthik.xyz) to add yourself to the

directory.

## API

Endpoint: `https://directory.yashkarthik.xyz/api/read-users/:fid`

Where FID is the user's Farcaster ID.

Response shape (if no errors):

```

{

  id:                number;

  fid:               number;

  fname:             string;

  twitter_username:  string;

  custody_address:   string;

  connected_address: string[];

  cast_timestamp:    string|null;

  tweet_timestamp:   Date;

  cast_content:      string|null;

  tweet_content:     string|null;

  cast_link:         string|null;

  tweet_link:        string|null;

}[]

```

- Either the cast params (timestamp, content, link) or the tweet params may be null, but not both.

- The `id` has no meaning with repect to the protocol, it's just the database primary key.

- Unique properties? None of the props are unique to a single row. The same FID may be "owned" by

different twitter users, and vice versa. Hence the array response.

- Create an issue if you need other endpoints.

## Development roadmap (?)

_More like cool ideas that I wanna try out_

- Instead of a table on the front page. Display a social graph. Literally. Something like the graph

view in note-taking apps like [Obsidian.md](https://help.obsidian.md/Plugins/Graph+view), but for

visualizing who-follows-who and stuff.

###### Bootstrapped with [create-t3-app](https://create.t3.gg/).