help:api write requests
These are API requests which use the HTTP POST, PUT/PATCH or DELETE methods.
Limit
These types of requests are rate-limited per user level (Help:Users).
- Member - Make up to 10 API writes at once with a regen rate of 1 update per second.
- Gold - Make up to 30 API writes at once with a regen rate of 2 updates per second.
- Platinum - Make up to 60 writes at once with a regen rate of 4 updates per second.
Parameters
The parameters for write requests must be passed along in the body instead of as part of the URL.
URL encoding
These parameters use URL hash encoding, where the base object is the singular name of that particular endpoint, e.g. with /users
the base object is user.
-
Content-Type:
application/x-www-form-urlencoded
- Format: OBJECT[PARAMETER]=VALUE
-
Example:
post[rating]=s&post[tag_string]=danboo
JSON encoding
These parameters use JSON hash encoding, where the base object is also the singular name of the endpoint.
-
Content-Type:
application/json
- Format: { "OBJECT": { "PARAMETER": VALUE } }
-
Example:
{ "post": { "rating": "s", "tag_string": "danboo" } }