https://fedisearch.xyz A small project of mine, feel free to submit users and other things here.


Fediverse Search API

A simple JSON-based API for getting information on all things Fediverse.

Hosted at https://fediversewiki-api.herokuapp.com/

The fedisearch.xyz website however, I host it at my personal server.


Preview;

Desktop Mobile

Contributing

To submit a search form to the API, add these variables to data/characters.json

  {
    "name": "John Doe",
    "alternate_names": "",
    "gender": "Male",
    "category": "Novelist",
    "description": "",
    "fediverse": "@JohnDoe@instance.tld",
    "link": "https://instance.tld/@JohnDoe",
    "image": "https://fediversewiki-api.herokuapp.com/images/john-doe.jpg",
    "language": "English",
    "region": "Sweden",
    "user": true,
    "group" : false,
    "creator": true,
    "companyOrganization": false,
    "project": false,
    "applicationSoftware": false
  }

and also add a corresponding profile picture in public/images with a 1x1 aspect ratio.


notes

note; “fediverse” form work as link handle. for things like applications, instead of the fediverse handle insert the website name/short link "fediverse": "sitename.com",

multiple categories and subcategories if longer than 10 letters has to be added spaces in-between, "category": "Applications/Software" >> "category": "Applications/ Software" or else the description would be pruned.


The API

You don’t need an API key to use the api, so technically fediverse applications like mastodon can utilize this for their search results.


What is submitted?

the things you can submit is as follows;

  • All users, groups.
  • Creators.
  • related companies and organization.
  • projects.
  • applications/software.

that’s what the filtering could do as for now. general users can submit themselves in the search.