Documentation

Products Documentation

Strap in, grinder. This page is your warp-drive manual to every read-only endpoint, leaderboard flex, and payout ritual inside App.Grindy.fun
Zero corporate blah, just straight-up how-to’s, code crumbs, and meme-fuel to get you live in minutes.

Kick-Off Kit

Quick Peek

A 60 seconde fly-over of how Grindy levels up your crypto game.

Account Setup

Spin up your profile,only API key, and you’re cleared for takeoff

First Grind

Fire your first read-only call & watch raw data rain.

WTF is Grindy.fun?

Account Setup

Grindy.fun is a next-gen trading platform that : Gamifies the markets with challenges & leaderboards

Rewards you in StableCoin (USDT/USDC) and more !
Whether you’re a seasoned trader or just Degen’ing for fun, Grindy.fun makes every trade count.

The One-Sentence Pitch
How the Magic Works
Gamified Layers

1. The One-Sentence Pitch

Grindy.fun turns the raw trading volume you already generate on your exchange into real-time points, ranks and USDC rewards no custody, no order-routing, just data.

2. How the Magic Works

Read-Only Feeds – We ping your exchange (your personal Read Only API key ) & pull volume-only stats for every supported pair.

‍Volume → Points Engine – Every $x in notional volume = 1 G-Points.
You can also earn G-points by completing quests.
The math is transparent and on-chain-verifiable.

‍Zero Friction – Because we never place orders or hold funds, your latency, security posture, and KYC all stay exactly where they are now at your exchange.

3. Gamified Layers

Seasonal Leaderboards & Badges – Bronze → Diamond tiers unlock crazy rewards & Discord flex roles.

‍Social Squads – Group volume counts toward squad XP; friendly trash-talk encouraged.

Zero to Hero Onboarding

How to be ready to be a Grindy ?

We're thrilled to have you here! Whether you're an experienced grinders or just getting started, this guide will help you create your account with our platform.

1. Sign In & Suit Up

One-click login : choose Email, Discord, or Google.
We drop you inside the arcade instantly; no wallet extensions, no seed phrases.
A unique Starknet payout wallet is auto-generated behind the scenes.
It’s read-only for you, write-only for us perfect for USDC rewards.

2. Build Your Grinder Profile

Fill-in your details once and you’re ready to flex :

-Grinder Name – the alias that shows up on every leaderboard, shout-out and meme.
-Email – where reward receipts, security alerts and weekly stats recaps are sent.
-X / Telegram / Discord handles – optional social links; useful for squad quests and direct support pings.
-Country – (optional) required for some spécial prize distribution.
-Starknet Wallet – add it now for be rewarded onchain (USDC/USDT) and to qualify for future on-chain achievements and NFT drops.
-Save this change and your profile locks until you decide to edit again simple and secure.

3. Connect Your Exchange (The Only Required Step)

Click any entry in Exchange Connected.
Paste your API Key / Secret → Validate. Status light flips green.

Want out ? Hit Delete API (red button) and the key is wiped from the vault.
‍
Supported Day 1: MEXC, Gate.io
We store keys encrypted at rest; no withdrawal permission ever requested.

4. Explore Your Dashboard

My Stats : real-time graph of volume, campaigns done, trades, rewards.

‍Exchange Connected : quick status + arrow to manage each CEX.

‍My Rank : Bronze → Diamond bar with Grindy Points & points to next tier.

‍Weekly Quests : e.g. “Trade 7 consecutive days” for bonus tokens.

‍Championship CTA : big pink button invites you to the current season.

Everything here updates every ~60 seconds; you can safely keep the tab open.

5. Enter a Championship & Grind

Click Championship to open the Alpha Season board.
Filter by Exchange or Status.
‍
‍Check Details on any campaign card.Inside the campaign page : Rules table (token, dates, reward method).

‍Reward Model cheat sheet.(depend of the campaign & token issuers)

‍Progress Bar : shows your live volume vs. the max tradable for the epoch, plus the reset countdown.

‍Epoch Ranking : top 10 grinders and their prize for this 6-hour window.(exemple)
‍
Trade the target pair(s) on your CEX ; we read the volume, update your bar, and log your position every X seconds .When the epoch ends, rewards are airdroped to your Starknet payout wallet; season rewards distribute once the epoch closes.(24 to 48h)

‍Pro-Tip : Hit the max volume before the timer resets and your bar turns neon cyan — that’s the sign you’re locked in for the full reward.

You’re live. From first login to first prize in under five minutes just keep grinding volume and watch the USDC drip straight into your Starknet wallet.

Ranking System

This guide will walk you through obtaining best ranking possible.

Welcome to our Ranking System documentation!
This guide will walk you through obtaining the best ranking positions.

1. Why Ranks Exist

Trading volume already pays you in USDC every epoch, but the Ranking System is our loyalty layer on top. It’s how we say thanks to the grinders who keep the reels spinning the fastest.

2. How You Climb

Generate volume. Every dollar you trade on a connected CEX also = Grindy Points.
Complete quests. Daily, weekly, and seasonal challenges add bonus points.
That’s it. No staking, no clicks, no fees just keep trading.
More ways to score (referral multipliers, guild boosts) drop after the Alpha test month.

3. Tier Breakdown (Bronze → Diamond)

Each tier unlocks a bigger slice of the seasonal prize pool, 
private Discord roles,
early access to new campaigns. 

You’ll see your current tier & points 
needed for the next one right on the dashboard progress bar.

4. Seasonal Prize Pool

7-month “Alpha Season.”$50 k – $100 k USDC funded directly by Grindy.fun, in addition to rewards paid by token issuers for the campaigns you’re already grinding.

Physical loot drops : PS5, Switch 2, custom keyboards, meme surprises revealed mid-season.

Top tiers claim a guaranteed cut ; lower tiers still get raffle tickets and merch chances.

5. Coming Up

Referral XP : bring friends, boost your rank faster.
Meanwhile, just keep pushing volume & clearing quests ; every trade pushes you closer to the next badge …and a bigger share of that six-figure pool.

Need more informations LFG on discord !

What data can I actually pull from the API?

Volume per pair, per user, per epoch; leaderboard positions; rank & points; campaign metadata; and your own reward history.
No price feeds or order books just the grind metrics.

How often does the data refresh?

Every 60 seconds for live dashboards. Direct API polling returns the latest snapshot in < 300 ms. Webhooks (coming Q3) will push deltas instantly when a trade hits our listener.

Which exchanges are supported on Day 1?

MEXC, Gate.io.

Do you ever need withdrawal permissions on my API keys?

Never. We only request “read” scopes. Keys are AES-256-encrypted, sealed with an HSM, and rotated every 24 h behind the scenes.

How do I earn USDC if I never leave my exchange?

You trade as usual → we detect your notional volume → token issuer pays the reward pot → we bridge your slice to your Starknet payout wallet at the end of each epoch or campaign.

Is there a cost to use grindy.fun platform?

Zero subscription fees .
“Trade-To-Earn” loop and loyalty ranks will ALWAYS stay free.

Arena RuleBook

Be prepared for the grinde !

Everything you need to know before jumping into a Grindy.fun campaign.

1. Eligibility & Accounts

You must be 18 + and legally allowed to trade crypto in your jurisdiction.
‍
One Grinder ID = one real person. Multiple exchange sub-accounts under the same user are fine; duplicate Grindy accounts are not.

API keys must be read-only (no withdrawal perms). Keys are encrypted in-vault and rotated daily.

2. How Volume Is Counted

Only trades on the designated pair(s) inside an active campaign window earn credit. Both buys + sells count toward volume.
Leaderboards refresh roughly every 60 s; final settlement runs at the end of each epoch (6 h by default but depend of the token issuers choice).
‍Top 25 at epoch close split the issuer-funded reward pot; ties share the slice equally.

At season end, Grindy.fun adds an extra $50 k–$100 k USDC pool plus physical goodies (PS5, Switch 2, meme merch).

3. Permitted vs. Prohibited Trading

Permitted : You may place manual orders or use exchange-native algos and third-party strategy bots, provided all trades flow through the single Grinder ID linked to your read-only API keys and respect each exchange’s own terms of service.

Hedging the campaign token on external venues is acceptable ; we count only the volume executed on the designated CEX, not your P&L.

‍Prohibited (automatic disqualification + reward claw-back) : Wash trading / self-trading that creates volume without changing ownership.

‍Spoofing, quote-stuffing or pump-and-dump coordination meant to distort price or order-book depth.‍Running multiple Grindy accounts, sharing API keys, or scripting synthetic identities (“bot swarms”).
‍
‍Quick rule-of-thumb : if a strategy’s primary goal is to manufacture volume without genuine market risk, it’s almost certainly disallowed. When in doubt, ping a mod in #dev-support or use the front-end chat widget getting a ruling in advance beats losing your rewards afterward.

4. Anti-Bot & Fair-Play Controls

Pattern-matching flags identical buy-sell loops, 
zero-spread cycling, and IP/device overlaps.

Suspicious fills are quarantined 
for manual review before leaderboard updates.

Grindy reserves the right to pause a campaign 
or adjust stats if a CEX outage skews data.

5. Rewards & Payout Schedule

Issuer Pot : paid daily or per-epoch in USDC/USDT to your Starknet payout wallet.(Ready Wallet ExArgent )

‍Seasonal Pool : distributed within 48 h after season close, based on your final rank tier.
‍Loot Drops : random draws for hardware / merch announced on Discord live-streams. All payouts are on-chain; tx hashes post to the official discord.

Future Updates
‍Referral XP boost launches in September; ranking points from invited grinders will stack with your own volume.
Rule tweaks (e.g., new anti-bot heuristics) may be rolled out mid-season; changes are timestamped in the public changelog.

‍Trade fair, trade hard, and may your volume be ever organic.

Call The Matrix (API documentations)

How grindy dot fun use api

How we use API

1. What the API Does

Our read-only endpoints expose:live volume per pair and per usercampaign metadata (epoch timers, reward pots, boost multipliers) rank, points, and reward history for the calling Grinder ID

Nothing more, nothing less no order placement, no wallet control.
Perfect for dashboards, and community leaderboards.

2. How We Keep It Safe

Bottom line: your keys stay encrypted, 
and every call is served over HTTPS with HMAC-signed JWTs.

Behind the scenes we run a fully serverless, secrets-first stack:
‍Supabase Postgres + RLS for all user and campaign records, with Vault encrypting API keys at rest.
‍
‍Convex reactive functions that stream trade deltas to dashboards in under a second.

‍Infisical central secret-manager; every edge function pulls keys at runtime, never bakes them into code.

‍Vercel global serverless hosting with automatic TLS and per-preview isolation.Add PostHog for anonymised product analytics and Resend for transactional email.

5. Roadmap & Public Launch

July–August: closed Alpha; endpoints may shift weekly.

September:full OpenAPI spec, webhook support.

Public Alpha Season – docs frozen for 7 months; 
any breaking change ships with a new version tag.

Questions before then ? Hop into #support on Discord mods answer live, usually in < 2 hours.

Get Paid , Stay Degen

To the moooooon ?

Here, all informations your need to know about the cashprice and rewards

1. Instant-Reward Wallet

Every Grinder is provisioned with an on-chain payout vault called Argent (Ready) on Starknet. You never handle seed-phrases; we airdrop straight to that address the moment an epoch or quest settles.
‍Currencies : USDC by default, USDT for selected issuers.Gas is on us zero withdrawal fees for the entire Alpha Season. Full tx-hash transparency in Discord channel.

2. Stacking the Bags

Generate volume on any live campaign pair.
‍Complete quests (e.g. 5-trade streaks, weekend alt runs, “bring-a-friend” challenges).
‍Level up ranks every tier bump multiplies your share of the seasonal jackpot.

The math is simple : more volume + more quests = more rank points = fatter splits & better loot.

3. Real-World Loot

Besides the $50 k–$100 k USDC seasonal pool we fund ourselves, top grinders can snag : PlayStation 5, Switch 2, high-end keyboards
Limited-edition Grindy.fun merch (hoodies, artisan keycaps)
Meme-tier surprises we’ll reveal mid-season
Keep an eye on the Loot Tracker in your dashboard; it updates whenever a new bounty drops.

4. Roadmap Hype

TL;DR : Trade, complete quests, climb ranks, cash out USDC/USDT to your Argent (Ready) vault, and maybe walk away with a console or two. Stay degen, stay tuned ,the craziest drops are still to come.

September (Q4 kick-off) – Public API v1, referral XP boost, webhook alerts

October – Guild system + squad leaderboards

November – On-chain achievements & NFT badge minting

December – Holiday mega-raffle (physical + on-chain prizes)

We’ll freeze core docs when each feature lands; until then, 
follow live updates in #release-notes on Discord.

Products Documentation

Kick-Off Kit

Quick Peek

Account Setup

First Grind

WTF is Grindy.fun?

Table of Contents

1. The One-Sentence Pitch

2. How the Magic Works

3. Gamified Layers

Zero to Hero Onboarding

1. Sign In & Suit Up

2. Build Your Grinder Profile

3. Connect Your Exchange (The Only Required Step)

4. Explore Your Dashboard

5. Enter a Championship & Grind

Ranking System

1. Why Ranks Exist

2. How You Climb

3. Tier Breakdown (Bronze → Diamond)

4. Seasonal Prize Pool

5. Coming Up

Arena RuleBook

1. Eligibility & Accounts

2. How Volume Is Counted

3. Permitted vs. Prohibited Trading

4. Anti-Bot & Fair-Play Controls

5. Rewards & Payout Schedule

Call The Matrix (API documentations)

1. What the API Does

2. How We Keep It Safe

Get Paid , Stay Degen

1. Instant-Reward Wallet

2. Stacking the Bags

3. Real-World Loot

4. Roadmap Hype