API Reference¶

Retrieving Data¶

read-only

Available algorithms are described in Algorithms section.

Schema:

$ curl https://api-staging.userfeeds.io/ranking/algorithm1Name;param1=value1;param2=value2.../algorithm2Name...

Example:

$ curl https://api-staging.userfeeds.io/ranking/links;asset=ethereum

GET /ranking/algorithm1Name;param1=value1;param2=value2.../algorithm2Name...¶

Example request:

GET /ranking/links;asset=ethereum HTTP/1.1
Host: api-staging.userfeeds.io
User-Agent: curl/7.55.1
Accept: */*

Example response:

HTTP/1.1 200 OK
Server: nginx/1.13.8
Date: Wed, 28 Mar 2018 13:36:53 GMT
Content-Type: application/json
Content-Length: 46746
Connection: keep-alive
Access-Control-Allow-Origin: *
Access-Control-Allow-Methods: GET, OPTIONS

{
  "items": [
    {
      "target": "https://ethereum.org/",
      "score": 123
    },
    {
      "target": "https://userfeeds.io/",
      "score": 88
    }
  ]
}

OR

Schema:

$ curl -X POST -v -d '{"flow":[{"algorithm":"algorithm1name","params":{"param1":"value1",...},...}]}' -H 'Content-Type: application/json' 'https://api-staging.userfeeds.io/ranking/'

Example:

$ curl -X POST -v -d '{"flow":[{"algorithm":"links","params":{"asset":"ethereum"}}]}' -H 'Content-Type: application/json' 'https://api-staging.userfeeds.io/ranking/'

POST /ranking/¶

Example request:

POST /ranking/ HTTP/1.1
Host: api-staging.userfeeds.io
User-Agent: curl/7.55.1
Accept: */*
Content-Type: application/json
Content-Length: 62

{"flow":[{"algorithm":"links","params":{"asset":"ethereum"}}]}

Example response:

HTTP/1.1 200 OK
Server: nginx/1.13.8
Date: Wed, 28 Mar 2018 13:36:53 GMT
Content-Type: application/json
Content-Length: 46746
Connection: keep-alive
Access-Control-Allow-Origin: *
Access-Control-Allow-Methods: GET, OPTIONS

{
  "items": [
    {
      "target": "https://ethereum.org/",
      "score": 123
    },
    {
      "target": "https://userfeeds.io/",
      "score": 88
    }
  ]
}