Skip to content

selfagency/ironmarch-api

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

50 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

ironmarch-api

Version License: MIT Twitter: jewishworker

API interface for Iron March data dump

Install

yarn install || npm install

Development

This API service is designed to make use of Vercel's serverless functions interface. Run locally with yarn dev.

Routes

/post

  • id: Get post by ID n (Integer)
  • limit: Limit results by n (Integer)
  • offset: Offset results by n (Integer)
  • user: Get posts by user ID n (Integer)
  • terms: Find posts containing terms (String)

/message

  • id: Get message by ID n (Integer)
  • limit: Limit results by n (Integer)
  • offset: Offset results by n (Integer)
  • user: Get messages by user ID n (Integer)
  • terms: Find messages containing terms (String)

/user

  • id: Get user by ID n (Integer)
  • limit: Limit results by n (Integer)
  • offset: Offset results by n (Integer)
  • terms: Find usernames containing terms (String)

/thread

  • id: Get thread (message collection) by ID n (Integer)

/meta

  • data: Get data collection by type (String)
    • discord: All discovered Discord invite links
    • facebook: All discovered user Facebook profiles
    • linkedin: All discovered user LinkedIn profiles
    • locales: Number of users by city, region, and country
    • skype: All discovered user Skype account names
    • twitter: All discovered user Twitter profiles
    • all: All of the above

Author

👤 The Jewish Worker hello@jewishworker.org

🤝 Contributing

Contributions, issues and feature requests are welcome!
Feel free to check issues page.

Show your support

Give a ⭐️ if this project helped you!


This README was generated with ❤️ by readme-md-generator