11 KiB
11 KiB
@rugmunch/sdk@0.1.0
A TypeScript SDK client for the localhost API.
Usage
First, install the SDK from npm.
npm install @rugmunch/sdk --save
Next, try it out.
import {
Configuration,
AdminAlertsApi,
} from '@rugmunch/sdk';
import type { AlertsCriticalWebhookApiV1AdminAlertsCriticalPostRequest } from '@rugmunch/sdk';
async function example() {
console.log("🚀 Testing @rugmunch/sdk SDK...");
const api = new AdminAlertsApi();
const body = {
// AlertmanagerPayload
alertmanagerPayload: ...,
} satisfies AlertsCriticalWebhookApiV1AdminAlertsCriticalPostRequest;
try {
const data = await api.alertsCriticalWebhookApiV1AdminAlertsCriticalPost(body);
console.log(data);
} catch (error) {
console.error(error);
}
}
// Run the test
example().catch(console.error);
Documentation
API Endpoints
All URIs are relative to http://localhost
| Class | Method | HTTP request | Description |
|---|---|---|---|
| AdminAlertsApi | alertsCriticalWebhookApiV1AdminAlertsCriticalPost | POST /api/v1/admin/alerts/critical | Alerts Critical Webhook |
| AdminAlertsApi | alertsRecentApiV1AdminAlertsRecentGet | GET /api/v1/admin/alerts/recent | Alerts Recent |
| AdminAlertsApi | alertsWebhookApiV1AdminAlertsWebhookPost | POST /api/v1/admin/alerts/webhook | Alerts Webhook |
| AlertsApi | cancelApiV1AlertsAlertIdDelete | DELETE /api/v1/alerts/{alert_id} | Cancel |
| AlertsApi | listAlertsApiV1AlertsGet | GET /api/v1/alerts | List Alerts |
| AlertsApi | subscribeApiV1AlertsSubscribePost | POST /api/v1/alerts/subscribe | Subscribe |
| CatalogApi | attachRagApiV1CatalogTokensChainAddressAttachRagPost | POST /api/v1/catalog/tokens/{chain}/{address}/attach-rag | Attach Rag |
| CatalogApi | getTokenApiV1CatalogTokensChainAddressGet | GET /api/v1/catalog/tokens/{chain}/{address} | Get Token |
| CatalogApi | getTokenRiskApiV1CatalogTokensChainAddressRiskGet | GET /api/v1/catalog/tokens/{chain}/{address}/risk | Get Token Risk |
| CatalogApi | getWalletApiV1CatalogWalletsChainAddressGet | GET /api/v1/catalog/wallets/{chain}/{address} | Get Wallet |
| CatalogApi | probeApiV1CatalogProbeGet | GET /api/v1/catalog/probe | Probe |
| CatalogApi | ragIngestApiV1CatalogRagIngestPost | POST /api/v1/catalog/rag/ingest | Rag Ingest |
| CatalogApi | ragSearchApiV1CatalogRagSearchPost | POST /api/v1/catalog/rag/search | Rag Search |
| CatalogApi | resolveEntityApiV1CatalogEntitiesResolvePost | POST /api/v1/catalog/entities/resolve | Resolve Entity |
| CatalogApi | riskyTokensApiV1CatalogTokensRiskyByDeployerPost | POST /api/v1/catalog/tokens/risky-by-deployer | Risky Tokens |
| CatalogApi | statsApiV1CatalogStatsGet | GET /api/v1/catalog/stats | Stats |
| HealthApi | healthHealthGet | GET /health | Health |
| HealthApi | liveLiveGet | GET /live | Live |
| HealthApi | readyReadyGet | GET /ready | Ready |
| McpApi | directCallMcpCallToolIdPost | POST /mcp/call/{tool_id} | Direct Call |
| McpApi | jsonrpcHandlerMcpPost | POST /mcp | Jsonrpc Handler |
| McpApi | listToolsMcpToolsGet | GET /mcp/tools | List Tools |
| MetaApi | versionVersionGet | GET /version | Version |
| NewsApi | analyzeNewsApiV1NewsNewsIdAnalyzePost | POST /api/v1/news/{news_id}/analyze | Analyze News |
| NewsApi | getNewsApiV1NewsNewsIdGet | GET /api/v1/news/{news_id} | Get News |
| NewsApi | listNewsApiV1NewsPost | POST /api/v1/news | List News |
| NewsApi | trendingNewsApiV1NewsTrendingGet | GET /api/v1/news/trending | Trending News |
| NewsAdminApi | triggerIngestApiV1NewsAdminIngestPost | POST /api/v1/news/_admin/ingest | Trigger Ingest |
| RagApi | bulkApiV1RagV2BulkIngestPost | POST /api/v1/rag/v2/bulk-ingest | Bulk |
| RagApi | feedbackApiV1RagV2FeedbackPost | POST /api/v1/rag/v2/feedback | Feedback |
| RagApi | ingestApiV1RagV2IngestPost | POST /api/v1/rag/v2/ingest | Ingest |
| RagApi | searchApiV1RagV2SearchPost | POST /api/v1/rag/v2/search | Search |
| RagApi | statsApiV1RagV2StatsGet | GET /api/v1/rag/v2/stats | Stats |
| ReportsApi | generateReportApiV1ReportsGeneratePost | POST /api/v1/reports/generate | Generate Report |
| ReportsApi | getReportApiV1ReportsReportIdGet | GET /api/v1/reports/{report_id} | Get Report |
| ScannerApi | scanApiV1ScannerScanPost | POST /api/v1/scanner/scan | Scan |
| TokenApi | getDetailApiV1TokenAddressGet | GET /api/v1/token/{address} | Get Detail |
| TokenApi | getHoldersApiV1TokenAddressHoldersGet | GET /api/v1/token/{address}/holders | Get Holders |
| TokenApi | getLiquidityApiV1TokenAddressLiquidityGet | GET /api/v1/token/{address}/liquidity | Get Liquidity |
| TokenApi | getRiskApiV1TokenAddressRiskGet | GET /api/v1/token/{address}/risk | Get Risk |
| TokenApi | scanApiV1TokenScanPost | POST /api/v1/token/scan | Scan |
| WalletApi | getAnalysisApiV1WalletAddressAnalysisGet | GET /api/v1/wallet/{address}/analysis | Get Analysis |
| WalletApi | getBalanceApiV1WalletAddressBalanceGet | GET /api/v1/wallet/{address}/balance | Get Balance |
| WalletApi | getTransactionsApiV1WalletAddressTransactionsGet | GET /api/v1/wallet/{address}/transactions | Get Transactions |
| WalletApi | scanApiV1WalletScanPost | POST /api/v1/wallet/scan | Scan |
| X402Api | catalogApiV1X402CatalogGet | GET /api/v1/x402/catalog | Catalog |
| X402Api | receiptApiV1X402ReceiptsTxHashGet | GET /api/v1/x402/receipts/{tx_hash} | Receipt |
| X402Api | usageApiV1X402UsageGet | GET /api/v1/x402/usage | Usage |
| X402Api | verifyPaymentApiV1X402VerifyPost | POST /api/v1/x402/verify | Verify Payment |
Models
- AlertSubscription
- AlertType
- AlertmanagerAlert
- AlertmanagerPayload
- AppDomainScannerModelsScanRequest
- AppDomainTokenModelsRiskLevel
- AppDomainWalletModelsScanRequest
- AttachRagRequest
- Balance
- BulkIngestRequest
- CatalogResponse
- CreateAlertRequest
- FeedbackRecord
- FindRiskyTokensRequest
- GenerateRequest
- GenerateResponse
- HTTPValidationError
- Id
- IngestRequest
- IngestResult
- JsonRpcRequest
- LocationInner
- NewsAnalysisResponse
- NewsItemOut
- NewsListResponse
- PaginatedResponse
- RagIngestRequest
- RagSearchRequest
- ReceiptResponse
- ResolveEntityRequest
- ScanFlag
- ScanModuleResult
- ScanResponse
- ScanResult
- ScanTier
- SearchHit
- SearchRequest
- SearchResponse
- TokenDetail
- TokenHolding
- TokenRisk
- TokenScanRequest
- TokenScanResult
- Transaction
- UsageResponse
- ValidationError
- WalletAnalysis
Authorization
Endpoints do not require authorization.
About
This TypeScript SDK client supports the Fetch API and is automatically generated by the OpenAPI Generator project:
- API version:
2026.06.21 - Package version:
0.1.0 - Generator version:
7.23.0 - Build package:
org.openapitools.codegen.languages.TypeScriptFetchClientCodegen
The generated npm module supports the following:
- Environments
- Node.js
- Webpack
- Browserify
- Language levels
- ES5 - you must have a Promises/A+ library installed
- ES6
- Module systems
- CommonJS
- ES6 module system
Development
Building
To build the TypeScript source code, you need to have Node.js and npm installed. After cloning the repository, navigate to the project directory and run:
npm install
npm run build
Publishing
Once you've built the package, you can publish it to npm:
npm publish