উদ্ভাবক পরিমাণগত ট্রেডিং প্ল্যাটফর্ম অনেক ক্রিপ্টোকারেন্সি এক্সচেঞ্জ সমর্থন করে এবং বাজারে মূলধারার এক্সচেঞ্জগুলিকে অন্তর্ভুক্ত করে। যাইহোক, এখনও অনেক এক্সচেঞ্জ আছে যা এনক্যাপসুলেটেড নয়, এবং যে ব্যবহারকারীদের এই এক্সচেঞ্জগুলি ব্যবহার করতে হবে তারা উদ্ভাবকদের দ্বারা পরিমাপ করা সর্বজনীন প্রোটোকলের মাধ্যমে সেগুলি অ্যাক্সেস করতে পারে। ক্রিপ্টোকারেন্সি এক্সচেঞ্জে সীমাবদ্ধ নয়, যেকোন সমর্থনRESTচুক্তি বাFIXচুক্তির প্ল্যাটফর্মেও প্রবেশ করা যাবে।
এই নিবন্ধটি উপর ভিত্তি করে করা হবেRESTএকটি উদাহরণ হিসাবে প্রোটোকল অ্যাক্সেস গ্রহণ করে, আমরা ব্যাখ্যা করব কিভাবে উদ্ভাবকের পরিমাণগত ট্রেডিং প্ল্যাটফর্মের সর্বজনীন প্রোটোকল ব্যবহার করে OKX এক্সচেঞ্জের API এনক্যাপসুলেট এবং অ্যাক্সেস করতে হয়। অন্যথায় নির্দিষ্ট করা না থাকলে, এই নিবন্ধটি REST সাধারণ প্রোটোকলকে নির্দেশ করে।
- সাধারণ প্রোটোকলের কর্মপ্রবাহ হল:
অনুরোধের প্রক্রিয়া: অভিভাবক -> সাধারণ প্রোটোকল প্রোগ্রাম -> এক্সচেঞ্জ এপিআই-এ চলমান কৌশল উদাহরণ
প্রতিক্রিয়া প্রক্রিয়া: এক্সচেঞ্জ এপিআই -> সাধারণ প্রোটোকল প্রোগ্রাম -> স্ট্র্যাটেজি ইনস্ট্যান্স কাস্টডিয়ানে চলছে
1. বিনিময় কনফিগার করুন
উদ্ভাবক পরিমাণগত ট্রেডিং প্ল্যাটফর্ম কনফিগারেশন বিনিময় পৃষ্ঠা:
- প্রোটোকল নির্বাচন করুন: "ইউনিভার্সাল প্রোটোকল" নির্বাচন করুন।
- পরিষেবার ঠিকানা: সর্বজনীন প্রোটোকল প্রোগ্রামটি মূলত একটি RPC পরিষেবা
অতএব, এক্সচেঞ্জ কনফিগার করার সময় আপনাকে পরিষেবার ঠিকানা এবং পোর্ট স্পষ্টভাবে উল্লেখ করতে হবে। এই ভাবে托管者上运行的策略实例 -> 通用协议程序প্রক্রিয়া চলাকালীন, হোস্ট জানে যে সাধারণ প্রোটোকল প্রোগ্রামটি কোথায় অ্যাক্সেস করতে হবে।
যেমন:http://127.0.0.1:6666/OKX, সাধারণত সাধারণ প্রোটোকল প্রোগ্রাম এবং হোস্ট একই ডিভাইসে (সার্ভার) চালানো হয়, তাই পরিষেবার ঠিকানা স্থানীয় মেশিনে লেখা হয় (স্থানীয় হোস্ট), এবং পোর্টটি এমন একটি পোর্ট হিসাবে ব্যবহার করা যেতে পারে যা সিস্টেম দ্বারা দখল করা হয় না। - Access Key：
托管者上运行的策略实例 -> 通用协议程序প্রক্রিয়া চলাকালীন, বিনিময় কনফিগারেশন তথ্য পাস করা হয়. - Secret Key：
托管者上运行的策略实例 -> 通用协议程序প্রক্রিয়া চলাকালীন, বিনিময় কনফিগারেশন তথ্য পাস করা হয়. - লেবেল:
উদ্ভাবক পরিমাণগত ট্রেডিং প্ল্যাটফর্মে এক্সচেঞ্জ অবজেক্ট লেবেল একটি নির্দিষ্ট বিনিময় বস্তু সনাক্ত করতে ব্যবহৃত হয়।
নিবন্ধে প্রকাশিত OKX প্লাগ-ইন কনফিগারেশনের স্ক্রিনশটটি নিম্নরূপ:
OKX এক্সচেঞ্জ গোপন কী কনফিগারেশন তথ্য:
txt
accessKey: accesskey123 // accesskey123 这些并不是实际秘钥，仅仅是演示
secretKey: secretkey123
passphrase: passphrase123
2. হোস্ট এবং সার্বজনীন প্রোটোকল প্রোগ্রাম (প্লাগইন) স্থাপন করুন
-
- কাস্টডিয়ান
উদ্ভাবক পরিমাণগত ট্রেডিং প্ল্যাটফর্মে কোনো বাস্তব কৌশল কৌশল চালানোর জন্য, একজন কাস্টোডিয়ানকে অবশ্যই নিযুক্ত করতে হবে, অনুগ্রহ করে প্ল্যাটফর্ম টিউটোরিয়াল দেখুন, যা এখানে বর্ণনা করা হবে না।
- কাস্টডিয়ান
-
২. সাধারণ প্রোটোকল প্রোগ্রাম (প্লাগইন)
তত্ত্বাবধায়ক এবং সার্বজনীন প্রোটোকল সাধারণত একই ডিভাইসে স্থাপন করা হয় এই নিবন্ধটি Python3 এ লেখা হয়। যেকোন পাইথন প্রোগ্রাম চালানোর মতো, এটি সরাসরি এক্সিকিউট করুন (আগে থেকেই পাইথন পরিবেশের বিভিন্ন কনফিগারেশন তৈরি করুন)।
অবশ্যই, FMZ এছাড়াও পাইথন প্রোগ্রাম চালানো সমর্থন করে, এবং এই সার্বজনীন প্রোটোকলটি উদ্ভাবকের পরিমাণগত ট্রেডিং প্ল্যাটফর্মকে আনক্যাপসুলেটেড এক্সচেঞ্জ API অ্যাক্সেসের জন্য সমর্থন প্রদান করার জন্য একটি বাস্তব অফার হিসাবেও চালানো যেতে পারে।
সাধারণ প্রোটোকল প্রোগ্রাম চলার পরে, পর্যবেক্ষণ শুরু করুন:http://127.0.0.1:6666, সাধারণ প্রোটোকল প্রোগ্রাম একটি নির্দিষ্ট পথ নির্দিষ্ট করতে পারে, যেমন/OKXপ্রক্রিয়াকরণের জন্য।
3. নীতি উদাহরণ FMZ এর API ফাংশন অনুরোধ করে
যখন (FMZ) প্ল্যাটফর্মের API ফাংশনটি কৌশলে কল করা হয়, তখন সাধারণ প্রোটোকল প্রোগ্রাম কাস্টডিয়ানের কাছ থেকে একটি অনুরোধ পাবে। আপনি প্ল্যাটফর্মের ডিবাগিং টুল ব্যবহার করে পরীক্ষা করতে পারেন, উদাহরণস্বরূপ:
ডিবাগিং টুল পৃষ্ঠা:
javascript
function main() {
return exchange.GetTicker("LTC_USDT")
}
কলexchange.GetTicker()ফাংশন, সাধারণ প্রোটোকল প্রোগ্রাম অনুরোধ গ্রহণ করে:
http
POST /OKX HTTP/1.1
{
"access_key":"xxx",
"method":"ticker",
"nonce":1730275031047002000,
"params":{"symbol":"LTC_USDT"},
"secret_key":"xxx"
}
- access_key: উপরের প্ল্যাটফর্মে "এক্সচেঞ্জ কনফিগার করার সময়" বিনিময় গোপন কী কনফিগার করা হয়
- secret_key: এক্সচেঞ্জ গোপন কী কনফিগার করা হয় যখন উপরের প্ল্যাটফর্মে "এক্সচেঞ্জ কনফিগার করা হয়"
- পদ্ধতি: কৌশল, কলিং কলিং ইন্টারফেসের সাথে সম্পর্কিত
exchange.GetTicker()ঘন্টা,methodঅর্থাৎticker。 - nonce: টাইমস্ট্যাম্প যখন অনুরোধটি ঘটেছে।
- প্যারামিটার: নীতিতে ইন্টারফেস কল সম্পর্কিত প্যারামিটার।
exchange.GetTicker()কল করার সময়, প্রাসঙ্গিক পরামিতিগুলি হল:{"symbol":"LTC_USDT"}。
4. ইউনিভার্সাল প্রোটোকল প্রোগ্রাম এক্সচেঞ্জ ইন্টারফেস অ্যাক্সেস করে
যখন সাধারণ প্রোটোকল প্রোগ্রাম কাস্টোডিয়ানের কাছ থেকে একটি অনুরোধ পায়, তখন এটি অনুরোধে বাহিত তথ্যের ভিত্তিতে জানতে পারে: কৌশল দ্বারা অনুরোধ করা প্ল্যাটফর্ম API ফাংশন (প্যারামিটার তথ্য সহ), বিনিময় গোপন কী এবং অন্যান্য তথ্য।
এই তথ্যের উপর ভিত্তি করে, সাধারণ প্রোটোকল প্রোগ্রাম প্রয়োজনীয় তথ্য পেতে বা নির্দিষ্ট ক্রিয়াকলাপ সম্পাদনের জন্য এক্সচেঞ্জ ইন্টারফেস অ্যাক্সেস করতে পারে।
সাধারণত এক্সচেঞ্জ ইন্টারফেসে GET/POST/PUT/DELETE এর মতো পদ্ধতি থাকে, যেগুলোকে পাবলিক ইন্টারফেস এবং ব্যক্তিগত ইন্টারফেসে ভাগ করা হয়।
- পাবলিক ইন্টারফেস: একটি ইন্টারফেস যার স্বাক্ষর যাচাইকরণের প্রয়োজন হয় না এবং সাধারণ প্রোটোকল প্রোগ্রামে সরাসরি অনুরোধ করা হয়।
- ব্যক্তিগত ইন্টারফেস: এই এক্সচেঞ্জগুলির API ইন্টারফেসের অনুরোধ করার জন্য স্বাক্ষরটি সাধারণ প্রোটোকল প্রোগ্রামে প্রয়োগ করা প্রয়োজন।
সাধারণ প্রোটোকল প্রোগ্রাম এক্সচেঞ্জ ইন্টারফেস প্রতিক্রিয়া ডেটা গ্রহণ করে, এটিকে আরও প্রক্রিয়া করে এবং তত্ত্বাবধায়ক (নীচে বর্ণিত) দ্বারা প্রত্যাশিত ডেটা তৈরি করে।
পাইথন সাধারণ প্রোটোকল উদাহরণে OKX স্পট এক্সচেঞ্জ, CustomProtocolOKX ক্লাস বাস্তবায়ন পড়ুনGetTicker、GetAccountফাংশন
5. সাধারণ প্রোটোকল প্রোগ্রাম কাস্টোডিয়ানের কাছে ডেটার প্রতিক্রিয়া জানায়
যখন সাধারণ প্রোটোকল প্রোগ্রাম এক্সচেঞ্জের API ইন্টারফেস অ্যাক্সেস করে এবং নির্দিষ্ট ক্রিয়াকলাপ সম্পাদন করে বা নির্দিষ্ট ডেটা প্রাপ্ত করে, ফলাফলগুলি কাস্টোডিয়ানের কাছে ফেরত দেওয়া দরকার।
তত্ত্বাবধায়ককে ফেরত দেওয়া ডেটা নীতি দ্বারা বলা ইন্টারফেস অনুসারে পরিবর্তিত হয় এটি প্রথমে দুটি বিভাগে বিভক্ত:
-
সাধারণ প্রোটোকল প্রোগ্রাম সফলভাবে এক্সচেঞ্জ ইন্টারফেসকে কল করে:
json{ "data": null, // "data" can be of any type "raw": null // "raw" can be of any type }- ডেটা: এই ক্ষেত্রের নির্দিষ্ট কাঠামো সাধারণ প্রোটোকল প্রোগ্রাম দ্বারা প্রাপ্ত অনুরোধের মতোই।
methodFMZ প্ল্যাটফর্ম API ফাংশনের চূড়ান্ত রিটার্ন তৈরি করতে ব্যবহৃত ডেটা স্ট্রাকচার সম্পর্কে, সমস্ত ইন্টারফেস নীচে তালিকাভুক্ত করা হয়েছে। - raw: এই ক্ষেত্রটি এক্সচেঞ্জ API ইন্টারফেস প্রতিক্রিয়ার কাঁচা ডেটাতে পাস করা যেতে পারে, উদাহরণস্বরূপ
exchange.GetTicker()ফাংশন দ্বারা প্রত্যাবর্তিত টিকার কাঠামো টিকার কাঠামোর তথ্য ক্ষেত্রে রেকর্ড করা হয়।rawক্ষেত্র এবংdataফিল্ড ডেটা প্ল্যাটফর্মের কিছু API ফাংশন এই ডেটার প্রয়োজন হয় না।
- ডেটা: এই ক্ষেত্রের নির্দিষ্ট কাঠামো সাধারণ প্রোটোকল প্রোগ্রাম দ্বারা প্রাপ্ত অনুরোধের মতোই।
-
সাধারণ প্রোটোকল প্রোগ্রাম এক্সচেঞ্জ ইন্টারফেস কল করতে ব্যর্থ হয়েছে (ব্যবসায়িক ত্রুটি, নেটওয়ার্ক ত্রুটি, ইত্যাদি)
json{ "error": "" // "error" contains an error message as a string }- ত্রুটি: ত্রুটির তথ্য (FMZ) প্ল্যাটফর্মের রিয়েল ডিস্ক, ডিবাগিং টুল এবং অন্যান্য পৃষ্ঠাগুলির লগ এলাকায় ত্রুটির লগে প্রদর্শিত হবে।
নীতি প্রোগ্রাম দ্বারা প্রাপ্ত সাধারণ প্রোটোকল প্রতিক্রিয়া ডেটা প্রদর্শন করে:
javascript
// FMZ平台的调试工具中测试
function main() {
Log(exchange.GetTicker("USDT")) // 交易对不完整，缺少BaseCurrency部分，需要通用协议插件程序返回报错信息： {"error": "..."}
Log(exchange.GetTicker("LTC_USDT"))
}
6. সাধারণ প্রোটোকলগুলিতে ডেটা স্ট্রাকচার কনভেনশন
উপরের বিষয়বস্তুটি (FMZ unencapsulated) এক্সচেঞ্জ এপিআই-এ অংশগ্রহণকারী সাধারণ প্রোটোকল প্রোগ্রামের একটি সংক্ষিপ্ত প্রক্রিয়া এই প্রক্রিয়াটি শুধুমাত্র (FMZ) প্ল্যাটফর্ম ডিবাগিং টুলে কল ব্যাখ্যা করে।exchange.GetTicker()ফাংশন প্রক্রিয়া। এরপর, সমস্ত প্ল্যাটফর্ম API ফাংশনের ইন্টারঅ্যাকশনের বিবরণ বিস্তারিতভাবে ব্যাখ্যা করা হবে।
প্ল্যাটফর্ম প্রতিটি এক্সচেঞ্জের সাধারণ ফাংশনগুলিকে এনক্যাপসুলেট করে এবং একটি নির্দিষ্ট ফাংশনে একীভূত করে, যেমন GetTicker ফাংশন, যা একটি নির্দিষ্ট বৈচিত্র্যের বর্তমান বাজারের তথ্যের জন্য অনুরোধ করে এটি মূলত একটি API যা সমস্ত এক্সচেঞ্জে থাকে৷ তাই যখন নীতির উদাহরণ প্ল্যাটফর্ম-এনক্যাপসুলেটেড API ইন্টারফেস অ্যাক্সেস করে, তখন অভিভাবক "ইউনিভার্সাল প্রোটোকল" প্লাগ-ইন প্রোগ্রামে একটি অনুরোধ পাঠাবেন (ইতিমধ্যে উপরে উল্লিখিত):
http
POST /OKX HTTP/1.1
{
"access_key": "xxx",
"method": "ticker",
"nonce": 1730275031047002000,
"params": {"symbol":"LTC_USDT"},
"secret_key": "xxx"
}
একটি নীতিতে (যেমন GetTicker) বিভিন্ন উদ্ভাবক প্ল্যাটফর্ম দ্বারা এনক্যাপসুলেট করা API ফাংশনগুলিকে কল করার সময়, সাধারণ প্রোটোকলে হোস্টের পাঠানো অনুরোধের বিন্যাসটিও ভিন্ন হবে৷ শরীরের মধ্যে শুধুমাত্র তথ্য (JSON) পার্থক্য যেmethodএবংparams. একটি সাধারণ প্রোটোকল ডিজাইন করার সময়, এর উপর ভিত্তি করেmethodশুধু নির্দিষ্ট ক্রিয়াকলাপ সম্পাদন করতে বিষয়বস্তু ব্যবহার করুন. নিম্নলিখিত সমস্ত ইন্টারফেসের জন্য অনুরোধ-উত্তর পরিস্থিতি।
স্পট এক্সচেঞ্জ
উদাহরণস্বরূপ, বর্তমান ট্রেডিং পেয়ার হল:ETH_USDT, যা আরও বর্ণনা করা হবে না। অভিভাবক আশা করেন যে সাধারণ প্রোটোকল প্রতিক্রিয়ার ডেটা মূলত ডেটা ফিল্ডে লেখা হবে এবং এক্সচেঞ্জ ইন্টারফেসের আসল ডেটা রেকর্ড করতে একটি কাঁচা ক্ষেত্রও যুক্ত করা যেতে পারে।
-
GetTicker
-
পদ্ধতি ক্ষেত্র: "টিকার"
-
প্যারামস ক্ষেত্র:
json{"symbol":"ETH_USDT"} -
তত্ত্বাবধায়ক জেনেরিক প্রোটোকল প্রতিক্রিয়া থেকে যে ডেটা আশা করে:
json{ "data": { "symbol": "ETH_USDT", // 对应GetTicker函数返回的Ticker结构中的Symbol字段 "buy": "2922.18", // ...对应Buy字段 "sell": "2922.19", "high": "2955", "low": "2775.15", "open": "2787.72", "last": "2922.18", "vol": "249400.888156", "time": "1731028903911" }, "raw": {} // 可以增加一个raw字段记录交易所API接口应答的原始数据 }
-
-
GetDepth
-
পদ্ধতি ক্ষেত্র: "গভীরতা"
-
প্যারামস ক্ষেত্র:
json{"limit":"30","symbol":"ETH_USDT"} -
তত্ত্বাবধায়ক জেনেরিক প্রোটোকল প্রতিক্রিয়া থেকে যে ডেটা আশা করে:
json{ "data" : { "time" : 1500793319499, "asks" : [ [1000, 0.5], [1001, 0.23], [1004, 2.1] // ... ], "bids" : [ [999, 0.25], [998, 0.8], [995, 1.4] // ... ] } }
-
-
GetTrades
-
পদ্ধতি ক্ষেত্র: "বাণিজ্য"
-
প্যারামস ক্ষেত্র:
json{"symbol":"eth_usdt"} -
তত্ত্বাবধায়ক জেনেরিক প্রোটোকল প্রতিক্রিয়া থেকে যে ডেটা আশা করে:
json{ "data": [ { "id": 12232153, "time" : 1529919412968, "price": 1000, "amount": 0.5, "type": "buy", // "buy"、"sell"、"bid"、"ask" }, { "id": 12545664, "time" : 1529919412900, "price": 1001, "amount": 1, "type": "sell", } // ... ] }
-
-
GetRecords
-
পদ্ধতি ক্ষেত্র: "রেকর্ডস"
-
প্যারামস ক্ষেত্র:
json{ "limit":"500", "period":"60", // 60分钟 "symbol":"ETH_USDT" } -
তত্ত্বাবধায়ক জেনেরিক প্রোটোকল প্রতিক্রিয়া থেকে যে ডেটা আশা করে:
json{ "data": [ // "Time":1500793319000,"Open":1.1,"High":2.2,"Low":3.3,"Close":4.4,"Volume":5.5 [1500793319, 1.1, 2.2, 3.3, 4.4, 5.5], [1500793259, 1.01, 2.02, 3.03, 4.04, 5.05], // ... ] }
-
-
GetMarkets
বাস্তবায়িত হবে-
পদ্ধতি ক্ষেত্র: ""
-
প্যারামস ক্ষেত্র:
json{} -
তত্ত্বাবধায়ক জেনেরিক প্রোটোকল প্রতিক্রিয়া থেকে যে ডেটা আশা করে:
json{}
-
-
GetTickers
বাস্তবায়িত হবে-
পদ্ধতি ক্ষেত্র: ""
-
প্যারামস ক্ষেত্র:
json{} -
তত্ত্বাবধায়ক জেনেরিক প্রোটোকল প্রতিক্রিয়া থেকে যে ডেটা আশা করে:
json{}
-
-
GetAccount
-
পদ্ধতি ক্ষেত্র: "অ্যাকাউন্ট"
-
প্যারামস ক্ষেত্র:
json{} -
তত্ত্বাবধায়ক জেনেরিক প্রোটোকল প্রতিক্রিয়া থেকে যে ডেটা আশা করে:
json{ "data": [ {"currency": "TUSD", "free": "3000", "frozen": "0"}, {"currency": "BTC", "free": "0.2482982056277609", "frozen": "0"}, // ... ] }
-
-
GetAssets
-
পদ্ধতি ক্ষেত্র: "সম্পদ"
-
প্যারামস ক্ষেত্র:
json{} -
তত্ত্বাবধায়ক জেনেরিক প্রোটোকল প্রতিক্রিয়া থেকে যে ডেটা আশা করে:
json{ "data": [ {"currency": "TUSD", "free": "3000", "frozen": "0"}, {"currency": "BTC", "free": "0.2482982056277609", "frozen": "0"}, // ... ] }
-
-
CreateOrder / Buy / Sell
-
পদ্ধতি ক্ষেত্র: "বাণিজ্য"
-
প্যারামস ক্ষেত্র:
json{"amount":"0.1","price":"1000","symbol":"BTC_USDT","type":"buy"} -
তত্ত্বাবধায়ক জেনেরিক প্রোটোকল প্রতিক্রিয়া থেকে যে ডেটা আশা করে:
json{ "data": { "id": "BTC-USDT,123456" } }
-
-
GetOrders
-
পদ্ধতি ক্ষেত্র: "অর্ডার"
-
প্যারামস ক্ষেত্র:
json{"symbol":"ETH_USDT"} -
তত্ত্বাবধায়ক জেনেরিক প্রোটোকল প্রতিক্রিয়া থেকে যে ডেটা আশা করে:
json{ "data": [ { "id": "ETH-USDT,123456", "symbol": "ETH_USDT", "amount": 0.25, "price": 1005, "deal_amount": 0, "avg_price": "1000", "type": "buy", // "buy"、"sell" "status": "pending", // "pending", "pre-submitted", "submitting", "submitted", "partial-filled" }, // ... ] }
-
-
GetOrder
-
পদ্ধতি ক্ষেত্র: "অর্ডার"
-
প্যারামস ক্ষেত্র:
json{ "id":"ETH-USDT,123456", // 策略中调用：exchange.GetOrder("ETH-USDT,123456") "symbol":"ETH_USDT" } -
তত্ত্বাবধায়ক জেনেরিক প্রোটোকল প্রতিক্রিয়া থেকে যে ডেটা আশা করে:
json{ "data": { "id": "ETH-USDT,123456", "symbol": "ETH_USDT" "amount": 0.15, "price": 1002, "status": "pending", // "pending", "pre-submitted", "submitting", "submitted", "partial-filled", "filled", "closed", "finished", "partial-canceled", "canceled" "deal_amount": 0, "type": "buy", // "buy"、"sell" "avg_price": 0, // 如果交易所没有提供，在处理时可以赋值为0 } }
-
-
GetHistoryOrders
-
পদ্ধতি ক্ষেত্র: "ইতিহাসের ক্রম"
-
প্যারামস ক্ষেত্র:
json{"limit":0,"since":0,"symbol":"ETH_USDT"} -
তত্ত্বাবধায়ক জেনেরিক প্রোটোকল প্রতিক্রিয়া থেকে যে ডেটা আশা করে:
json{ "data": [ { "id": "ETH-USDT,123456", "symbol": "ETH_USDT", "amount": 0.25, "price": 1005, "deal_amount": 0, "avg_price": 1000, "type": "buy", // "buy"、"sell" "status": "filled", // "filled" }, // ... ] }
-
-
CancelOrder
-
পদ্ধতি ক্ষেত্র: "বাতিল"
-
প্যারামস ক্ষেত্র:
json{"id":"ETH-USDT,123456","symbol":"ETH_USDT"} -
তত্ত্বাবধায়ক জেনেরিক প্রোটোকল প্রতিক্রিয়া থেকে যে ডেটা আশা করে:
json{ "data": true // 只要该JSON中没有error字段，都默认为撤单成功 }
-
-
IO
exchange.IO ফাংশনটি সরাসরি এক্সচেঞ্জ ইন্টারফেস অ্যাক্সেস করতে ব্যবহৃত হয়। উদাহরণস্বরূপ, আমরা ব্যবহার করি
GET /api/v5/trade/orders-pending, 参数：instType=SPOT，instId=ETH-USDTউদাহরণ।javascript// 策略实例中调用 exchange.IO("api", "GET", "/api/v5/trade/orders-pending", "instType=SPOT&instId=ETH-USDT")-
পদ্ধতি ক্ষেত্র:
"__api_/api/v5/trade/orders-pending", পদ্ধতি ক্ষেত্রের বিষয়বস্তু _api দিয়ে শুরু হয়, এটি নির্দেশ করে যে এটি পলিসি ইন্সট্যান্সে exchange.IO ফাংশন কল দ্বারা ট্রিগার হয়েছে। -
প্যারামস ক্ষেত্র:
json{"instId":"ETH-USDT","instType":"SPOT"} // instType=SPOT&instId=ETH-USDT编码的参数会被还原为JSON -
তত্ত্বাবধায়ক জেনেরিক প্রোটোকল প্রতিক্রিয়া থেকে যে ডেটা আশা করে:
json{ "data": {"code": "0", "data": [], "msg": ""} // data属性值为交易所API：GET /api/v5/trade/orders-pending 应答的数据 }
-
-
অন্যান্য
অন্যান্য উদ্ভাবক প্ল্যাটফর্ম API ফাংশন নীতি দৃষ্টান্তগুলিতে ব্যবহৃত হয়, যেমন:
exchange.Go()、exchange.GetRawJSON()অন্যান্য ফাংশন এনক্যাপসুলেট করার প্রয়োজন নেই, এবং কলিং পদ্ধতি এবং ফাংশন অপরিবর্তিত থাকে।
ফিউচার এক্সচেঞ্জ
সমস্ত স্পট এক্সচেঞ্জের ফাংশন ছাড়াও, ফিউচার এক্সচেঞ্জের কিছু এপিআই ফাংশন রয়েছে ফিউচার এক্সচেঞ্জের জন্য অনন্য।
বাস্তবায়িত হবে
- GetPositions
- SetMarginLevel
- GetFundings
পাইথন সংস্করণ সার্বজনীন প্রোটোকল উদাহরণ
REST সাধারণ প্রোটোকল - OKX এক্সচেঞ্জ REST API ইন্টারফেসের সাথে সংযুক্ত, একটি স্পট এক্সচেঞ্জ অবজেক্ট হিসাবে আবদ্ধ।
একটি পাবলিক ইন্টারফেস অনুরোধ এবং প্রতিক্রিয়া ডেটা এনক্যাপসুলেশন প্রয়োগ করা হয়েছে।
একটি ব্যক্তিগত ইন্টারফেসের স্বাক্ষর, অনুরোধ এবং প্রতিক্রিয়া ডেটা এনক্যাপসুলেশন বাস্তবায়ন করেছে।
এই উদাহরণটি মূলত পরীক্ষা এবং শেখার জন্য বাকী ইন্টারফেসগুলি পরীক্ষার জন্য হোস্টকে সরাসরি প্রতিক্রিয়া জানাতে সিমুলেটেড ডেটা ব্যবহার করে৷
python
import http.server
import socketserver
import json
import urllib.request
import urllib.error
import argparse
import ssl
import hmac
import hashlib
import base64
from datetime import datetime
ssl._create_default_https_context = ssl._create_unverified_context
class BaseProtocol:
ERR_NOT_SUPPORT = {"error": "not support"}
def __init__(self, apiBase, accessKey, secretKey):
self._apiBase = apiBase
self._accessKey = accessKey
self._secretKey = secretKey
def _httpRequest(self, method, path, query="", params={}, addHeaders={}):
headers = {
'User-Agent': 'Mozilla/5.0 (Windows; U; Windows NT 6.1; en-US; rv:1.9.1.6) Gecko/20091201 Firefox/3.5.6',
'Content-Type': 'application/json; charset=UTF-8'
}
# add headers
for key in addHeaders:
headers[key] = addHeaders[key]
if method == "GET":
url = f"{self._apiBase}{path}?{query}" if query != "" else f"{self._apiBase}{path}"
req = urllib.request.Request(url, method=method, headers=headers)
else:
url = f"{self._apiBase}{path}"
req = urllib.request.Request(url, json.dumps(params, separators=(',', ':')).encode('utf-8'), method=method, headers=headers)
print(f'send request by protocol: {self.exName}, req:', req.method, req.full_url, req.headers, req.data, "\n")
try:
with urllib.request.urlopen(req) as resp:
data = json.loads(resp.read())
except json.JSONDecodeError:
data = {"error": "Invalid JSON response"}
except urllib.error.HTTPError as e:
data = {"error": f"HTTP error: {e.code}"}
except urllib.error.URLError as e:
data = {"error": f"URL error: {e.reason}"}
except Exception as e:
data = {"error": f"Exception occurred: {str(e)}"}
print(f'protocol response received: {self.exName}, resp:', data, "\n")
return data
def GetTickers(self):
return self.ERR_NOT_SUPPORT
def GetMarkets(self):
return self.ERR_NOT_SUPPORT
def GetTicker(self, symbol):
return self.ERR_NOT_SUPPORT
def GetDepth(self, symbol=""):
return self.ERR_NOT_SUPPORT
def GetTrades(self, symbol=""):
return self.ERR_NOT_SUPPORT
def GetRecords(self, symbol, period, limit):
return self.ERR_NOT_SUPPORT
def GetAssets(self):
return self.ERR_NOT_SUPPORT
def GetAccount(self):
return self.ERR_NOT_SUPPORT
def CreateOrder(self, symbol, side, price, amount):
return self.ERR_NOT_SUPPORT
def GetOrders(self, symbol=""):
return self.ERR_NOT_SUPPORT
def GetOrder(self, orderId):
return self.ERR_NOT_SUPPORT
def CancelOrder(self, orderId):
return self.ERR_NOT_SUPPORT
def GetHistoryOrders(self, symbol, since, limit):
return self.ERR_NOT_SUPPORT
def GetPostions(self, symbol=""):
return self.ERR_NOT_SUPPORT
def SetMarginLevel(self, symbol, marginLevel):
return self.ERR_NOT_SUPPORT
def GetFundings(self, symbol=""):
return self.ERR_NOT_SUPPORT
def IO(self, params):
return self.ERR_NOT_SUPPORT
class ProtocolFactory:
@staticmethod
def createExWrapper(apiBase, accessKey, secretKey, exName) -> BaseProtocol:
if exName == "OKX":
return CustomProtocolOKX(apiBase, accessKey, secretKey, exName)
else:
raise ValueError(f'Unknown exName: {exName}')
class CustomProtocolOKX(BaseProtocol):
"""
CustomProtocolOKX - OKX API Wrapper
# TODO: add information.
"""
def __init__(self, apiBase, accessKey, secretKey, exName):
secretKeyList = secretKey.split(",")
self.exName = exName
self._x_simulated_trading = 0
if len(secretKeyList) > 1:
self._passphrase = secretKeyList[1]
if len(secretKeyList) > 2:
if secretKeyList[2] == "simulate":
self._x_simulated_trading = 1
else:
raise ValueError(f"{self.exName}: invalid secretKey format.")
super().__init__(apiBase, accessKey, secretKeyList[0])
def getCurrencys(self, symbol):
baseCurrency, quoteCurrency = "", ""
arrCurrency = symbol.split("_")
if len(arrCurrency) == 2:
baseCurrency = arrCurrency[0]
quoteCurrency = arrCurrency[1]
return baseCurrency, quoteCurrency
def getSymbol(self, instrument):
arrCurrency = instrument.split("-")
if len(arrCurrency) == 2:
baseCurrency = arrCurrency[0]
quoteCurrency = arrCurrency[1]
else:
raise ValueError(f"{self.exName}: invalid instrument: {instrument}")
return f'{baseCurrency}_{quoteCurrency}'
def callUnsignedAPI(self, httpMethod, path, query="", params={}):
return self._httpRequest(httpMethod, path, query, params)
def callSignedAPI(self, httpMethod, path, query="", params={}):
strTime = datetime.utcnow().strftime('%Y-%m-%dT%H:%M:%S.%f')[:-3] + 'Z'
if httpMethod == "GET":
jsonStr = json.dumps(params, separators=(',', ':')) if len(params) > 0 else ""
else:
jsonStr = json.dumps(params, separators=(',', ':')) if len(params) > 0 else "{}"
message = f'{strTime}{httpMethod}{path}{jsonStr}'
if httpMethod == "GET" and query != "":
message = f'{strTime}{httpMethod}{path}?{query}{jsonStr}'
mac = hmac.new(bytes(self._secretKey, encoding='utf8'), bytes(message, encoding='utf-8'), digestmod='sha256')
signature = base64.b64encode(mac.digest())
headers = {}
if self._x_simulated_trading == 1:
headers["x-simulated-trading"] = str(self._x_simulated_trading)
headers["OK-ACCESS-KEY"] = self._accessKey
headers["OK-ACCESS-PASSPHRASE"] = self._passphrase
headers["OK-ACCESS-TIMESTAMP"] = strTime
headers["OK-ACCESS-SIGN"] = signature
return self._httpRequest(httpMethod, path, query, params, headers)
# Encapsulates requests to the exchange API.
def GetTicker(self, symbol):
"""
GET /api/v5/market/ticker , param: instId
"""
baseCurrency, quoteCurrency = self.getCurrencys(symbol)
if baseCurrency == "" or quoteCurrency == "":
return {"error": "invalid symbol"}
path = "/api/v5/market/ticker"
query = f'instId={baseCurrency}-{quoteCurrency}'
data = self.callUnsignedAPI("GET", path, query=query)
if "error" in data.keys() and "data" not in data.keys():
return data
ret_data = {}
if data["code"] != "0" or not isinstance(data["data"], list):
return {"error": json.dumps(data, ensure_ascii=False)}
for tick in data["data"]:
if not all(k in tick for k in ("instId", "bidPx", "askPx", "high24h", "low24h", "vol24h", "ts")):
return {"error": json.dumps(data, ensure_ascii=False)}
ret_data["symbol"] = self.getSymbol(tick["instId"])
ret_data["buy"] = tick["bidPx"]
ret_data["sell"] = tick["askPx"]
ret_data["high"] = tick["high24h"]
ret_data["low"] = tick["low24h"]
ret_data["open"] = tick["open24h"]
ret_data["last"] = tick["last"]
ret_data["vol"] = tick["vol24h"]
ret_data["time"] = tick["ts"]
return {"data": ret_data, "raw": data}
def GetDepth(self, symbol):
"""
TODO: Implementation code
"""
# Mock data for testing.
ret_data = {
"time" : 1500793319499,
"asks" : [
[1000, 0.5], [1001, 0.23], [1004, 2.1]
],
"bids" : [
[999, 0.25], [998, 0.8], [995, 1.4]
]
}
return {"data": ret_data}
def GetTrades(self, symbol):
"""
TODO: Implementation code
"""
# Mock data for testing.
ret_data = [
{
"id": 12232153,
"time" : 1529919412968,
"price": 1000,
"amount": 0.5,
"type": "buy",
}, {
"id": 12545664,
"time" : 1529919412900,
"price": 1001,
"amount": 1,
"type": "sell",
}
]
return {"data": ret_data}
def GetRecords(self, symbol, period, limit):
"""
TODO: Implementation code
"""
# Mock data for testing.
ret_data = [
[1500793319, 1.1, 2.2, 3.3, 4.4, 5.5],
[1500793259, 1.01, 2.02, 3.03, 4.04, 5.05],
]
return {"data": ret_data}
def GetMarkets(self):
"""
TODO: Implementation code
"""
ret_data = {}
return {"data": ret_data}
def GetTickers(self):
"""
TODO: Implementation code
"""
ret_data = {}
return {"data": ret_data}
def GetAccount(self):
"""
GET /api/v5/account/balance
"""
path = "/api/v5/account/balance"
data = self.callSignedAPI("GET", path)
ret_data = []
if data["code"] != "0" or "data" not in data or not isinstance(data["data"], list):
return {"error": json.dumps(data, ensure_ascii=False)}
for ele in data["data"]:
if "details" not in ele or not isinstance(ele["details"], list):
return {"error": json.dumps(data, ensure_ascii=False)}
for detail in ele["details"]:
asset = {"currency": detail["ccy"], "free": detail["availEq"], "frozen": detail["ordFrozen"]}
if detail["availEq"] == "":
asset["free"] = detail["availBal"]
ret_data.append(asset)
return {"data": ret_data, "raw": data}
def GetAssets(self):
"""
TODO: Implementation code
"""
# Mock data for testing.
ret_data = [
{"currency": "TUSD", "free": "3000", "frozen": "0"},
{"currency": "BTC", "free": "0.2482982056277609", "frozen": "0"}
]
return {"data": ret_data}
def CreateOrder(self, symbol, side, price, amount):
"""
TODO: Implementation code
"""
# Mock data for testing.
ret_data = {
"id": "BTC-USDT,123456"
}
return {"data": ret_data}
def GetOrders(self, symbol):
"""
GET /api/v5/trade/orders-pending instType SPOT instId after limit
"""
baseCurrency, quoteCurrency = self.getCurrencys(symbol)
if baseCurrency == "" or quoteCurrency == "":
return {"error": "invalid symbol"}
path = "/api/v5/trade/orders-pending"
after = ""
limit = 100
ret_data = []
while True:
query = f"instType=SPOT&instId={baseCurrency}-{quoteCurrency}&limit={limit}"
if after != "":
query = f"instType=SPOT&instId={baseCurrency}-{quoteCurrency}&limit={limit}&after={after}"
data = self.callSignedAPI("GET", path, query=query)
if data["code"] != "0" or not isinstance(data["data"], list):
return {"error": json.dumps(data, ensure_ascii=False)}
for ele in data["data"]:
order = {}
order["id"] = f'{ele["instId"]},{ele["ordId"]}'
order["symbol"] = f'{baseCurrency}-{quoteCurrency}'
order["amount"] = ele["sz"]
order["price"] = ele["px"]
order["deal_amount"] = ele["accFillSz"]
order["avg_price"] = 0 if ele["avgPx"] == "" else ele["avgPx"]
order["type"] = "buy" if ele["side"] == "buy" else "sell"
order["state"] = "pending"
ret_data.append(order)
after = ele["ordId"]
if len(data["data"]) < limit:
break
return {"data": ret_data}
def GetOrder(self, orderId):
"""
TODO: Implementation code
"""
# Mock data for testing.
ret_data = {
"id": "ETH-USDT,123456",
"symbol": "ETH_USDT",
"amount": 0.15,
"price": 1002,
"status": "pending",
"deal_amount": 0,
"type": "buy",
"avg_price": 0,
}
return {"data": ret_data}
def GetHistoryOrders(self, symbol, since, limit):
"""
TODO: Implementation code
"""
# Mock data for testing.
ret_data = [
{
"id": "ETH-USDT,123456",
"symbol": "ETH_USDT",
"amount": 0.25,
"price": 1005,
"deal_amount": 0,
"avg_price": 1000,
"type": "buy",
"status": "filled"
}
]
return {"data": ret_data}
def CancelOrder(self, orderId):
"""
TODO: Implementation code
"""
# Mock data for testing.
ret_data = True
return {"data": ret_data}
def IO(self, httpMethod, path, params={}):
if httpMethod == "GET":
query = urllib.parse.urlencode(params)
data = self.callSignedAPI(httpMethod, path, query=query)
else:
data = self.callSignedAPI(httpMethod, path, params=params)
if data["code"] != "0":
return {"error": json.dumps(data, ensure_ascii=False)}
return {"data": data}
class HttpServer(http.server.SimpleHTTPRequestHandler):
def __init__(self, *args, **kwargs):
self.request_body = None
self.request_path = None
super().__init__(*args, **kwargs)
def log_message(self, format, *args):
return
def _sendResponse(self, body):
self.send_response(200)
self.send_header('Content-type', 'application/json; charset=utf-8')
self.end_headers()
self.wfile.write(json.dumps(body).encode('utf-8'))
def do_GET(self):
# The FMZ.COM custom protocol only send GET method request
self._sendResponse({"error": "not support GET method."})
def do_POST(self):
"""
Returns:
json: success, {"data": ...}
json: error, {"error": ...}
"""
contentLen = int(self.headers['Content-Length'])
self.request_body = self.rfile.read(contentLen)
self.request_path = self.path
exName = self.request_path.lstrip("/")
# Print the request received from the FMZ.COM robot
print(f"--------- request received from the FMZ.COM robot: --------- \n {self.requestline} | Body: {self.request_body} | Headers: {self.headers} \n")
try:
data = json.loads(self.request_body)
except json.JSONDecodeError:
data = {"error": self.request_body.decode('utf-8')}
self._sendResponse(data)
return
# fault tolerant
if not all(k in data for k in ("access_key", "secret_key", "method", "params")):
data = {"error": "missing required parameters"}
self._sendResponse(data)
return
respData = {}
accessKey = data["access_key"]
secretKey = data["secret_key"]
method = data["method"]
params = data["params"]
exchange = ProtocolFactory.createExWrapper("https://www.okx.com", accessKey, secretKey, exName)
if method == "ticker":
symbol = str(params["symbol"]).upper()
respData = exchange.GetTicker(symbol)
elif method == "depth":
symbol = str(params["symbol"]).upper()
respData = exchange.GetDepth(symbol)
elif method == "trades":
symbol = str(params["symbol"]).upper()
respData = exchange.GetTrades(symbol)
elif method == "records":
symbol = str(params["symbol"]).upper()
period = int(params["period"])
limit = int(params["limit"])
respData = exchange.GetRecords(symbol, period, limit)
elif method == "accounts":
respData = exchange.GetAccount()
elif method == "assets":
respData = exchange.GetAssets()
elif method == "trade":
amount = float(params["amount"])
price = float(params["price"])
symbol = str(params["symbol"])
tradeType = str(params["type"])
respData = exchange.CreateOrder(symbol, tradeType, price, amount)
elif method == "orders":
symbol = str(params["symbol"]).upper()
respData = exchange.GetOrders(symbol)
elif method == "order":
orderId = str(params["id"])
respData = exchange.GetOrder(orderId)
elif method == "historyorders":
symbol = str(params["symbol"])
since = int(params["since"])
limit = int(params["limit"])
respData = exchange.GetHistoryOrders(symbol, since, limit)
elif method == "cancel":
orderId = str(params["id"])
respData = exchange.CancelOrder(orderId)
elif method[:6] == "__api_":
respData = exchange.IO(self.headers["Http-Method"], method[6:], params)
else:
respData = {"error": f'invalid method: {method}'}
# Print the response to send to FMZ.COM robot
print(f"response to send to FMZ.COM robot: {respData} \n")
self._sendResponse(respData)
if __name__ == "__main__":
parser = argparse.ArgumentParser(description="Run a FMZ.COM custom protocol plugin.")
parser.add_argument("--port", type=int, default=6666, help="Port to run the server on.")
parser.add_argument("--address", type=str, default="localhost", help="Address to bind the server to.")
args = parser.parse_args()
with socketserver.TCPServer((args.address, args.port), HttpServer) as httpd:
print(f"running... {args.address}:{args.port}", "\n")
httpd.serve_forever()
- 1