Code Monkey home page Code Monkey logo

api's Introduction

api

joinmisskey servers' information api

https://instanceapp.misskey.page/instances.json

This API doesn't follow forks that say nodeinfo.software.name !== 'misskey'.

Build Environment

You must set following two envs.

  • LB_TOKEN= GitHub Token (to get versions)
  • MK_TOKEN= Misskey Token(to post to misskey)

Endpoints

We are only serving static files via nginx and Cloudflare, so we have no access restrictions.

You can get the following information under https://instanceapp.misskey.page

/instances.json

{
    date: Date // The date instances.json was published at.
    stats: {                      //  statistics
        notesCount: Number,       //  Total notes
        usersCount: Number,       //  Total Users
        mau: Number,              //  Total MAUs
        instancesCount: Number,   //  Servers counter
    },
    instancesInfos: [        // Servers Infos (only alives)
        {
            url: String,     //  Hostname e.g. misskey.io
            name: String,    //  Name e.g. すしすきー
            langs: String[], //  Language the API author aqz set manually e.g. ["ja"], ["zh"]
            description: String | Null,  // meta.description or the the API author aqz set manually
            isAlive: true,   //  must true
            value: Number,   //  The server Value calculated from the version, etc.
            banner: Bool,    //  Banner existance
            background: Bool,//  Background Image existance
            icon: Bool,      //  Icon Image existance
            nodeinfo: Object | null,  //  nodeinfo
            meta: Object | null,      //  result of api/meta

            stats: Object,   //  deprecated (result of api/stats)
        }, ...
    ]

}

/instance-banners/instance.host.{jpeg|webp}

Banner of each servers (lightweighted)

/instance-backgrounds/instance.host.{jpeg|webp}

Background image (displayed behind the welcome page) (lightweighted)

/instance-icons/instance.host.{png|webp}

Icon (not favicon) (lightweighted)

/alives.txt

List of hosts (separated by \n) for servers that were able to communicate

/deads.txt

List of hosts (separated by \n) for servers that were unable to communicate

versions.json

Version list obtained from GitHub

api's People

Contributors

tamaina avatar thatonecalculator avatar dependabot[bot] avatar tassoman avatar rierun avatar camilla-ett avatar miss-key avatar vmfunc avatar edisonlee55 avatar mona-chen avatar jaredallard avatar orzklv avatar srgr0 avatar chan-mai avatar pbzweihander avatar sousuke0422 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.