What this connection includes
my_accessWhat THIS connection can and cannot see: whether it is on the free plan (on_free_plan), how many credits are left and roughly how many more tool calls that buys, which tier it is on, the exact row cap and time window every tool applies to it right now, what is locked, and precisely what lifts each limit. Call it whenever the user asks what they get, how many credits they have, why a result came back capped (any payload carrying a capped field), or how and where to upgrade. Only an active developer plan lifts the caps here, and this settles the two things people get wrong most often: CoinLobster Pro ($15/mo) is the WEBSITE subscription and adds nothing here, and a free API key lifts no cap here either (it does give this connection its own rate limit instead of a shared one). Free to call and never metered.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
No arguments | |||
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| caps | No | The row cap and time window every capped tool applies right now, each with the free value and the developer-plan value beside it. | |
| tier | No | Which of four states this connection is in: keyless, signed_in_free, coinlobster_pro or developer_plan. | |
| plain | No | One sentence describing this tier in the user own words rather than ours. | |
| credits | No | The balance: credits_remaining, plan, plan_active, credits_per_call, calls_left_estimate and where to top up. A null credits_remaining always carries a note saying WHY, because could not read and spent to zero send a user to two different places. | |
| metered | No | Whether calls cost credits on this connection, and how much. | |
| free_pairs | No | The pairs this connection can read. A list when keyless, the words every streamed pair on a developer plan, or a short sentence when the market lane could not be read. | |
| access_note | No | What this connection could not return and what lifts it. Always pass this on to the user: it is the only place that information appears. | |
| how_to_lift | No | What lifts the caps, where to get it, and (as not_this) the two things people buy by mistake that change nothing here. | |
| locked_here | No | What this connection cannot reach right now. Empty on a developer plan. | |
| on_free_plan | No | True when this connection reads free-shaped data. The single fact most users are asking for. | |
| authenticated | No | True when any valid sign-in or key was presented. |