Genesis Arbitrage

Genesis Arbitrage · · 8 मिनट में पढ़ें

Genesis API key: कैसे पाएँ, कहाँ रखें, और reissue व revoke कैसे करें

संक्षेप में

  • gns_live_… key आपकी प्रोफ़ाइल में "key पाएँ" बटन से बनती है और केवल एक बार दिखती है। हम सिर्फ़ उसका hash रखते हैं, इसलिए खोई हुई key वापस नहीं मिल सकती, केवल दोबारा जारी की जा सकती है।
  • key X-API-Key हेडर में आपके अपने सर्वर से भेजी जाती है। कोड इसे GENESIS_API_KEY environment variable से पढ़ता है; यह कभी request URL या वेबसाइट के कोड में नहीं जाती।
  • key लीक हो जाए तो "Reissue" दबाएँ: पुरानी key तुरंत बंद हो जाती है और आप उसे हर प्रोग्राम में बदल देते हैं। हर अकाउंट को एक key मिलती है।

Genesis API की API key एक gns_live_… स्ट्रिंग है जो पासवर्ड की तरह काम करती है: सर्वर इससे आपका अकाउंट और प्लान पहचानता है। इसे हर request के साथ X-API-Key HTTP हेडर में भेजा जाता है; key न हो या ग़लत हो तो API 401 invalid_key लौटाता है। हर अकाउंट को एक key मिलती है, और उसे आप Genesis Arbitrage प्रोफ़ाइल में पाते, reissue करते और revoke करते हैं।

key कहाँ रहती है

key का प्रबंधन प्रोफ़ाइल के "Genesis API" ब्लॉक में होता है; प्रोफ़ाइल के बाक़ी ब्लॉक अकाउंट प्रोफ़ाइल गाइड में हैं। ब्लॉक आपकी API सदस्यता और key की स्थिति दिखाता है:

आप क्या देखते हैंमतलब
"सदस्यता निष्क्रिय", "सदस्यता लें" बटनअभी कोई API प्लान नहीं; बटन प्लान खोलता है
"सदस्यता सक्रिय", "सक्रिय — … तक", "नवीनीकरण" बटनप्लान उस तारीख़ तक चलता है
"सदस्यता समाप्त", "नवीनीकरण" बटनअवधि ख़त्म: key अस्वीकार होती है और नवीनीकरण तक key के बटन छिपे रहते हैं
"अभी कोई key नहीं बनी", "key पाएँ" बटनप्लान है, पर key अभी नहीं है
"API key" और gns_live_…सक्रिय key की शुरुआत; पूरी key दोबारा कभी नहीं दिखती
"बनी …" · "उपयोग …"key कब बनी और उसने आख़िरी request कब की
"उपयोग की गई calls", "req/s", "freshness", "रीसेट …"इस्तेमाल हुआ कोटा, प्रति सेकंड requests की सीमा, डेटा की देरी और काउंटर रीसेट होने की तारीख़

ब्लॉक के कोने में "डॉक्यूमेंटेशन" लिंक Genesis API डॉक्यूमेंटेशन खोलता है। कोटा और सीमाएँ Genesis API की सीमाएँ गाइड में समझाई गई हैं।

key कैसे पाएँ

  1. API प्लान की सदस्यता लें

    Genesis API की क़ीमतें पेज पर Trial, Start, Pro या Max और अवधि चुनें, "सदस्यता लें" दबाएँ और इनवॉइस का भुगतान क्रिप्टो में करें। आपकी प्रोफ़ाइल में स्थिति "सदस्यता सक्रिय" हो जाती है।

  2. "key पाएँ" दबाएँ

    जब तक आपके पास key नहीं है, यह बटन "Genesis API" ब्लॉक में दिखता है। key तुरंत बन जाती है।

  3. "आपकी API key" विंडो से key सहेजें

    विंडो पूरी key एक ही बार दिखाती है। "कॉपी" दबाएँ और key को पासवर्ड मैनेजर में या सीधे अपने सर्वर के सुरक्षित variables में रखें। "हो गया" के बाद पूरी key दोबारा नहीं दिखेगी: हम सिर्फ़ उसका hash रखते हैं।

  4. request से key जाँचें

    नीचे के उदाहरणों की तरह /account/usage को कॉल करें। data.plan में आपके प्लान के साथ 200 जवाब का मतलब है कि key स्वीकार हो गई।

key कैसे भेजें

key केवल X-API-Key हेडर में जाती है। सर्वर key को URL पैरामीटर या Authorization हेडर से नहीं पढ़ता और 401 देता है। उदाहरण key को GENESIS_API_KEY environment variable से पढ़ते हैं; बेस URL https://api.genesisarbitrage.com/v1 है।

curl:

# the key comes from an environment variable
curl "https://api.genesisarbitrage.com/v1/account/usage" \
  -H "X-API-Key: $GENESIS_API_KEY"

requests लाइब्रेरी के साथ Python 3.10+:

import os

import requests

# os.environ[...] fails right away if the variable is not set
key = os.environ["GENESIS_API_KEY"]

r = requests.get(
    "https://api.genesisarbitrage.com/v1/account/usage",
    headers={"X-API-Key": key},
    timeout=10,
)
r.raise_for_status()
print(r.json()["data"]["plan"])

JavaScript, बिल्ट-इन fetch के साथ Node.js 18+:

// .mjs file: modules allow top-level await
const key = process.env.GENESIS_API_KEY;
if (!key) throw new Error('GENESIS_API_KEY is not set');

const res = await fetch(
  'https://api.genesisarbitrage.com/v1/account/usage',
  { headers: { 'X-API-Key': key } },
);
const body = await res.json();
console.log(res.status, body.data?.plan);

तीनों requests एक ही जवाब लौटाती हैं (उदाहरण के मान):

{
  "success": true,
  "data": {
    "plan": "pro",
    "calls_used": 184201,
    "calls_limit": 5000000,
    "rps_limit": 5,
    "freshness_sec": 10,
    "period_resets_at": 1786492800
  },
  "meta": { … }
}

जवाब के फ़ील्ड डॉक्यूमेंटेशन के उपयोग सेक्शन में समझाए गए हैं।

key कहाँ रखें

Genesis API key केवल डेटा पढ़ती है: इससे ट्रेड नहीं किया जा सकता और फ़ंड नहीं निकाले जा सकते। पर लीक की क़ीमत कुछ और है: दूसरों के प्रोग्राम आपका कोटा और प्रति सेकंड requests की सीमा खर्च कर देते हैं।

जगहठीक हैक्यों
सर्वर पर environment variableहाँkey कोड और repository से बाहर रहती है
.gitignore में दर्ज .env फ़ाइलहाँpython-dotenv (load_dotenv()) और Node.js 20.6+ में node --env-file=.env इसे लोड करते हैं
होस्टिंग और CI के secretsहाँप्लेटफ़ॉर्म शुरू होते समय key प्रोग्राम को देता है; GitHub Actions में repository secret, जिसे step के env से पास किया जाता है
पासवर्ड मैनेजरहाँइंसान के लिए बैकअप कॉपी
Request URLनहींURL सर्वर और प्रॉक्सी के लॉग और ब्राउज़र हिस्ट्री में पहुँच जाते हैं
वेबसाइट, एक्सटेंशन या मोबाइल ऐप का कोडनहींपेज का सोर्स खोलने या ऐप खोलने वाला कोई भी key देख लेता है
पब्लिक repositoryनहींफ़ाइल हटाने के बाद भी key commit इतिहास में रहती है
स्क्रीनशॉट, चैट, सपोर्ट टिकटनहींसंदेश और तस्वीरें आगे भेजी जाती हैं

अगर डेटा ब्राउज़र तक पहुँचाना हो, जैसे डैशबोर्ड या एक्सटेंशन में, तो आपका सर्वर Genesis API को कॉल करता है और ब्राउज़र को तैयार नतीजा आपके सर्वर से मिलता है। सपोर्ट को जवाब का X-Request-Id, UTC में request का समय, endpoint और स्टेटस चाहिए, key कभी नहीं। ट्रेडिंग अधिकार वाली एक्सचेंज keys ज़्यादा जोखिम भरी हैं; उन्हें सीमित करने का तरीक़ा क्रिप्टो एक्सचेंज अकाउंट को सुरक्षित कैसे रखें में है।

Reissue और revoke

बटनक्या होता हैकब इस्तेमाल करें
"Reissue"पुरानी key तुरंत बंद हो जाती है, और "आपकी API key" विंडो नई key दिखाती हैkey लीक हुई या खो गई, या जिसके पास थी वह चला गया
"Revoke"key बिना बदले बंद हो जाती है और API एक्सेस बंद हो जाता है; ब्लॉक फिर "key पाएँ" दिखाता हैअब key की ज़रूरत नहीं

दोनों बटन पहले पुष्टि माँगते हैं। डायलॉग में लिखा होता है "key दोबारा जारी करें? मौजूदा key तुरंत बंद हो जाएगी।" और "key revoke करें? वह तुरंत बंद हो जाएगी और API एक्सेस बंद हो जाएगा।", साथ में "रद्द करें" और "पुष्टि करें"। key लीक हो जाए तो:

  1. key दोबारा जारी करें

    "Reissue" दबाएँ, फिर "पुष्टि करें", और नई key "आपकी API key" विंडो से सहेजें। उसी क्षण से पुरानी key वाली requests को 401 मिलता है।

  2. हर प्रोग्राम में key बदलें

    environment variables, .env फ़ाइलें और CI व होस्टिंग के secrets अपडेट करें, फिर प्रोग्राम दोबारा शुरू करें: प्रोसेस अपना environment शुरू होते समय पढ़ती है। अगर कोई प्रोग्राम अब भी पुरानी key भेज रहा है, तो देखें कि GENESIS_API_KEY environment में पहले से तो सेट नहीं है: python-dotenv और node --env-file पहले से सेट variable को .env के मान से नहीं बदलते।

  3. calls का उपयोग जाँचें

    प्रोफ़ाइल की "उपयोग की गई calls" पंक्ति या /account/usage की request दिखाती है कि इस अवधि में कितनी calls खर्च हुईं। Reissue काउंटर रीसेट नहीं करता।

401 invalid_key: क्या जाँचें

सर्वर invalid_key कोड के साथ 401 तब देता है जब key न हो, ग़लत हो या revoke हो चुकी हो, या सदस्यता समाप्त हो गई हो:

{
  "success": false,
  "error": {
    "code": "invalid_key",
    "message": "Missing X-API-Key header."
  }
}

अगर हेडर पहुँचा पर key अस्वीकार हुई, तो message सारे संभावित कारण एक साथ गिनाता है। 403 plan_restricted जवाब का मतलब अलग है: key स्वीकार हुई, पर endpoint आपके प्लान में नहीं है। बाक़ी कोड एरर सेक्शन और Genesis API के जवाब और एरर गाइड में हैं।

डॉक्यूमेंटेशन में "Try it" फ़ॉर्म

डॉक्यूमेंटेशन में हर endpoint पर "Try it" फ़ॉर्म है। key को "आपकी API key (gns_live_…)" फ़ील्ड में पेस्ट करें और "रिक्वेस्ट भेजें" दबाएँ: फ़ॉर्म के नीचे स्टेटस कोड, जवाब का समय और छोटा किया गया जवाब दिखता है। key केवल आपके ब्राउज़र में रहती है और API के अलावा कहीं नहीं भेजी जाती।

ब्राउज़र key याद रखता है और अगली बार फ़ील्ड भर देता है, इसलिए किसी और के कंप्यूटर पर फ़ॉर्म इस्तेमाल न करें। फ़ॉर्म की request एक सामान्य API कॉल है: वह कोड की request की तरह ही कोटा और प्रति सेकंड requests की सीमा खर्च करती है। कोड से आपकी पहली request, जवाब की व्याख्या के साथ, Genesis API क्विकस्टार्ट में है।

सवाल और जवाब

क्या हर बॉट के लिए अलग key हो सकती है?

नहीं, हर अकाउंट को एक key मिलती है। उसे इस्तेमाल करने वाले सभी प्रोग्राम calls का कोटा और प्रति सेकंड requests की सीमा आपस में बाँटते हैं। सीमाएँ कम पड़ें तो प्लान बढ़ाएँ: सीमाओं से बचने के लिए कई अकाउंट खोलना नियमों के विरुद्ध है।

क्या reissue calls का काउंटर रीसेट कर देता है?

नहीं। "उपयोग की गई calls" अकाउंट की सदस्यता की होती हैं, key की नहीं: नई key उसी 30 दिन की अवधि को आगे बढ़ाती है।

क्या हेडर को छोटे अक्षरों में x-api-key लिख सकते हैं?

हाँ। HTTP हेडर नाम case-insensitive होते हैं, यह नियम RFC 9110 के सेक्शन 5.1 में है। key को ख़ुद बिना बदले भेजना होगा।

क्या नवीनीकरण के बाद नई key चाहिए?

नहीं। सदस्यता समाप्त रहने तक key को 401 मिलता है, और "नवीनीकरण" के बाद वही key फिर चलती है।