cancel_automation

Stop an automation for good: every future run is cancelled. Orders already running finish, unless cancel_running: true asks those that allow it to cancel too (the undelivered part is refunded). Confirm with the user first.

destructive

Argument	Type	Description
automation*	integer	The automation number (the `id` of an automation, e.g. 2001).
cancel_running	boolean	Also ask its running orders to cancel.

Input schema (JSON)

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "required": [
    "automation"
  ],
  "properties": {
    "automation": {
      "type": "integer",
      "maximum": 9007199254740991,
      "description": "The automation number (the `id` of an automation, e.g. 2001).",
      "exclusiveMinimum": 0
    },
    "cancel_running": {
      "type": "boolean",
      "description": "Also ask its running orders to cancel."
    }
  }
}

cancel_order

Ask to cancel a pending or processing order (only when the order says cancelable: true). Whatever was not delivered is refunded to the balance in USD. Confirm with the user first.

destructive

Argument	Type	Description
order*	integer	The order number (the `id` field of an order, e.g. 1042).

Input schema (JSON)

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "required": [
    "order"
  ],
  "properties": {
    "order": {
      "type": "integer",
      "maximum": 9007199254740991,
      "description": "The order number (the `id` field of an order, e.g. 1042).",
      "exclusiveMinimum": 0
    }
  }
}

create_automation

Set up an automation: Spoofy places ordinary orders for the user on a plan. Kinds: spread (a total over time, e.g. {"kind":"spread","service":12,"link":"…","quantity":10000,"over":"3d"}; pace "steady" or "front" for an S-curve growth plan), scheduled (one order at start_at), recurring (every "1d"/"6h"/"1w", optional at "14:00" + timezone, with times, until or budget), split (past one order's max), campaign (steps [{service, link, quantity, offset_minutes, over_minutes}] or template: "token-launch" + links), keep_above (target + days + budget; public Telegram channels/groups and YouTube videos only), feed (a public Telegram channel, YouTube channel or RSS feed: every new post gets quantity of service; max_per_day, budget). Service ids come from find_services. THIS SPENDS THE USER'S REAL BALANCE: each run is charged when it goes (never above the planned price). Call first without confirm (or with dry_run: true): you get the plan — every run's time, size and cost, the total and the balance. Tell the user the total and timing and get their explicit OK, then call again with confirm: true and an idempotency_key. Errors: bad_automation / bad_schedule (the message says what to change), budget_required, count_not_readable (keep_above only reads those links), bad_feed (X has no public feed), too_many_automations, over_order_cap / platform_not_allowed / read_only_key (this key's limits).

destructive

Argument	Type	Description
confirm	boolean	Must be true to actually create it. Only after the user agreed to the plan and its cost.
dry_run	boolean	true = plan and price only, create nothing.
automation*	object	The automation, exactly as POST /api/v1/automations takes it: {"kind": …, "service": …, "link": …, …}.

find_services

Find what Spoofy can do for a link or a goal, with prices. ALWAYS call this first: service ids come from here. Give `link` (any profile, post, video, channel, group, token page or website URL) and/or `goal` in plain words, e.g. "500 followers on my tiktok" or "cheap views for this YouTube video". With a link you only get services that fit that exact link (a profile link gets followers, a post link gets likes/views). Returns matching services: `service` (the id to quote/order), name, tier (basic/standard/premium), pricePer1k (USD per 1,000 units), min/max quantity, start time, speed, preset packages with USD prices, and — when the goal names a quantity — a `suggestion` with the exact total for that quantity. A service with an `input` needs those fields in place_order `inputs` (custom comments, accounts to mention, a hashtag, a poll option, runs, subscription terms); `input.quantity` says where the quantity comes from. `query` narrows to services whose words match, e.g. "usa", "brazil", "real", "story". Free; spends nothing. On every service, counts can drop after delivery and drops are not replaced — tell the user before they buy followers, members or likes.

read-only

Argument	Type	Description
goal	string	What the user wants in words, e.g. "1k followers", "2.5k views, cheapest", "telegram members".
link	string	The URL to grow, e.g. https://x.com/yourname or https://www.tiktok.com/@you/video/123.
limit	integer	Most services to return (default 8).
query	string	Optional words every service returned must match: a country or region ("usa", "europe"), a quality ("real", "premium"), a kind ("story", "reels").

get_automation

One automation with its timeline: every run, the order it placed and what that delivered, or why a run waits or was skipped (balance, budget, a daily limit).

read-only

Argument	Type	Description
automation*	integer	The automation number (the `id` of an automation, e.g. 2001).

Input schema (JSON)

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "required": [
    "automation"
  ],
  "properties": {
    "automation": {
      "type": "integer",
      "maximum": 9007199254740991,
      "description": "The automation number (the `id` of an automation, e.g. 2001).",
      "exclusiveMinimum": 0
    }
  }
}

get_balance

The user's spendable balance in USD. Orders are paid from it.

read-only

No arguments.

Input schema (JSON)

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "properties": {}
}

get_order

Status and progress of one order: status (pending, processing, completed, partial, refunded, cancelled, failed), start count, delivered, remains, charge and refunds in USD, and whether it can be cancelled now.

read-only

Argument	Type	Description
order*	integer	The order number (the `id` field of an order, e.g. 1042).

Input schema (JSON)

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "required": [
    "order"
  ],
  "properties": {
    "order": {
      "type": "integer",
      "maximum": 9007199254740991,
      "description": "The order number (the `id` field of an order, e.g. 1042).",
      "exclusiveMinimum": 0
    }
  }
}

get_quote

Exact price in USD for a quantity of one service (from find_services). Checks the quantity is within the service range. Free; spends nothing. Use it to tell the user the cost before place_order. For services with an `input`, pass the same `inputs` as for place_order; the quantity is then the units charged: the number of comments or usernames, per run × runs, or for subscriptions max × (posts + old_posts).

read-only

Argument	Type	Description
link	string	Optional: the link it is for.
inputs	object	Order fields, for services with an `input` (see find_services).
service*	integer	Service id from find_services.
quantity*	integer	How many units (followers, views, …).

Input schema (JSON)

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "required": [
    "service",
    "quantity"
  ],
  "properties": {
    "link": {
      "type": "string",
      "maxLength": 1000,
      "description": "Optional: the link it is for."
    },
    "inputs": {
      "type": "object",
      "properties": {
        "max": {
          "type": "integer",
          "maximum": 9007199254740991,
          "minimum": -9007199254740991,
          "description": "Subscriptions: the most each new post gets."
        },
        "min": {
          "type": "integer",
          "maximum": 9007199254740991,
          "minimum": -9007199254740991,
          "description": "Subscriptions: the least each new post gets."
        },
        "runs": {
          "type": "integer",
          "maximum": 9007199254740991,
          "minimum": -9007199254740991,
          "description": "Spread the order over this many runs (2–100); `quantity` is then per run."
        },
        "delay": {
          "type": "integer",
          "maximum": 9007199254740991,
          "minimum": -9007199254740991,
          "description": "Subscriptions: minutes after a post goes up before it starts (0, 5, 10 … 600)."
        },
        "posts": {
          "type": "integer",
          "maximum": 9007199254740991,
          "minimum": -9007199254740991,
          "description": "Subscriptions: how many future posts it covers (1–500)."
        },
        "expiry": {
          "type": "string",
          "maxLength": 20,
          "description": "Subscriptions: the last day, YYYY-MM-DD (optional)."
        },
        "hashtag": {
          "type": "string",
          "maxLength": 100,
          "description": "Mentions by hashtag: one hashtag, e.g. \"#yourbrand\"."
        },
        "comments": {
          "anyOf": [
            {
              "type": "array",
              "items": {
                "type": "string",
                "maxLength": 2000
              },
              "maxItems": 5000
            },
            {
              "type": "string",
              "maxLength": 1000000
            }
          ],
          "description": "Custom comments: one per line, or a list. Their number is the quantity."
        },
        "interval": {
          "type": "integer",
          "maximum": 9007199254740991,
          "minimum": -9007199254740991,
          "description": "Minutes between runs (1–1440)."
        },
        "username": {
          "type": "string",
          "maxLength": 200,
          "description": "An account: whose followers get mentioned, whose comment gets the likes, or a subscription’s account."
        },
        "old_posts": {
          "type": "integer",
          "maximum": 9007199254740991,
          "minimum": -9007199254740991,
          "description": "Subscriptions: also this many of the latest posts (0–50)."
        },
        "usernames": {
          "anyOf": [
            {
              "type": "array",
              "items": {
                "type": "string",
                "maxLength": 200
              },
              "maxItems": 1000
            },
            {
              "type": "string",
              "maxLength": 100000
            }
          ],
          "description": "Mentions: the accounts to mention, one per line, or a list. Their number is the quantity."
        },
        "answer_number": {
          "type": "integer",
          "maximum": 9007199254740991,
          "minimum": -9007199254740991,
          "description": "Poll votes: the option to vote for, 1 = the first."
        }
      },
      "description": "Order fields, for services with an `input` (see find_services).",
      "additionalProperties": false
    },
    "service": {
      "type": "integer",
      "maximum": 9007199254740991,
      "description": "Service id from find_services.",
      "exclusiveMinimum": 0
    },
    "quantity": {
      "type": "integer",
      "maximum": 9007199254740991,
      "description": "How many units (followers, views, …).",
      "exclusiveMinimum": 0
    }
  }
}

get_top_up_info

How the user adds money to the balance: stablecoins (USDC, USDT or USDG, on the networks that are on) sent to their own deposit address — one address for every EVM network, another on Solana — credited 1 coin = $1, plus the top-up page link. Use it when an order fails with insufficient_balance. Tell the user to send only the listed coin on the listed network. You cannot move money yourself — give the user the address or the link.

read-only

No arguments.

Input schema (JSON)

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "properties": {}
}

list_automations

The user's automations, newest first, with progress (runs placed, delivered), spend against budget and the next run. Filter by status.

read-only

Argument	Type	Description
limit	integer	How many (default 10, max 50).
status	string	Only automations in this status.

Input schema (JSON)

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "properties": {
    "limit": {
      "type": "integer",
      "maximum": 50,
      "minimum": 1,
      "description": "How many (default 10, max 50)."
    },
    "status": {
      "enum": [
        "active",
        "paused",
        "completed",
        "cancelled",
        "failed"
      ],
      "type": "string",
      "description": "Only automations in this status."
    }
  }
}

list_orders

The user's orders, newest first. Filter by status; page with `before` = the smallest order number already seen.

read-only

Argument	Type	Description
limit	integer	How many (default 10, max 50).
before	integer	Only orders with a smaller number than this.
status	string	Only orders in this status.

Input schema (JSON)

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "properties": {
    "limit": {
      "type": "integer",
      "maximum": 50,
      "minimum": 1,
      "description": "How many (default 10, max 50)."
    },
    "before": {
      "type": "integer",
      "maximum": 9007199254740991,
      "description": "Only orders with a smaller number than this.",
      "exclusiveMinimum": 0
    },
    "status": {
      "enum": [
        "pending",
        "processing",
        "completed",
        "partial",
        "refunded",
        "cancelled",
        "failed"
      ],
      "type": "string",
      "description": "Only orders in this status."
    }
  }
}

pause_automation

Stop placing new runs until it is resumed (orders already running keep delivering). Nothing is charged while paused.

Argument	Type	Description
automation*	integer	The automation number (the `id` of an automation, e.g. 2001).

Input schema (JSON)

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "required": [
    "automation"
  ],
  "properties": {
    "automation": {
      "type": "integer",
      "maximum": 9007199254740991,
      "description": "The automation number (the `id` of an automation, e.g. 2001).",
      "exclusiveMinimum": 0
    }
  }
}

place_order

Place an order. THIS SPENDS THE USER'S REAL BALANCE (USD) and starts delivery to the link; it cannot be undone except by cancel_order where the service allows it. Before calling: get the price with get_quote and get the user's explicit agreement to that price. Then call with `confirm: true`. Without `confirm: true` nothing is charged and you get the price back so you can ask. `dry_run: true` validates everything (link fits the service, quantity range, key limits) and returns price, balance and whether it is enough — never charges. Pass a fresh `idempotency_key` per intended order so a retry never charges twice. Errors: insufficient_balance (details.shortfall = USD to top up — call get_top_up_info), over_order_cap / over_daily_cap / platform_not_allowed / read_only_key (this key's limits), wrong_platform, bad_quantity, link_busy (too many running on that link: details.available), chain_not_supported. Services with an `input` (find_services) take their fields in `inputs`: `comments` (custom comments, one per line or a list — their number is the quantity), `usernames` (accounts to mention), `hashtag`, `username`, `answer_number` (poll option, 1 = first), `runs` + `interval` (spread out; quantity is per run), or subscription terms (`min`, `max`, `posts`, `old_posts`, `delay`, `expiry`: auto-engagement on future posts, paid up front for at most max × posts). Text we post for the user is checked first: text_blocked = refused, nothing charged; a dry run says `text_review: true` when our team may check it before it starts. Errors also: bad_inputs, inputs_required. Done-for-you services (kind "manual": listings) need a form with images — those are ordered on the website.

destructive

Argument	Type	Description
link*	string	The URL to deliver to. Must fit the service (e.g. a profile link for followers).
inputs	object	Order fields, for services with an `input` (see find_services).

place_orders

Place up to 25 orders in one go — several services, one link or several — paid together from the balance. THIS SPENDS THE USER'S REAL BALANCE (USD) and starts delivery. Use it when the user wants several things at once (e.g. followers + likes + views for one account); for one order use place_order. Every order is checked first at today's price: if any one cannot go (link does not fit, quantity out of range, too many running on one link, balance short…) NONE is placed and each item says why. Then they are placed one by one; should one fail at that very moment, the others stay placed and that one says why (nothing charged for it). Without `confirm: true` nothing is charged: you get each price and the total so you can ask the user. With `confirm: true` also pass `max_total` = the total the user agreed to; if prices moved above it nothing is placed (price_changed). Pass a fresh `idempotency_key` per intended batch: a retry with the same key never places an order twice. Each item takes what place_order takes: `service`, `link`, `quantity`, or `inputs` for services with an `input`. Errors: batch_invalid (details.items says which and why), insufficient_balance (details.shortfall = USD to top up — call get_top_up_info), order_rate_limited, over_daily_cap, price_changed, idempotency_conflict.

destructive

Argument	Type	Description
items*	array	The orders, up to 25.
confirm	boolean	Must be true to actually place and charge. Only after the user agreed to the total.
dry_run	boolean	true = check and price only, never charge.
max_total	string	The total in USD the user agreed to, e.g. "12.34": nothing is placed if today's prices come to more.

resume_automation

Carry on with a paused automation: the rest of the plan moves by the time it was paused. After a price change, resuming accepts the new price for the runs left — tell the user first.

destructive

Argument	Type	Description
automation*	integer	The automation number (the `id` of an automation, e.g. 2001).

Input schema (JSON)

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "required": [
    "automation"
  ],
  "properties": {
    "automation": {
      "type": "integer",
      "maximum": 9007199254740991,
      "description": "The automation number (the `id` of an automation, e.g. 2001).",
      "exclusiveMinimum": 0
    }
  }
}

Spoofy

Try it

cancel_automation Destructive

Spoofy

Try it

cancel_automation Destructive

Tools (15)