File size: 11,066 Bytes
6993919 | 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 | # rugmunch.TokenApi
All URIs are relative to *http://localhost*
Method | HTTP request | Description
------------- | ------------- | -------------
[**get_detail_api_v1_token_address_get**](TokenApi.md#get_detail_api_v1_token_address_get) | **GET** /api/v1/token/{address} | Get Detail
[**get_holders_api_v1_token_address_holders_get**](TokenApi.md#get_holders_api_v1_token_address_holders_get) | **GET** /api/v1/token/{address}/holders | Get Holders
[**get_liquidity_api_v1_token_address_liquidity_get**](TokenApi.md#get_liquidity_api_v1_token_address_liquidity_get) | **GET** /api/v1/token/{address}/liquidity | Get Liquidity
[**get_risk_api_v1_token_address_risk_get**](TokenApi.md#get_risk_api_v1_token_address_risk_get) | **GET** /api/v1/token/{address}/risk | Get Risk
[**scan_api_v1_token_scan_post**](TokenApi.md#scan_api_v1_token_scan_post) | **POST** /api/v1/token/scan | Scan
# **get_detail_api_v1_token_address_get**
> TokenDetail get_detail_api_v1_token_address_get(address, chain=chain)
Get Detail
Token metadata + supply + verification.
### Example
```python
import rugmunch
from rugmunch.models.token_detail import TokenDetail
from rugmunch.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = rugmunch.Configuration(
host = "http://localhost"
)
# Enter a context with an instance of the API client
with rugmunch.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = rugmunch.TokenApi(api_client)
address = 'address_example' # str |
chain = 'solana' # str | (optional) (default to 'solana')
try:
# Get Detail
api_response = api_instance.get_detail_api_v1_token_address_get(address, chain=chain)
print("The response of TokenApi->get_detail_api_v1_token_address_get:\n")
pprint(api_response)
except Exception as e:
print("Exception when calling TokenApi->get_detail_api_v1_token_address_get: %s\n" % e)
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**address** | **str**| |
**chain** | **str**| | [optional] [default to 'solana']
### Return type
[**TokenDetail**](TokenDetail.md)
### Authorization
No authorization required
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
**200** | Successful Response | - |
**422** | Validation Error | - |
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
# **get_holders_api_v1_token_address_holders_get**
> PaginatedResponse get_holders_api_v1_token_address_holders_get(address, chain=chain, limit=limit)
Get Holders
Top token holders.
### Example
```python
import rugmunch
from rugmunch.models.paginated_response import PaginatedResponse
from rugmunch.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = rugmunch.Configuration(
host = "http://localhost"
)
# Enter a context with an instance of the API client
with rugmunch.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = rugmunch.TokenApi(api_client)
address = 'address_example' # str |
chain = 'solana' # str | (optional) (default to 'solana')
limit = 100 # int | (optional) (default to 100)
try:
# Get Holders
api_response = api_instance.get_holders_api_v1_token_address_holders_get(address, chain=chain, limit=limit)
print("The response of TokenApi->get_holders_api_v1_token_address_holders_get:\n")
pprint(api_response)
except Exception as e:
print("Exception when calling TokenApi->get_holders_api_v1_token_address_holders_get: %s\n" % e)
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**address** | **str**| |
**chain** | **str**| | [optional] [default to 'solana']
**limit** | **int**| | [optional] [default to 100]
### Return type
[**PaginatedResponse**](PaginatedResponse.md)
### Authorization
No authorization required
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
**200** | Successful Response | - |
**422** | Validation Error | - |
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
# **get_liquidity_api_v1_token_address_liquidity_get**
> Dict[str, object] get_liquidity_api_v1_token_address_liquidity_get(address, chain=chain)
Get Liquidity
Token liquidity + pool info.
### Example
```python
import rugmunch
from rugmunch.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = rugmunch.Configuration(
host = "http://localhost"
)
# Enter a context with an instance of the API client
with rugmunch.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = rugmunch.TokenApi(api_client)
address = 'address_example' # str |
chain = 'solana' # str | (optional) (default to 'solana')
try:
# Get Liquidity
api_response = api_instance.get_liquidity_api_v1_token_address_liquidity_get(address, chain=chain)
print("The response of TokenApi->get_liquidity_api_v1_token_address_liquidity_get:\n")
pprint(api_response)
except Exception as e:
print("Exception when calling TokenApi->get_liquidity_api_v1_token_address_liquidity_get: %s\n" % e)
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**address** | **str**| |
**chain** | **str**| | [optional] [default to 'solana']
### Return type
**Dict[str, object]**
### Authorization
No authorization required
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
**200** | Successful Response | - |
**422** | Validation Error | - |
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
# **get_risk_api_v1_token_address_risk_get**
> TokenRisk get_risk_api_v1_token_address_risk_get(address, chain=chain)
Get Risk
Combined risk: holders + liquidity + heuristics.
### Example
```python
import rugmunch
from rugmunch.models.token_risk import TokenRisk
from rugmunch.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = rugmunch.Configuration(
host = "http://localhost"
)
# Enter a context with an instance of the API client
with rugmunch.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = rugmunch.TokenApi(api_client)
address = 'address_example' # str |
chain = 'solana' # str | (optional) (default to 'solana')
try:
# Get Risk
api_response = api_instance.get_risk_api_v1_token_address_risk_get(address, chain=chain)
print("The response of TokenApi->get_risk_api_v1_token_address_risk_get:\n")
pprint(api_response)
except Exception as e:
print("Exception when calling TokenApi->get_risk_api_v1_token_address_risk_get: %s\n" % e)
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**address** | **str**| |
**chain** | **str**| | [optional] [default to 'solana']
### Return type
[**TokenRisk**](TokenRisk.md)
### Authorization
No authorization required
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
**200** | Successful Response | - |
**422** | Validation Error | - |
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
# **scan_api_v1_token_scan_post**
> TokenScanResult scan_api_v1_token_scan_post(token_scan_request)
Scan
Full token scan. Multi-module. Freemium rate-limit applied in legacy router.
### Example
```python
import rugmunch
from rugmunch.models.token_scan_request import TokenScanRequest
from rugmunch.models.token_scan_result import TokenScanResult
from rugmunch.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = rugmunch.Configuration(
host = "http://localhost"
)
# Enter a context with an instance of the API client
with rugmunch.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = rugmunch.TokenApi(api_client)
token_scan_request = rugmunch.TokenScanRequest() # TokenScanRequest |
try:
# Scan
api_response = api_instance.scan_api_v1_token_scan_post(token_scan_request)
print("The response of TokenApi->scan_api_v1_token_scan_post:\n")
pprint(api_response)
except Exception as e:
print("Exception when calling TokenApi->scan_api_v1_token_scan_post: %s\n" % e)
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**token_scan_request** | [**TokenScanRequest**](TokenScanRequest.md)| |
### Return type
[**TokenScanResult**](TokenScanResult.md)
### Authorization
No authorization required
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: application/json
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
**200** | Successful Response | - |
**422** | Validation Error | - |
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|