No description, website, or topics provided.
Switch branches/tags
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
README.md

README.md

The QuestionDB API

The API is pretty straightforward to use, and lets you fetch search results for a keyword.

From there, integrate the results with your internal process or tool however you'd like.

Note: In order to use the API, you will need a paid QuestionDB account.

Making a request

There's a single endpoint to query for now: https://questiondb.io/api/questions/(your keyword string) that supports GET requests.

To make a request, you'll need to pass your username:password with each request.

For example, here's a request to get questions that are related to "protein powder":

curl -u username:password -i https://questiondb.io/api/questions/protein%20powder

A successful response will look something like:

HTTP/1.0 200 OK
Content-Type: application/json
Content-Length: 102639
Server: Werkzeug/0.14.1 Python/3.5.5
Date: Mon, 26 Nov 2018 23:53:16 GMT

{
 "data":[
  {
  "source":"https://www.reddit.com/r/EatCheapAndHealthy/comments/6tm3wt/healthy_protein_shake_without_expensive_protein/",
  "num_comments":"158",
  "question":"healthy protein shake without expensive protein powder"
  },
  {
  "source":"https://www.reddit.com/r/ketogains/comments/9ap1r3/good_protein_powder_besides_isopure_difficulty/",
  "num_comments":"116",
  "question":"good protein powder besides isopure"
  },
 ...]
}

Questions are sorted in order of popularity (number of comments) in the "data" array.

Each question is its own object with the following keys:

  • "question" - The question string.
  • "source" - The URL where the original question is from.
  • "num_comments" - The number of comments in the source.

Feature Requests and Feedback

If you have any requests for the API, please get in touch using the information on our contact page.

If you run into any bugs, or need help, get in touch and provide as much detail as possible, or open an issue here on Github.