Giters

Krokoklemme / devRant-Unofficial-API-Doc

Unofficial API documentation for the devrant.io application

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

DevRant.io Unofficial API Documentation

From the official site: devRant is a fun community for developers to share and bond over their successes and frustrations with code, tech, and life as a programmer. devRant is built by just one developer (devRant: @dfox Twitter: @dfoxinator) and one designer (devRant: @trogus Twitter: @tim_rogus) working on this project nights and weekends.

Here is a raw documentation of the DevRant public API. It is, as far as I know, largly undocumented and lacks a lot of methods that require authentication, which needs some work.

I've mostly used Danillouz's work here, so in case you need a readymade package that is easier to work with, check his repository out.

Also, API response truncated to save space and frustrations.

API base endpoint: https://www.devrant.io/api

Index

/get-user-id

{
  "success": true,
  "user_id": 101178
}

/devrant/rants/

  • Method:GET
  • Parameters: app
  • Optional parameters:
    • sort [algo, top, recent]: sort the rants according to the parameter
    • limit: number of rants to fetch
    • skip: Skip the first N rants and fetch from there
  • Brief: Fetches a list of rants
  • Example: https://www.devrant.io/api/devrant/rants?app=3
  • Response: An array of rants with various parameters
{
  "success": true,
  "rants": [
    {
      "id": 327111,
      "text": "My girlfriend got me this mug. She's the one.",
      "num_upvotes": 59,
      "num_downvotes": 1,
      "score": 59,
      "created_time": 1481230115,
      "attached_image": {
        "url": "https://img.devrant.io/devrant/rant/r_327111_pMWmu.jpg",
        "width": 562,
        "height": 1000
      },
      "num_comments": 6,
      "tags": [
        "linus",
        "torvalds",
        "mug"
      ],
      "vote_state": 0,
      "edited": false,
      "user_id": 118128,
      "user_username": "blackmarket",
      "user_score": 3086,
      "user_avatar": {
        "b": "d55161",
        "i": "v-11_c-3_b-5_g-m_9-1_1-1_16-2_3-6_8-4_7-4_5-1_12-1_6-3_10-1_2-41_15-19_18-4_4-1_19-3.jpg"
      }
    }
  ]
}

devrant/rants/${rant_id}?app=3

{
  "rant": {
    "id": 32710,
    "text": "When manager wants daily merges to a source control system that updates every 3 days.",
    "num_upvotes": 6,
    "num_downvotes": 0,
    "score": 6,
    "created_time": 1463743428,
    "attached_image": "",
    "num_comments": 0,
    "tags": [
      "conflictsgalore fml merge source control"
    ],
    "vote_state": 0,
    "edited": false,
    "user_id": 14984,
    "user_username": "rantmaster",
    "user_score": 112,
    "user_avatar": {
      "b": "d55161",
      "i": "v-11_c-3_b-5_g-m_9-1_1-2_16-1_3-1_8-1_7-1_5-1_12-2_6-15_10-1_2-18_15-19_4-1.jpg"
    }
  },
  "comments": [],
  "success": true
}

/devrant/search

{
  "success": true,
  "results": [
    {
      "id": 83521,
      "text": "What do you call a party with developers?\n\nA git together\n\nI'm so sorry.",
      "num_upvotes": 532,
      "num_downvotes": 3,
      "score": 532,
      "created_time": 1466749353,
      "attached_image": "",
      "num_comments": 12,
      "tags": [
        "github",
        "git"
      ],
      "vote_state": 0,
      "edited": false,
      "user_id": 80968,
      "user_username": "idontcare",
      "user_score": 543,
      "user_avatar": {
        "b": "2a8b9d"
      }
    }
  ]
}

users/auth-token

  • Method: POST
  • Brief: Gets an authentication token for posting rants, voting for comments, etc.
  • Body: app=3&username={username or e-mail}&password={password}
  • Response:
{
    "success": true,
    "auth_token": {
        "id": 2095660,
        "key": "6AWxG8ijoKnqJAPqrmfDVbzfX_XDTe9vhqMjMsx8",
        "expire_time": 1560022000,
        "user_id": 454264
    }
}

Note: Must specify Content-Type request header with application/x-www-form-urlencoded; charset=UTF-8

/users/${user_id}

  • Method: GET
  • Parameters: app
  • Brief: Fetches detailed information about a user (profile, rants, favorites, upvoted)
  • Example: https://www.devrant.io/api/users/101178?app=3
  • Response: A large JSON blog with the following important keys
Object.keys(temp1.profile) // chrome console magic!
["username", "score", "about", "location", "created_time", "skills", "github", "website", "content", "avatar"]
Object.keys(temp1.profile.content.content)
["rants", "upvoted", "comments", "favorites"]

About

Unofficial API documentation for the devrant.io application