{"uid":"cap_myBITlzBIRCR4GqQHFlIn","slug":"apix402-vesting-plan-on-chain-status-reader-45bbc667","name":"APIX402 Vesting Plan On-Chain Status Reader","description":"Onchain- and crypto-market data for trading AI agents. Payment via x402 (USDC, exact scheme).","url":"https://api402x.com/vesting-status?utm_source=zero.xyz","method":"GET","headers":{},"bodySchema":{"type":"object","$schema":"https://json-schema.org/draft/2020-12/schema","required":["input"],"properties":{"input":{"type":"object","required":["type","method"],"properties":{"type":{"type":"string","const":"http"},"method":{"enum":["GET"],"type":"string"},"queryParams":{"type":"object","required":["provider","plan_id"],"properties":{"plan_id":{"type":"string","description":"Hedgey plan_id (ERC-721 token id) when provider=hedgey, or Sablier stream_id when provider=sablier. Both on Base."},"provider":{"enum":["hedgey","sablier"],"type":"string","description":"REQUIRED. Which contract to read: hedgey (TokenVestingPlans) or sablier (SablierLockup V2/v4). No default — plan_id/stream_id ranges overlap between the two contracts."}}}},"additionalProperties":false},"output":{"type":"object","required":["type"],"properties":{"type":{"type":"string"},"example":{"type":"object","required":["protocol","plan_id","chain","contract","token","beneficiary","status","amounts","starts_at","cliff_at","ends_at","discrepancy","onchain_verified_at","fetched_at"],"properties":{"chain":{"type":"string"},"token":{"type":"string"},"status":{"enum":["not_started","cliff_pending","vesting","fully_vested","canceled"],"type":"string"},"amounts":{"type":"object","required":["total","claimable_now","unvested_remainder","unit","raw"],"properties":{"raw":{"type":"object","required":["total","claimable_now","unvested_remainder"],"properties":{"total":{"type":"string"},"refunded":{"type":["string","null"]},"claimable_now":{"type":"string"},"already_withdrawn":{"type":["string","null"]},"unvested_remainder":{"type":"string"}},"additionalProperties":false},"unit":{"type":"string"},"total":{"type":"string"},"refunded":{"type":["string","null"]},"claimable_now":{"type":"string"},"already_withdrawn":{"type":["string","null"]},"unvested_remainder":{"type":"string"}},"additionalProperties":false},"ends_at":{"type":"string","format":"date-time"},"plan_id":{"type":"string"},"cliff_at":{"type":"string","format":"date-time"},"contract":{"type":"string"},"protocol":{"type":"string"},"starts_at":{"type":"string","format":"date-time"},"fetched_at":{"type":"string","format":"date-time"},"beneficiary":{"type":["string","null"]},"discrepancy":{"type":["string","null"]},"onchain_verified_at":{"type":"string","format":"date-time"}},"additionalProperties":false}}}}},"responseSchema":{"type":"json","example":{"chain":"eip155:8453","token":"0x080D43c2164AFdBc3712422CE78Ab902ccaB5CA1","status":"not_started","amounts":{"raw":{"total":"2500000000000000000000000","claimable_now":"0","unvested_remainder":"2500000000000000000000000"},"unit":"SPON","total":"2500000","claimable_now":"0","unvested_remainder":"2500000"},"ends_at":"2030-07-27T18:30:01.000Z","plan_id":"2334","cliff_at":"2027-07-28T18:30:00.000Z","contract":"0x2CDE9919e81b20B4B33DD562a48a84b54C48F00C","protocol":"hedgey","starts_at":"2027-07-28T18:30:00.000Z","fetched_at":"2026-08-12T17:39:11.454Z","beneficiary":"0x30eb1fA8fcd9DefB9be63B5fE0B805dE2F972fA9","discrepancy":null,"onchain_verified_at":"2026-08-12T17:39:11.454Z"}},"example":null,"exampleRequest":null,"tags":["x402"],"displayCostAmount":"0.003","displayCostAsset":"USDC","priceDynamic":false,"priceHint":null,"priceStatus":"priced","priceSource":"probe","requiresHandshake":false,"reviewCount":0,"rating":{"score":"0.00","successRate":"0.00","reviews":0,"stars":null,"state":"unrated"},"availabilityStatus":"down","priceObserved":null,"sessionDeposit":null,"pricing":{"kind":"static","summary":"$0.003/call","primary":{"kind":"static","protocol":"x402","network":"base","amountUsd":"0.003","per":"call","confidence":"exact"},"accepted":[{"kind":"static","protocol":"x402","network":"base","amountUsd":"0.003","per":"call","confidence":"exact"}]},"paymentMethods":[{"uid":"pm_0axiCEGx4AseFkn_GU8wj","protocol":"x402","methodType":"crypto","chain":"base","mode":"charge","costAmount":"0.003","costPer":"request","priority":0,"asset":"0x833589fCD6eDb6E08f4c7C32D4f71b54bdA02913","unit":"request","depositMicros":null,"planRef":null}],"brandName":null,"brandSlug":null,"brandBaseUrl":null,"brandDocsUrl":null,"whatItDoes":"Reads live vesting plan or stream data directly from Hedgey or Sablier contracts on Base, returning total, claimable, and unvested balances with on-chain verification.","exampleAgentPrompt":"Check the on-chain vesting status for Hedgey plan ID 2334 on Base — I want to see how much is claimable now, what's still unvested, and when the cliff and end dates are.","exampleUseCases":[{"title":"Verify claimable tokens before withdrawal","prompt":"Can you check how much is actually claimable right now on my Sablier stream ID 47 on Base? I want the real on-chain number, not what the dashboard shows."},{"title":"Audit beneficiary and schedule of a team grant","prompt":"Look up Hedgey vesting plan 2334 on Base and tell me who the beneficiary is, when the cliff hits, and how much total was allocated."},{"title":"Monitor unvested balance on a locked stream","prompt":"What's the unvested remainder on Sablier stream 12 on Base, and has the status changed from not_started yet?"}],"resultDescription":"Returns a JSON object with the vesting protocol name, plan/stream ID, chain, contract address, token symbol and address, beneficiary address, current status (not_started/cliff_pending/vesting/fully_vested/canceled), amounts in both human-readable and raw wei formats (total, claimable_now, unvested_remainder, already_withdrawn, refunded), starts_at, cliff_at, ends_at timestamps, a discrepancy flag, and onchain_verified_at and fetched_at timestamps.","failureModes":["Missing or invalid provider parameter returns 400 — provider is always required","plan_id not found on the specified contract returns an error","Wrong provider for a given ID (e.g. passing a Sablier stream ID to hedgey) returns contract-level error or empty result","Base RPC unavailability causes fetch failure","Canceled or non-existent plan returns status:canceled or error"],"whenToPreferThis":"Use this endpoint when you need authoritative, on-chain verified vesting data from Hedgey or Sablier contracts on Base — not cached dashboard data. Prefer it over indexer-based or dashboard APIs when the exact claimable balance or vesting math must be verified against the live contract state. Essential when plan IDs overlap between providers and disambiguation is required.","instructions":null,"reviewSummary":null,"reviewSummaryHighlights":null,"reviewSummaryConcerns":null,"reviewSummaryGeneratedAt":null,"activationCount":0,"lastUsedAt":null,"lastSuccessfullyRanAt":null,"lastHealthCheckAt":"2026-10-12T19:25:10.293Z","isFirstParty":false,"canonicalSlug":"apix402-vesting-plan-on-chain-status-reader-45bbc667"}