From b09a88ad08cf9cdce18f652d56f9c56e0f59577c Mon Sep 17 00:00:00 2001 From: Muhammad Asjad Date: Wed, 16 Apr 2014 13:17:57 +0500 Subject: [PATCH] Update README.md --- blockstack_search/search/README.md | 13 +++++++++++-- 1 file changed, 11 insertions(+), 2 deletions(-) diff --git a/blockstack_search/search/README.md b/blockstack_search/search/README.md index 7c1dedbae..1f48f6513 100644 --- a/blockstack_search/search/README.md +++ b/blockstack_search/search/README.md @@ -51,7 +51,7 @@ API usage: ### Generate Developer key: -Note: This is method is temporary, and will be replaced by proper auth. mechanism. +Note: This method is temporary, and will be replaced by proper auth. mechanism. Request parameters: @@ -71,6 +71,10 @@ Sample Response: ### Search API (powered by elastic search) +Request parameters: + +> access_token and keywords (currently accepts username, twitter handle and btc_address) + syntax: > {machineip}/v1/people-search/?access_token={access_token}&keywords={keywords} @@ -89,7 +93,7 @@ using twitter handle: > curl -G http://localhost:5003/v1/people-search -d "access_token=a0fe2f40415f7451c4ba2eae7da963d5&keywords=ryaneshea" -### keywords can accept username, twitter handle and btc + Sample Response: @@ -143,6 +147,11 @@ Sample Response: ### 3) Profile API (powered by mongodb) + +Request parameters: + +> access_token and onenameID + Syntax: > {machine_ip}/v1/people/?id={onename_id}&access_token={access_token}