plebnet-dev · sudheersingampalli · Nov 20, 2023
diff --git a/rates/docs/index.md b/rates/docs/index.md
@@ -0,0 +1,3 @@
+# Rates API Docs
+
+The Documentation of other APIs goes here..
diff --git a/rates/docs/rate.md b/rates/docs/rate.md
@@ -0,0 +1,19 @@
+# RATE API
+
+The rate API is returns the BTC/USD, or other pair rate as a single value.
+
+### Request
+
+`GET /rate?pair=btcinr`
+
+    curl -i -H 'Accept: application/json' http://localhost:8000/rate?pair=btcinr
+
+### Response
+
+    HTTP/1.1 200 OK
+    date: Sun, 19 Nov 2023 07:47:00 GMT
+    server: uvicorn
+    content-length: 21
+    content-type: application/json
+
+    {"rate":"123.46"}
diff --git a/rates/mkdocs.yml b/rates/mkdocs.yml
@@ -0,0 +1,6 @@
+site_name: Rates
+site_url: https://example.com/
+nav:
+  - Home: index.md
+  - Rate API: rate.md
+
diff --git a/requirements.txt b/requirements.txt
@@ -5,3 +5,4 @@ uvicorn==0.20.0
 aiofiles==22.1.0
 aiohttp==3.8.5
 requests==2.31.0
+mkdocs
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,3 @@
		# Rates API Docs

		The Documentation of other APIs goes here..