From ca937dff5e3c4f2018ea95cc59e9fc5a933c4d39 Mon Sep 17 00:00:00 2001
From: jaredgoldman <jaredgoldmandev@gmail.com>
Date: Mon, 3 Apr 2023 20:00:42 -0400
Subject: [PATCH] Add api doc links in structs

---
 piker/brokers/kucoin.py | 21 ++++++++++++++++-----
 1 file changed, 16 insertions(+), 5 deletions(-)

diff --git a/piker/brokers/kucoin.py b/piker/brokers/kucoin.py
index de049999..cb225387 100644
--- a/piker/brokers/kucoin.py
+++ b/piker/brokers/kucoin.py
@@ -69,7 +69,8 @@ _ohlc_dtype = [
 
 class KucoinMktPair(Struct, frozen=True):
     '''
-    Kucoin's pair format
+    Kucoin's pair format:
+    https://docs.kucoin.com/#get-symbols-list
 
     '''
     baseCurrency: str
@@ -93,7 +94,8 @@ class KucoinMktPair(Struct, frozen=True):
 
 class AccountTrade(Struct, frozen=True):
     '''
-    Historical trade format
+    Historical trade format:
+    https://docs.kucoin.com/#get-account-ledgers
 
     '''
     id: str
@@ -109,6 +111,10 @@ class AccountTrade(Struct, frozen=True):
 
 
 class AccountResponse(Struct, frozen=True):
+    '''
+    https://docs.kucoin.com/#get-account-ledgers
+
+    '''
     currentPage: int
     pageSize: int
     totalNum: int
@@ -118,8 +124,8 @@ class AccountResponse(Struct, frozen=True):
 
 class KucoinTrade(Struct, frozen=True):
     '''
-    Real-time trade format
-
+    Real-time trade format:
+    https://docs.kucoin.com/#symbol-ticker
     '''
 
     bestAsk: float
@@ -134,7 +140,8 @@ class KucoinTrade(Struct, frozen=True):
 
 class KucoinL2(Struct, frozen=True):
     '''
-    Real-time L2 order book format
+    Real-time L2 order book format:
+    https://docs.kucoin.com/#level2-5-best-ask-bid-orders
 
     '''
     asks: list[list[float]]
@@ -143,6 +150,10 @@ class KucoinL2(Struct, frozen=True):
 
 
 class KucoinMsg(Struct, frozen=True):
+    '''
+    Generic outer-wrapper for any Kucoin ws msg
+
+    '''
     type: str
     topic: str
     subject: str