Raw schema
{
"type": "object",
"properties": {
"items": {
"minItems": 1,
"maxItems": 25,
"type": "array",
"items": {
"type": "object",
"properties": {
"service": {
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991,
"description": "Service id from find_services."
},
"link": {
"type": "string",
"minLength": 1,
"maxLength": 1000,
"description": "The URL to deliver to. Must fit the service."
},
"quantity": {
"description": "How many units. Leave out where the inputs count it or it is fixed.",
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
},
"inputs": {
"description": "Order fields, for services with an `input` (see find_services).",
"type": "object",
"properties": {
"comments": {
"description": "Custom comments: one per line, or a list. Their number is the quantity.",
"anyOf": [
{
"maxItems": 5000,
"type": "array",
"items": {
"type": "string",
"maxLength": 2000
}
},
{
"type": "string",
"maxLength": 1000000
}
]
},
"usernames": {
"description": "Mentions: the accounts to mention, one per line, or a list. Their number is the quantity.",
"anyOf": [
{
"maxItems": 1000,
"type": "array",
"items": {
"type": "string",
"maxLength": 200
}
},
{
"type": "string",
"maxLength": 100000
}
]
},
"hashtag": {
"description": "Mentions by hashtag: one hashtag, e.g. \"#yourbrand\".",
"type": "string",
"maxLength": 100
},
"username": {
"description": "An account: whose followers get mentioned, whose comment gets the likes, or a subscription’s account.",
"type": "string",
"maxLength": 200
},
"answer_number": {
"description": "Poll votes: the option to vote for, 1 = the first.",
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"runs": {
"description": "Spread the order over this many runs (2–100); `quantity` is then per run.",
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"interval": {
"description": "Minutes between runs (1–1440).",
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"min": {
"description": "Subscriptions: the least each new post gets.",
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"max": {
"description": "Subscriptions: the most each new post gets.",
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"posts": {
"description": "Subscriptions: how many future posts it covers (1–500).",
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"old_posts": {
"description": "Subscriptions: also this many of the latest posts (0–50).",
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"delay": {
"description": "Subscriptions: minutes after a post goes up before it starts (0, 5, 10 … 600).",
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"expiry": {
"description": "Subscriptions: the last day, YYYY-MM-DD (optional).",
"type": "string",
"maxLength": 20
}
},
"additionalProperties": false
}
},
"required": [
"service",
"link"
],
"additionalProperties": false
},
"description": "The orders, up to 25."
},
"confirm": {
"description": "Must be true to actually place and charge. Only after the user agreed to the total.",
"type": "boolean"
},
"dry_run": {
"description": "true = check and price only, never charge.",
"type": "boolean"
},
"max_total": {
"description": "The total in USD the user agreed to, e.g. \"12.34\": nothing is placed if today's prices come to more.",
"type": "string",
"pattern": "^\\d{1,9}(\\.\\d{1,6})?$"
},
"idempotency_key": {
"description": "Unique string per intended batch; a retry with the same key returns the first orders.",
"type": "string",
"minLength": 1,
"maxLength": 120
}
},
"required": [
"items"
],
"$schema": "http://json-schema.org/draft-07/schema#"
}