https://github.com/selfagency/ironmarch-api
API powering ironmarch.exposed
https://github.com/selfagency/ironmarch-api
antifascist database
Last synced: 5 months ago
JSON representation
API powering ironmarch.exposed
- Host: GitHub
- URL: https://github.com/selfagency/ironmarch-api
- Owner: selfagency
- Created: 2021-07-10T15:44:37.000Z (almost 4 years ago)
- Default Branch: main
- Last Pushed: 2024-11-21T05:42:21.000Z (5 months ago)
- Last Synced: 2024-12-17T06:07:32.414Z (5 months ago)
- Topics: antifascist, database
- Language: JavaScript
- Homepage: https://ironmarch.exposed
- Size: 42 MB
- Stars: 1
- Watchers: 3
- Forks: 1
- Open Issues: 18
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
ironmarch-api
> API interface for Iron March data dump
## Install
```sh
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 **
- Twitter: [@jewishworker](https://twitter.com/jewishworker)
- GitLab: [@jewishworker](https://gitlab.com/jewishworker)
## 🤝 Contributing
Contributions, issues and feature requests are welcome!
Feel free to check [issues page](https://gitlab.com/jewishworker/ironmarch-api/issues).
## Show your support
Give a ⭐️ if this project helped you!
---
_This README was generated with ❤️ by [readme-md-generator](https://github.com/kefranabg/readme-md-generator)_