Compare commits

...

11 Commits

Author SHA1 Message Date
David Lau 3551bc3a25 docs(gmgn-token): add launchpad, migration, ath_price, locked_ratio and dev.ath_token_info fields
- Document 9 new top-level fields in token info response:
  launchpad, launchpad_status, launchpad_progress, launchpad_platform,
  migrated_pool, migration_market_cap, migration_market_cap_quote,
  ath_price, locked_ratio
- Document dev.ath_token_info sub-fields (creator all-time-high token)

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
2026-04-09 17:47:20 +08:00
GMGN.AI 8448787176 Merge pull request #90 from gina888666/fix/portfolio-stats-created-at-doc
docs(gmgn-portfolio): add created_at field to portfolio stats common object
2026-04-09 15:35:18 +08:00
gina888666 04389b98f0 docs(gmgn-portfolio): add created_at field to portfolio stats common object 2026-04-09 14:50:29 +08:00
deepfeature 2949ea7de3 1.2.3 2026-04-09 12:50:11 +08:00
GMGN.AI 4dde77c481 Merge pull request #88 from gina888666/fix/private-vault-hold-rate-doc
docs(gmgn-token): add private_vault_hold_rate field to stat object reference
2026-04-08 21:04:22 +08:00
GMGN.AI 02d497df92 Merge pull request #89 from GMGNAI/feat/expose-order-report
feat(swap): expose execution report fields in order get response
2026-04-08 21:00:37 +08:00
David Lau 48a06cd9b4 feat(swap): expose execution report fields in order get response
Replace top-level filled_input_amount/filled_output_amount with the
report object returned when state=30 and status=successful. Document
all report fields (amounts, tokens, decimals, price, gas) and update
order polling, post-swap receipt template, and cooking status polling
to reference report.input_amount / report.output_amount.

Closes GMGNAI/gmgn-skills#34

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
2026-04-08 20:40:53 +08:00
gina888666 9e90bb9c07 docs(gmgn-token): add private_vault_hold_rate field to stat object reference 2026-04-08 20:21:36 +08:00
GMGN.AI 31fababfd8 Merge pull request #87 from GMGNAI/feat-wallet-stat-common
docs(portfolio): document common identity field in wallet stats response
2026-04-08 19:24:04 +08:00
GMGN.AI 6833ff19cd Merge pull request #82 from GMGNAI/feat-token-info-expose-dev
docs(token): document dev object in token info response
2026-04-08 19:22:54 +08:00
David Lau 2073b5fdaf docs(token): document dev object in token info response
- Add dev nested object table to Response Field Reference with all 21 fields
  (creator wallet, DEXScreener activity, CTO flag, funding source, etc.)
- Update nested objects description to include dev as the 5th object

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
2026-04-08 16:09:17 +08:00
6 changed files with 86 additions and 22 deletions
+2 -2
View File
@@ -1,12 +1,12 @@
{
"name": "gmgn-cli",
"version": "1.2.2",
"version": "1.2.3",
"lockfileVersion": 3,
"requires": true,
"packages": {
"": {
"name": "gmgn-cli",
"version": "1.2.2",
"version": "1.2.3",
"license": "MIT",
"dependencies": {
"commander": "^12.1.0",
+1 -1
View File
@@ -1,6 +1,6 @@
{
"name": "gmgn-cli",
"version": "1.2.2",
"version": "1.2.3",
"description": "GMGN OpenAPI CLI — call GMGN market, token, portfolio and swap APIs from the command line",
"type": "module",
"bin": {
+1 -1
View File
@@ -167,7 +167,7 @@ Token creation is **asynchronous**. If the initial `cooking create` response sho
```bash
gmgn-cli order get --chain <chain> --order-id <order_id>
```
2. The new token's contract / mint address is in the **`output_token`** field of the `order get` response — it is NOT returned by `cooking create` directly.
2. The new token's contract / mint address is in the **`report.output_token`** field of the `order get` response (only present when `state = 30` and `status = "successful"`) — it is NOT returned by `cooking create` directly.
3. Stop polling once `status` is `confirmed`, `failed`, or `expired`.
4. On `confirmed`: display `output_token` as the token address and include the block explorer link.
5. On `failed` / `expired`: report the `error_status` and do not retry automatically.
+1
View File
@@ -228,6 +228,7 @@ The response also includes a `common` object when available (absent if the upstr
| `common.follow_count` | Number of GMGN users following this wallet |
| `common.remark_count` | Number of GMGN users who have remarked this wallet |
| `common.created_token_count` | Tokens created by this wallet |
| `common.created_at` | Wallet creation time (Unix seconds) — records when the first funding transaction arrived; use this as the wallet's age indicator |
| `common.fund_from` | Funding source label |
| `common.fund_from_address` | Address that funded this wallet |
| `common.fund_amount` | Funding amount |
+38 -17
View File
@@ -30,7 +30,7 @@ Use the `gmgn-cli` tool to submit a token swap or query an existing order. `GMGN
- **`order_id` / `status`** — After submitting a swap, the response includes an `order_id`. Use `order get --order-id` to poll for final status. Possible values: `pending``processed``confirmed` (success) or `failed` / `expired`. Do not report success until status is `confirmed`.
- **`filled_input_amount` / `filled_output_amount`** — Actual amounts consumed/received, in smallest unit. Convert to human-readable using token decimals before displaying to the user.
- **`report.input_amount` / `report.output_amount`** — Actual amounts consumed/received, in smallest unit. Only present when `state = 30` and `status = "successful"`. Convert to human-readable using `report.input_token_decimals` / `report.output_token_decimals` before displaying to the user.
## Financial Risk Notice
@@ -273,20 +273,41 @@ gmgn-cli swap \
> `buy_amount`: each take-profit sells 50% of the **original** bought amount. Stop-loss sells 100% of the original bought amount.
## `swap` Response Fields
## `swap` / `order get` Response Fields
| Field | Type | Description |
|-------|------|-------------|
| `order_id` | string | Order ID for follow-up queries |
| `hash` | string | Transaction hash |
| `status` | string | Order status: `pending` / `processed` / `confirmed` / `failed` / `expired` |
| `error_code` | string | Error code on failure |
| `error_status` | string | Error description on failure |
| `input_token` | string | Input token contract address |
| `output_token` | string | Output token contract address |
| `filled_input_amount` | string | Actual input consumed (smallest unit); empty if not filled |
| `filled_output_amount` | string | Actual output received (smallest unit); empty if not filled |
| Field | Type | Description |
| ------------------- | ------ | ---- |
| `order_id` | string | Order ID for follow-up queries |
| `hash` | string | Transaction hash |
| `status` | string | Order status: `pending` / `processed` / `confirmed` / `failed` / `expired` |
| `error_code` | string | Error code on failure |
| `error_status` | string | Error description on failure |
| `strategy_order_id` | string | Strategy order ID; only present when `--condition-orders` was passed and strategy creation succeeded (best-effort) |
| `report` | object | Execution report; only present when `state = 30` and `status = "successful"`. See Report Fields below. |
### Report Fields (present only when `status = "successful"`)
| Field | Type | Description |
| ----------------------- | ------- | ---- |
| `input_token` | string | Input token contract address |
| `input_token_decimals` | integer | Input token decimal places |
| `swap_mode` | string | Swap mode: `ExactIn` / `ExactOut` |
| `input_amount` | string | Actual input consumed (smallest unit) |
| `output_token` | string | Output token contract address |
| `output_token_decimals` | integer | Output token decimal places |
| `output_amount` | string | Actual output received (smallest unit) |
| `quote_token` | string | Quote token contract address |
| `quote_decimals` | integer | Quote token decimal places |
| `quote_amount` | string | Quote amount (smallest unit) |
| `base_token` | string | Base token contract address |
| `base_decimals` | integer | Base token decimal places |
| `base_amount` | string | Base token amount (smallest unit) |
| `price` | string | Execution price (quote/base token) |
| `price_usd` | string | Execution price in USD |
| `height` | integer | Block height of execution |
| `order_height` | integer | Block height when order was placed |
| `gas_native` | string | Gas fee in native token |
| `gas_usd` | string | Gas fee in USD |
## Output Format
@@ -334,13 +355,13 @@ After a confirmed swap, display:
```
✅ Swap Confirmed
Spent: {filled_input_amount in human units} {input symbol}
Received: {filled_output_amount in human units} {output symbol}
Spent: {report.input_amount in human units} {input symbol}
Received: {report.output_amount in human units} {output symbol}
Tx: {explorer link for hash}
Order ID: {order_id}
```
Convert `filled_input_amount` and `filled_output_amount` from smallest unit using token decimals before displaying.
Convert `report.input_amount` and `report.output_amount` from smallest unit using `report.input_token_decimals` and `report.output_token_decimals` before displaying.
## `order strategy create` Parameters
@@ -502,7 +523,7 @@ For full token research before swapping, see [`docs/workflow-token-research.md`]
- **Percentage sell restriction** — `--percent` is ONLY valid when `input_token` is NOT a currency. Do NOT use `--percent` when `input_token` is SOL/BNB/ETH (native) or USDC. This includes: "sell 50% of my SOL", "use 30% of my BNB to buy X", "spend 50% of my USDC on X" — all unsupported. Explain the restriction to the user and ask for an explicit absolute amount instead.
- **Chain-wallet compatibility** — SOL addresses are incompatible with EVM chains (bsc/base). Warn the user and abort if the address format does not match the chain.
- **Credential sensitivity** — `GMGN_API_KEY` and `GMGN_PRIVATE_KEY` can directly execute trades on the linked wallet. Never log, display, or expose these values.
- **Order polling** — After a swap, if `status` is not yet `confirmed` / `failed` / `expired`, poll with `order get` up to 3 times at 5-second intervals before reporting a timeout. Once confirmed, display the trade result using `filled_input_amount` and `filled_output_amount` (convert from smallest unit using token decimals), e.g. "Spent 0.1 SOL → received 98.5 USDC" or "Sold 1000 TOKEN → received 0.08 SOL".
- **Order polling** — After a swap, if `status` is not yet `confirmed` / `failed` / `expired`, poll with `order get` up to 3 times at 5-second intervals before reporting a timeout. Once confirmed, display the trade result using `report.input_amount` and `report.output_amount` (convert from smallest unit using `report.input_token_decimals` / `report.output_token_decimals`), e.g. "Spent 0.1 SOL → received 98.5 USDC" or "Sold 1000 TOKEN → received 0.08 SOL".
- **Block explorer links** — After a successful swap, display a clickable explorer link for the returned `hash`:
| Chain | Explorer |
+43 -1
View File
@@ -142,7 +142,7 @@ Recommended combinations for common use cases:
### `token info` — Key Fields
The response has four nested objects: `pool`, `link`, `stat`, `wallet_tags_stat`. Access fields with dot notation when parsing (e.g. `link.website`, `stat.top_10_holder_rate`).
The response has five nested objects: `pool`, `dev`, `link`, `stat`, `wallet_tags_stat`. Access fields with dot notation when parsing (e.g. `link.website`, `stat.top_10_holder_rate`, `dev.creator_address`).
**Top-level Fields**
@@ -162,6 +162,15 @@ The response has four nested objects: `pool`, `link`, `stat`, `wallet_tags_stat`
| `open_timestamp` | Time the token opened for trading (Unix seconds) |
| `biggest_pool_address` | Address of the main liquidity pool |
| `og` | Whether the token is flagged as an OG token (`true` / `false`) |
| `launchpad` | Launchpad identifier (e.g. `pump`, `moonshot`) |
| `launchpad_status` | Launchpad state: `0` = not opened, `1` = live, `2` = migrated |
| `launchpad_progress` | Launchpad bonding-curve progress (01) |
| `launchpad_platform` | Launchpad platform name |
| `migrated_pool` | Pool address after migration |
| `migration_market_cap` | Market cap at migration time (USD, float) |
| `migration_market_cap_quote` | Quote currency for `migration_market_cap` |
| `ath_price` | All-time-high price (USD, float) |
| `locked_ratio` | Ratio of supply locked (01, float) |
**`pool` Object** — Main liquidity pool details
@@ -179,6 +188,38 @@ The response has four nested objects: `pool`, `link`, `stat`, `wallet_tags_stat`
| `pool.fee_ratio` | Pool trading fee ratio (e.g. `0.1` = 0.1%) |
| `pool.creation_timestamp` | Pool creation time (Unix seconds) |
**`dev` Object** — Token creator / developer info
| Field | Description |
|-------|-------------|
| `dev.creator_address` | Creator wallet address |
| `dev.creator_token_balance` | Creator's current token balance |
| `dev.creator_token_status` | Creator holding status: `hold` (still holding) / `sell` (sold/exited) |
| `dev.top_10_holder_rate` | Ratio of supply held by top 10 wallets (01) |
| `dev.twitter_name_change_history` | Array of past Twitter username changes (each entry has `twitter_username`, `rename_timestamp`) |
| `dev.dexscr_ad` | Creator bought a DEXScreener ad: `1` = yes, `0` = no |
| `dev.dexscr_update_link` | Creator updated DEXScreener socials/links: `1` = yes, `0` = no |
| `dev.dexscr_boost_fee` | Creator used DEXScreener Boost: `1` = yes, `0` = no |
| `dev.dexscr_trending_bar` | Token appeared in DEXScreener trending bar: `1` = yes, `0` = no |
| `dev.dexscr_ad_ts` | Timestamp of DEXScreener ad purchase (Unix seconds) |
| `dev.dexscr_update_link_ts` | Timestamp of DEXScreener link update (Unix seconds) |
| `dev.dexscr_boost_ts` | Timestamp of DEXScreener Boost (Unix seconds) |
| `dev.dexscr_trending_bar_ts` | Timestamp of DEXScreener trending bar appearance (Unix seconds) |
| `dev.cto_flag` | Token has been Community Takeover'd (original dev abandoned): `1` = yes, `0` = no |
| `dev.fund_from` | Address that funded the creator wallet |
| `dev.fund_from_ts` | Timestamp of that funding event (Unix seconds) |
| `dev.creator_open_count` | Number of tokens this creator has previously launched |
| `dev.twitter_del_post_token_count` | Number of posts the creator deleted from Twitter |
| `dev.twitter_create_token_count` | Number of tokens the creator has promoted on Twitter |
| `dev.offchain` | Whether the token is an offchain token |
| `dev.ath_token_info` | Creator's all-time-high token info object (optional); see sub-fields below |
| `dev.ath_token_info.ath_token` | Contract address of the creator's best-performing token ever |
| `dev.ath_token_info.ath_mc` | All-time-high market cap of that token (USD, string) |
| `dev.ath_token_info.avatar` | Token logo URL |
| `dev.ath_token_info.symbol` | Token symbol |
| `dev.ath_token_info.name` | Token name |
| `dev.ath_token_info.creation_timestamp` | Token creation time (Unix seconds) |
**`link` Object** — Social and explorer links
| Field | Description |
@@ -212,6 +253,7 @@ The response has four nested objects: `pool`, `link`, `stat`, `wallet_tags_stat`
| `stat.bot_degen_count` | Number of bot degen wallets |
| `stat.bot_degen_rate` | Ratio of bot degen wallets |
| `stat.fresh_wallet_rate` | Ratio of fresh/new wallets among holders |
| `stat.private_vault_hold_rate` | Ratio held by private vault (vanish) addresses — displayed as "vanish" in GMGN UI (01) |
**`wallet_tags_stat` Object** — Wallet type breakdown