### RugCheck API Tokens - Get Token Report Summary Source: https://api.rugcheck.xyz/swagger/index Fetches a summary of the report for a specific token. The GET request to `/tokens/{id}/report/summary` provides a concise overview of a token's report status. ```http GET /tokens/{id}/report/summary ``` -------------------------------- ### RugCheck API Domain Management - Get Registered Domains Source: https://api.rugcheck.xyz/swagger/index Retrieves a list of all registered domains through the RugCheck API. This GET request to `/domains` is useful for users who want to see the domains managed by the platform. ```http GET /domains ``` -------------------------------- ### RugCheck API Tokens - Get Full Token Report Source: https://api.rugcheck.xyz/swagger/index Retrieves a comprehensive report for a specific token. The GET request to `/tokens/{id}/report` provides detailed information about the token. ```http GET /tokens/{id}/report ``` -------------------------------- ### Get Registered Domains Source: https://api.rugcheck.xyz/swagger/doc Retrieves a list of all registered .token domains. This GET endpoint supports pagination through a 'page' query parameter, returning results in JSON format. ```json { "schemes": [], "swagger": "2.0", "info": { "description": "JWT token for authentication", "title": "RugCheck API", "contact": {}, "license": {}, "version": "1.0" }, "host": "api.rugcheck.xyz", "basePath": "/v1", "paths": { "/domains": { "get": { "description": "Returns all registered .token domains", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "Domains" ], "summary": "Get registered domains", "parameters": [ { "type": "integer", "description": "Page number for results", "name": "page", "in": "query" } ] } } } } ``` -------------------------------- ### RugCheck API Vaults - Get Token LP Vaults Source: https://api.rugcheck.xyz/swagger/index Retrieves information about a token's Liquidity Provider (LP) vaults. This GET request to `/tokens/{id}/lockers` provides details on how a token's liquidity is secured. ```http GET /tokens/{id}/lockers ``` -------------------------------- ### RugCheck API General - Get Leaderboard Source: https://api.rugcheck.xyz/swagger/index Fetches the current leaderboard data. This endpoint, `/leaderboard`, is useful for tracking rankings and performance within the RugCheck ecosystem. ```http GET /leaderboard ``` -------------------------------- ### RugCheck API Vaults - Get Token LP Vaults from Flux Locker Source: https://api.rugcheck.xyz/swagger/index Fetches a token's LP vaults specifically from the Flux locker. This GET request to `/tokens/{id}/lockers/flux` is for accessing liquidity information from a particular locker type. ```http GET /tokens/{id}/lockers/flux ``` -------------------------------- ### Get Domains CSV Source: https://api.rugcheck.xyz/swagger/doc Exports all registered .token domains as a CSV file. Allows filtering for domains with verification set. ```json { "description": "Returns all registered .token domains as CSV", "produces": [ "text/csv" ], "tags": [ "Domains" ], "summary": "Get domains CSV", "parameters": [ { "type": "boolean", "description": "Filter to only domains with verification set", "name": "verified", "in": "query" } ], "responses": { "200": { "description": "CSV file containing domain data", "schema": { "type": "file" } } } } ``` -------------------------------- ### Get Domains List Source: https://api.rugcheck.xyz/swagger/doc Retrieves a list of all registered domains. Supports filtering by verification status and limiting the number of results. ```json { "parameters": [ { "type": "integer", "description": "Limit number of results", "name": "limit", "in": "query" }, { "type": "boolean", "description": "Filter to only domains with verification set", "name": "verified", "in": "query" } ], "responses": { "200": { "description": "Returns all registered domains", "schema": { "$ref": "#/definitions/dto.DomainResponse" } } } } ``` -------------------------------- ### RugCheck API Tokens - Get Token Insider Graph Source: https://api.rugcheck.xyz/swagger/index Fetches the insider graph for a specific token. This GET request to `/tokens/{id}/insiders/graph` provides insights into token ownership and activity. ```http GET /tokens/{id}/insiders/graph ``` -------------------------------- ### RugCheck API Domain Management - Get Domains CSV Source: https://api.rugcheck.xyz/swagger/index Allows users to download domain data in CSV format. This endpoint, `/domains/data.csv`, is useful for bulk analysis or offline processing of registered domain information. ```http GET /domains/data.csv ``` -------------------------------- ### Get Leaderboard Rankings Source: https://api.rugcheck.xyz/swagger/doc Retrieves user leaderboard rankings. Supports pagination with 'page' and 'limit' query parameters. ```json { "description": "Get user leaderboard rankings", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "General" ], "summary": "Get leaderboard", "parameters": [ { "type": "integer", "default": 0, "description": "Page number", "name": "page", "in": "query" }, { "type": "integer", "default": 50, "description": "Results per page", "name": "limit", "in": "query" } ], "responses": { "200": { "description": "Leaderboard rankings", "schema": { ``` -------------------------------- ### Get Verified Tokens Source: https://api.rugcheck.xyz/swagger/doc Fetches a list of tokens that have been verified. This endpoint is part of the statistics endpoints. ```json { "get": { "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "Stats" ] } } ``` -------------------------------- ### Get Token Report Summary Source: https://api.rugcheck.xyz/swagger/doc Generates a summary report for a given token mint address. Allows filtering by cached reports only. Handles successful summaries, invalid parameters, and cases where the token is not found. ```json { "description": "Generate a report summary for given token mint", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "Tokens" ], "summary": "Get token report summary", "parameters": [ { "type": "string", "description": "Token mint address", "name": "id", "in": "path", "required": true }, { "type": "string", "description": "Only return cached reports", "name": "cacheOnly", "in": "query" } ], "responses": { "200": { "description": "Token report summary", "schema": { "$ref": "#/definitions/dto.TokenCheckSummary" } }, "400": { "description": "Invalid parameters", "schema": { "$ref": "#/definitions/dto.ErrorResponse" } }, "404": { "description": "Token not found", "schema": { "$ref": "#/definitions/dto.ErrorResponse" } } } } ``` -------------------------------- ### RugCheck API Votes - Get Token Votes Source: https://api.rugcheck.xyz/swagger/index Retrieves the votes cast for a specific token. This GET request to `/tokens/{id}/votes` provides information on community sentiment and voting activity for a token. ```http GET /tokens/{id}/votes ``` -------------------------------- ### Get Token Report Source: https://api.rugcheck.xyz/swagger/doc Retrieves a full report for a given token mint address. Supports responses for successful reports, invalid parameters, and rate limiting. ```json { "name": "id", "in": "path", "required": true } { "200": { "description": "Full token report", "schema": { "$ref": "#/definitions/rugcheck_api.TokenCheck" } }, "400": { "description": "Invalid parameters", "schema": { "$ref": "#/definitions/dto.ErrorResponse" } }, "429": { "description": "Rate limit exceeded", "schema": { "$ref": "#/definitions/dto.ErrorResponse" } } } ``` -------------------------------- ### RugCheck API Tokens - Get Verification Transaction Source: https://api.rugcheck.xyz/swagger/index Retrieves the transaction details for token verification. This POST request to `/tokens/verify/transaction` is essential for tracking the verification process. ```http POST /tokens/verify/transaction ``` -------------------------------- ### RugCheck API Stats - Get Recently Detected Tokens Source: https://api.rugcheck.xyz/swagger/index Fetches a list of tokens that have been recently detected by the platform. This endpoint, `/stats/new_tokens`, is useful for identifying emerging tokens. ```http GET /stats/new_tokens ``` -------------------------------- ### Get Token Verification Transaction Source: https://api.rugcheck.xyz/swagger/doc Retrieves the transaction details associated with a token's verification process. This endpoint requires authentication and a Transaction request object in the body. It is used to get information about the verification transaction. ```json { "post": { "security": [ { "ApiKeyAuth": [] } ], "description": "Get transaction for token verification", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "Tokens" ], "summary": "Get verification transaction", "parameters": [ { "description": "Transaction request", "name": "request", "in": "body", "required": true, "schema": { "$ref": "#/definitions/dto.TokenVerificationRequest" } } ] } } ``` -------------------------------- ### Get Domain Records Source: https://api.rugcheck.xyz/swagger/doc Fetches the records associated with a specific domain name. The domain name is provided as a path parameter. ```json { "description": "Returns the related domain records", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "Domains" ], "summary": "Get domain records", "parameters": [ { "type": "string", "description": "Domain name", "name": "id", "in": "path", "required": true } ], "responses": { "200": { "description": "Domain records", "schema": { "type": "object" } } } } ``` -------------------------------- ### Get Recently Detected Tokens Source: https://api.rugcheck.xyz/swagger/doc Fetches a list of tokens that have been recently detected by the system. The response includes an array of token objects. ```json { "get": { "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "Stats" ], "summary": "Recently detected tokens", "responses": { "200": { "description": "Returns the recently detected tokens", "schema": { "type": "array", "items": { "$ref": "#/definitions/rugcheck_api.Token" } } } } } } ``` -------------------------------- ### Get Maintenance Service Status Source: https://api.rugcheck.xyz/swagger/doc Checks the status of the maintenance service. Returns a 200 OK response if the system is operational. ```json { "get": { "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "General" ], "summary": "Maintenance service", "responses": { "200": { "description": "System operational" } } } } ``` -------------------------------- ### Get Full Token Report Source: https://api.rugcheck.xyz/swagger/doc This endpoint generates a detailed report for a given token mint address. It requires the token mint address as a path parameter and is expected to return a comprehensive report. The content type is JSON. ```json { "get": { "description": "Generate a detailed report for given token mint", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "Tokens" ], "summary": "Get full token report", "parameters": [ { "type": "string", "description": "Token mint address", "name": "id", "in": "path", "required": true } ] } } ``` -------------------------------- ### RugCheck API Stats - Get Recently Verified Tokens Source: https://api.rugcheck.xyz/swagger/index Retrieves a list of tokens that have been recently verified. The `/stats/verified` endpoint is helpful for finding tokens that have passed the platform's verification process. ```http GET /stats/verified ``` -------------------------------- ### Get Recently Verified Tokens Source: https://api.rugcheck.xyz/swagger/doc Retrieves a list of tokens that have been recently verified by the API. This endpoint returns an array of VerifiedToken objects. ```json { "summary": "Recently verified tokens", "responses": { "200": { "description": "Returns the recently verified tokens", "schema": { "type": "array", "items": { "$ref": "#/definitions/rugcheck_api.VerifiedToken" } } } } } ``` -------------------------------- ### Get RPC Node Statistics Source: https://api.rugcheck.xyz/swagger/doc Retrieves statistics related to the usage of the RPC node. This endpoint provides insights into the node's activity. ```json { "get": { "description": "Get statistics about RPC node usage", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "General" ], "summary": "Get RPC statistics" } } ``` -------------------------------- ### Get Token LP Vaults from Flux Locker Source: https://api.rugcheck.xyz/swagger/doc This endpoint retrieves the LP vaults for a given token mint address specifically from the flux locker. It requires the token mint address as a path parameter and returns a dto.VaultResponse on success. Authentication is required via an API key. ```json { "get": { "security": [ { "ApiKeyAuth": [] } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "Vaults" ], "summary": "Returns the tokens LP vaults from flux locker", "parameters": [ { "type": "string", "description": "Token mint address", "name": "id", "in": "path", "required": true } ], "responses": { "200": { "description": "Returns the tokens LP lockers from flux locker", "schema": { "$ref": "#/definitions/dto.VaultResponse" } } } } } ``` -------------------------------- ### Get Most Viewed Tokens (24h) Source: https://api.rugcheck.xyz/swagger/doc Provides a list of tokens that have been most viewed in the last 24 hours. Note that only users who have connected their wallet have their views counted. ```json { "get": { "description": "Only users who have connected their wallet have their views counted", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "Stats" ], "summary": "Most viewed tokens in past 24 hours", "responses": { "200": { "description": "Returns the most viewed for token mints", "schema": { "type": "array", "items": { "$ref": "#/definitions/dto.TokenInfoAgg" } } } } } } ``` -------------------------------- ### RugCheck API Stats - Get Most Voted Tokens Source: https://api.rugcheck.xyz/swagger/index Fetches tokens that have received the most votes. This endpoint, `/stats/trending`, is useful for identifying community-favored tokens. ```http GET /stats/trending ``` -------------------------------- ### Get Most Voted Tokens (24h) Source: https://api.rugcheck.xyz/swagger/doc Returns a list of tokens that have received the most votes in the past 24 hours. Voting is restricted to users who have connected their wallet. ```json { "get": { "description": "Only users who have connected their wallet are able to vote", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "Stats" ], "summary": "Most voted for tokens in past 24 hours", "responses": { "200": { "description": "Returns the most voted for token mints", "schema": { "type": "array", "items": { "$ref": "#/definitions/services.TrendingToken" } } } } } } ``` -------------------------------- ### RugCheck API Domain Management - Get Domain Records Source: https://api.rugcheck.xyz/swagger/index Retrieves the associated records for a given domain ID. This endpoint, `/domains/records/{id}`, is crucial for understanding a domain's configuration and associated data. ```http GET /domains/records/{id} ``` -------------------------------- ### RugCheck API General - Get RPC Statistics Source: https://api.rugcheck.xyz/swagger/index Retrieves statistics related to the Remote Procedure Call (RPC) service. This endpoint, `/rpc/stats`, is valuable for monitoring the performance and usage of the RPC layer. ```http GET /rpc/stats ``` -------------------------------- ### Get Token Insider Graph Source: https://api.rugcheck.xyz/swagger/doc This endpoint generates an insider graph for a given token mint address. It requires the token mint address as a path parameter and returns an insider graph representation. Invalid parameters will result in a 400 error. ```json { "get": { "description": "Generate an insider graph for given token mint", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "Tokens" ], "summary": "Get token insider graph", "parameters": [ { "type": "string", "description": "Token mint address", "name": "id", "in": "path", "required": true } ], "responses": { "400": { "description": "Invalid parameters", "schema": { "$ref": "#/definitions/dto.ErrorResponse" } } } } } ``` -------------------------------- ### Get Token Votes Source: https://api.rugcheck.xyz/swagger/doc Retrieves the voting statistics for a given token mint address. Returns the token's vote statistics or an error for invalid parameters. ```json { "get": { "description": "Returns the voting statistics for a token mint", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "Votes" ], "summary": "Get token votes", "parameters": [ { "type": "string", "description": "Token mint address", "name": "id", "in": "path", "required": true } ], "responses": { "200": { "description": "Token vote statistics", "schema": { "$ref": "#/definitions/dto.VoteResponse" } }, "400": { "description": "Invalid parameters", "schema": { "$ref": "#/definitions/dto.ErrorResponse" } } } } } ``` -------------------------------- ### Get Token LP Vaults Source: https://api.rugcheck.xyz/swagger/doc This endpoint retrieves the LP vaults for a given token mint address. It requires the token mint address as a path parameter and returns a dto.VaultResponse on success. Authentication is required via an API key. ```json { "get": { "security": [ { "ApiKeyAuth": [] } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "Vaults" ], "summary": "Returns the tokens LP vaults", "parameters": [ { "type": "string", "description": "Token mint address", "name": "id", "in": "path", "required": true } ], "responses": { "200": { "description": "Returns the tokens LP lockers", "schema": { "$ref": "#/definitions/dto.VaultResponse" } } } } } ``` -------------------------------- ### Get Token Verification Transaction Request Source: https://api.rugcheck.xyz/swagger/doc This endpoint retrieves transaction data for token verification. It expects a request body conforming to the dto.TokenVerificationTransactionRequest schema and returns a dto.TokenVerificationTransactionResponse on success. Errors are returned as dto.ErrorResponse. ```json { "post": { "summary": "Verify token transaction", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "Tokens" ], "parameters": [ { "in": "body", "name": "body", "required": true, "schema": { "$ref": "#/definitions/dto.TokenVerificationTransactionRequest" } } ], "responses": { "200": { "description": "Transaction data", "schema": { "$ref": "#/definitions/dto.TokenVerificationTransactionResponse" } }, "400": { "description": "Invalid parameters", "schema": { "$ref": "#/definitions/dto.ErrorResponse" } }, "401": { "description": "Unauthorized", "schema": { "$ref": "#/definitions/dto.ErrorResponse" } } } } } ``` -------------------------------- ### RugCheck API Stats - Get Most Viewed Tokens (Past 24 Hours) Source: https://api.rugcheck.xyz/swagger/index Retrieves a list of tokens that have received the most views in the last 24 hours. The `/stats/recent` endpoint helps identify currently popular tokens. ```http GET /stats/recent ``` -------------------------------- ### Rugcheck API DTOs - Launchpad Config Source: https://api.rugcheck.xyz/swagger/doc Defines the data structure for launchpad configurations, including logo, name, platform, and URL. ```json { "type": "object", "properties": { "logo": { "type": "string" }, "name": { "type": "string" }, "platform": { "type": "string" }, "url": { "type": "string" } } } ``` -------------------------------- ### RugCheck API Tokens - Verify Token Source: https://api.rugcheck.xyz/swagger/index Initiates the verification process for a token. This POST request to `/tokens/verify` is a core function for validating token legitimacy. ```http POST /tokens/verify ``` -------------------------------- ### Rugcheck API DTOs - Creator Token Source: https://api.rugcheck.xyz/swagger/doc Defines the data structure for creator tokens, including creation timestamp, market cap, and mint. ```json { "type": "object", "properties": { "createdAt": { "type": "string" }, "marketCap": { "type": "number" }, "mint": { "type": "string" } } } ``` -------------------------------- ### RugCheck API General - Ping Service Source: https://api.rugcheck.xyz/swagger/index A simple endpoint to check if the API is responsive. The `/ping` endpoint returns a 'Pong' response, indicating the service is operational. ```http GET /ping ``` -------------------------------- ### RugCheck API Base URL and Version Source: https://api.rugcheck.xyz/swagger/index Specifies the base URL and version for interacting with the RugCheck API. This is essential for making requests to any of the API endpoints. ```text 1.0 [ Base URL: api.rugcheck.xyz/v1 ] ``` -------------------------------- ### Rugcheck API Token Schema Source: https://api.rugcheck.xyz/swagger/doc Outlines the basic schema for token information in the Rugcheck API, including creation timestamp, creator address, and token decimals. ```json { "rugcheck_api.Token": { "type": "object", "properties": { "createAt": { "type": "string" }, "creator": { "type": "string" }, "decimals": { "type": "integer" } } } } ``` -------------------------------- ### RugCheck API Tokens - Bulk Token Report Summary Source: https://api.rugcheck.xyz/swagger/index Enables the submission of bulk token report summaries. The POST request to `/bulk/tokens/summary` is for generating aggregated reports for multiple tokens. ```http POST /bulk/tokens/summary ``` -------------------------------- ### RugCheck API Tokens - Bulk Token Reports Source: https://api.rugcheck.xyz/swagger/index Allows for the submission of bulk token reports. This POST request to `/bulk/tokens/report` is designed for efficiently reporting multiple tokens at once. ```http POST /bulk/tokens/report ``` -------------------------------- ### Login with Solana Source: https://api.rugcheck.xyz/swagger/doc Authenticates users by requiring them to sign a message with their Solana private key. Upon successful verification, it returns a JWT token for API access. It expects an authentication request containing the wallet address, message, and signature. ```json { "schemes": [], "swagger": "2.0", "info": { "description": "JWT token for authentication", "title": "RugCheck API", "contact": {}, "license": {}, "version": "1.0" }, "host": "api.rugcheck.xyz", "basePath": "/v1", "paths": { "/auth/login/solana": { "post": { "description": "Login to RugCheck by signing a message with a Solana private key\nMessage to sign: \"Sign-in to Rugcheck.xyz\"", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "Auth" ], "summary": "Login with Solana", "parameters": [ { "description": "Auth request containing wallet, message and signature", "name": "request", "in": "body", "required": true, "schema": { "$ref": "#/definitions/dto.AuthRequest" } } ], "responses": { "200": { "description": "JWT token for API access", "schema": { "$ref": "#/definitions/dto.AuthResponse" } }, "400": { "description": "Invalid parameters", "schema": { "$ref": "#/definitions/dto.ErrorResponse" } } } } } } } ``` -------------------------------- ### Rugcheck API Program ID Schema Source: https://api.rugcheck.xyz/swagger/doc Defines the structure for program identification within the Rugcheck API, including programID, tokenAccount, type, unlockDate, uri, and usdcLocked. ```json { "programID": { "type": "string" }, "tokenAccount": { "type": "string" }, "type": { "type": "string" }, "unlockDate": { "type": "integer" }, "uri": { "type": "string" }, "usdcLocked": { "type": "number" } } ``` -------------------------------- ### Rugcheck API Market Schema Source: https://api.rugcheck.xyz/swagger/doc Details the schema for market data in the Rugcheck API, encompassing liquidity, market type, minting information, and public key. ```json { "rugcheck_api.Market": { "type": "object", "properties": { "liquidityA": { "type": "string" }, "liquidityAAccount": { "type": "string" }, "liquidityB": { "type": "string" }, "liquidityBAccount": { "type": "string" }, "lp": { "type": "object", "$ref": "#/definitions/rugcheck_api.MarketLP" }, "marketType": { "type": "string" }, "mintA": { "type": "string" }, "mintAAccount": { "type": "string" }, "mintB": { "type": "string" }, "mintBAccount": { "type": "string" }, "mintLP": { "type": "string" }, "mintLPAccount": { "type": "string" }, "pubkey": { "type": "string" } } } } ``` -------------------------------- ### Rugcheck API Market Liquidity Pool (LP) Schema Source: https://api.rugcheck.xyz/swagger/doc Defines the structure for liquidity pool data within the Rugcheck API, including base and quote token details, supply, locked amounts, and holder information. ```json { "rugcheck_api.MarketLP": { "type": "object", "properties": { "base": { "type": "number" }, "baseMint": { "type": "string" }, "basePrice": { "type": "number" }, "baseUSD": { "type": "number" }, "currentSupply": { "type": "integer" }, "holders": { "type": "array", "items": { "$ref": "#/definitions/rugcheck_api.TokenHolder" } }, "lpCurrentSupply": { "type": "integer" }, "lpLocked": { "type": "integer" }, "lpLockedPct": { "type": "number" }, "lpLockedUSD": { "type": "number" }, "lpMaxSupply": { "type": "integer" }, "lpMint": { "type": "string" }, "lpTotalSupply": { "type": "integer" }, "lpUnlocked": { "type": "integer" }, "pctReserve": { "type": "number" }, "pctSupply": { "type": "number" }, "quote": { "type": "number" }, "quoteMint": { "type": "string" }, "quotePrice": { "type": "number" }, "quoteUSD": { "type": "number" }, "reserveSupply": { "type": "integer" }, "tokenSupply": { "type": "integer" }, "totalTokensUnlocked": { "type": "integer" } } } } ``` -------------------------------- ### Rugcheck API Token Data Structures Source: https://api.rugcheck.xyz/swagger/doc Defines the structure for various token-related data, including liquidity, transfer fees, verification status, events, holders, metadata, and simple verified token information. ```json { "totalMarketLiquidity": { "type": "number" }, "totalStableLiquidity": { "type": "number" }, "transferFee": { "type": "object", "properties": { "authority": { "type": "string" }, "maxAmount": { "type": "number" }, "pct": { "type": "number" } } }, "verification": { "type": "object", "$ref": "#/definitions/rugcheck_api.VerifiedToken" } } ``` ```json { "rugcheck_api.TokenEvent": { "type": "object", "properties": { "createdAt": { "type": "string" }, "event": { "type": "integer" }, "newValue": { "type": "string" }, "oldValue": { "type": "string" } } } } ``` ```json { "rugcheck_api.TokenHolder": { "type": "object", "properties": { "address": { "type": "string" }, "amount": { "type": "integer" }, "decimals": { "type": "integer" }, "insider": { "type": "boolean" }, "owner": { "type": "string" }, "pct": { "type": "number" }, "uiAmount": { "type": "number" }, "uiAmountString": { "type": "string" } } } } ``` ```json { "rugcheck_api.TokenMetadata": { "type": "object", "properties": { "mutable": { "type": "boolean" }, "name": { "type": "string" }, "symbol": { "type": "string" }, "updateAuthority": { "type": "string" }, "uri": { "type": "string" } } } } ``` ```json { "rugcheck_api.VerifiedToken": { "type": "object", "properties": { "description": { "type": "string" }, "jup_strict": { "type": "boolean" }, "jup_verified": { "type": "boolean" }, "links": { "type": "array", "items": { "$ref": "#/definitions/rugcheck_api.VerifiedTokenLinks" } }, "mint": { "type": "string" }, "name": { "type": "string" }, "payer": { "type": "string" }, "symbol": { "type": "string" } } } } ``` ```json { "rugcheck_api.VerifiedTokenLinks": { "type": "object", "properties": { "provider": { "type": "string" }, "value": { "type": "string" } } } } ``` ```json { "rugcheck_api.VerifiedTokenSimple": { "type": "object", "properties": { "createdAt": { "type": "string" }, "domain": { "type": "string" }, "mint": { "type": "string" }, "name": { "type": "string" }, "symbol": { "type": "string" } } } } ``` -------------------------------- ### Rugcheck API TokenCheckSummary Definition Source: https://api.rugcheck.xyz/swagger/doc Defines the structure for a token check summary, including risk assessment, score, and token details. ```json { "type": "object", "properties": { "error": { "type": "error" }, "lpLockedPct": { "type": "number" }, "mint": { "description": "Only used on bulk responses", "type": "string" }, "risks": { "type": "array", "items": { "$ref": "#/definitions/rugcheck_api.Risk" } }, "score": { "type": "integer" }, "score_normalised": { "type": "integer" }, "tokenProgram": { "type": "string" }, "tokenType": { "type": "string" } } } ``` -------------------------------- ### Generate Bulk Token Reports Source: https://api.rugcheck.xyz/swagger/doc Provides endpoints to generate both detailed and summary reports for token mints. These endpoints accept JSON payloads and return JSON responses, with error handling for invalid parameters and rate limiting. ```json { "schemes": [], "swagger": "2.0", "info": { "description": "JWT token for authentication", "title": "RugCheck API", "contact": {}, "license": {}, "version": "1.0" }, "host": "api.rugcheck.xyz", "basePath": "/v1", "paths": { "/bulk/tokens/report": { "post": { "description": "Generate a detailed report for token mints", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "Tokens" ], "summary": "Bulk token reports", "responses": { "200": { "description": "Bulk token reports", "schema": { "$ref": "#/definitions/dto.BulkResponse" } }, "400": { "description": "Invalid parameters", "schema": { "$ref": "#/definitions/dto.ErrorResponse" } }, "429": { "description": "Rate limit exceeded", "schema": { "$ref": "#/definitions/dto.ErrorResponse" } } } } }, "/bulk/tokens/summary": { "post": { "description": "Generate a summary report for all token mints", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "Tokens" ], "summary": "Bulk token report summary", "responses": { "200": { "description": "Token report summaries", "schema": { "$ref": "#/definitions/dto.BulkSummaryResponse" } }, "400": { "description": "Invalid parameters", "schema": { "$ref": "#/definitions/dto.ErrorResponse" } }, "429": { "description": "Rate limit exceeded", "schema": { "$ref": "#/definitions/dto.ErrorResponse" } } } } } } } ``` -------------------------------- ### Rugcheck API TokenVerificationTransactionRequest Definition Source: https://api.rugcheck.xyz/swagger/doc Defines the structure for a token verification transaction request, requiring mint and payer, and optionally including verification data. ```json { "type": "object", "required": [ "mint", "payer" ], "properties": { "data": { "type": "object", "$ref": "#/definitions/dto.TokenVerificationData" }, "mint": { "type": "string" }, "payer": { "type": "string" } } } ``` -------------------------------- ### RugCheck API Authentication - Solana Login Source: https://api.rugcheck.xyz/swagger/index Provides the endpoint for authenticating users via Solana. This typically involves a POST request to the `/auth/login/solana` endpoint, likely requiring specific payload data for the Solana login process. ```http POST /auth/login/solana ``` -------------------------------- ### Rugcheck API DTOs - File Metadata Source: https://api.rugcheck.xyz/swagger/doc Defines the data structure for file metadata, including name, description, image, and symbol. ```json { "type": "object", "properties": { "description": { "type": "string" }, "image": { "type": "string" }, "name": { "type": "string" }, "symbol": { "type": "string" } } } ``` -------------------------------- ### Rugcheck API TokenVerificationData Definition Source: https://api.rugcheck.xyz/swagger/doc Defines the data required for token verification, including acceptance of terms and data integrity, along with links and domain information. ```json { "type": "object", "required": [ "dataIntegrityAccepted", "description", "solDomain", "termsAccepted" ], "properties": { "dataIntegrityAccepted": { "type": "boolean" }, "description": { "type": "string" }, "links": { "type": "object", "additionalProperties": { "type": "string" } }, "solDomain": { "description": "*.token", "type": "string" }, "termsAccepted": { "type": "boolean" } } } ``` -------------------------------- ### Rugcheck API TokenEligibilityRequest Definition Source: https://api.rugcheck.xyz/swagger/doc Defines the structure for a token eligibility request, requiring a 'mint' address. ```json { "type": "object", "properties": { "mint": { "type": "string" } } } ``` -------------------------------- ### Rugcheck API DTOs - Vault Response Summary Source: https://api.rugcheck.xyz/swagger/doc Defines the summary data structure for vault responses, including percentage and total USDC. ```json { "type": "object", "properties": { "pct": { "type": "number" }, "totalUSDC": { "type": "number" } } } ``` -------------------------------- ### Rugcheck API TokenVerificationRequest Definition Source: https://api.rugcheck.xyz/swagger/doc Defines the structure for a token verification request, including mint, payer, signature, and verification data. ```json { "type": "object", "required": [ "mint", "payer", "signature" ], "properties": { "data": { "type": "object", "$ref": "#/definitions/dto.TokenVerificationData" }, "mint": { "type": "string" }, "payer": { "type": "string" }, "signature": { "type": "string" } } } ``` -------------------------------- ### Submit Token for Verification Source: https://api.rugcheck.xyz/swagger/doc Submits a token to the RugCheck API for verification. This requires an API key for authentication and accepts a TokenVerificationRequest object in the request body. It returns a SuccessResponse on successful submission or an ErrorResponse for invalid parameters or unauthorized access. ```json { "post": { "security": [ { "ApiKeyAuth": [] } ], "description": "Submit token for verification", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "Tokens" ], "summary": "Verify token", "parameters": [ { "description": "Verification request", "name": "request", "in": "body", "required": true, "schema": { "$ref": "#/definitions/dto.TokenVerificationRequest" } } ], "responses": { "200": { "description": "Verification submitted successfully", "schema": { "$ref": "#/definitions/dto.SuccessResponse" } }, "400": { "description": "Invalid parameters", "schema": { "$ref": "#/definitions/dto.ErrorResponse" } }, "401": { "description": "Unauthorized", "schema": { "$ref": "#/definitions/dto.ErrorResponse" } } } } } ``` -------------------------------- ### RugCheck API Domain Management - Lookup Domain by ID Source: https://api.rugcheck.xyz/swagger/index Fetches details for a specific domain using its unique identifier. The `/domains/lookup/{id}` endpoint enables targeted retrieval of domain information. ```http GET /domains/lookup/{id} ``` -------------------------------- ### Define BulkSummaryResponse Source: https://api.rugcheck.xyz/swagger/doc Defines the structure for a bulk summary response, containing an array of token check summary reports. ```json { "type": "object", "properties": { "reports": { "type": "array", "items": { "$ref": "#/definitions/dto.TokenCheckSummary" } } } } ```