To get started using the API, you'll need at least a developer API key. For some routes you will also need an access token for your account. Both of these are available here
When making requests to routes that need your key or token, they need to be added as query parameters, as opposed to headers or part of the request body. An example URL would look like this:
https://crabber.net/api/v1/crabs/1/?api_key=abcdefghijklm&access_token=nopqrstuvwxyz
Represents a user on the site. Currently can't be patched outside of the bio
| Property | Type | Notes |
|---|---|---|
| avatar | string | Relative link from crabber.net |
| bio? | object | Only present when using /crabs/:id/bio |
| display_name | string | |
| followers | int | Follower count |
| following | int | Following count |
| id | int | |
| register_time | int | Unix timestamp |
| username | string | |
| verified | boolean |
| Property | Type | Notes |
|---|---|---|
| age | string | |
| emoji | string | |
| jam | string | |
| location | string | |
| obsession | string | |
| pronouns | string | |
| quote | string | |
| remember | string |
| Property | Type | Notes |
|---|---|---|
| count | int | |
| crabs | Crab[] | |
| limit | int | |
| offset | int | |
| total | int |
Represents a post on the site
| Property | Type | Notes |
|---|---|---|
| author | Crab | Does not include bio |
| content | string | |
| crabtags | string[] | Strings do not contain % |
| edited | boolean | |
| id | int | |
| image? | string | Relative to crabber.net |
| likes | int | Number of likes |
| mentions | string[] | Contains usernames of mentioned users |
| quoted_molt? | int | Contains ID of quoted molt, or null |
| quotes | int | Number of quote molts |
| remolts | int | Number of remolts |
| replies | int | Number of replies |
| replying_to? | int | ID of molt replied to |
| timestamp | int | Unix timestamp |
| Property | Type | Notes |
|---|---|---|
| count | int | |
| limit | int | |
| molts | Molt[] | |
| offset | int | |
| total | int |
Fetches the current authenticated crab using the provided access token
Returns: Crab
Fetches a crab with the given ID
Returns: Crab
Fetches a crab with the given username
Returns: Crab
Fetches a crab with their bio included
Returns: Crab with bio
Updates the bio of a crab, given the access token matches the account
Body: Should be form data containing any of the keys found in the bio model
Returns: Crab with bio
Follows a crab from the account linked to the given access token
Returns: plain text confirmation message
Unfollows a crab from the account linked to the given token
Returns: plain text confirmation message
Gets a list of crabs following the given crab
Params:
| name | type | description |
|---|---|---|
| limit | int | The number of crabs to fetch |
| offset | int | Used for paginating the list |
Returns: Crab list
Gets a list of crabs the given crab is following
Params:
| name | type | description |
|---|---|---|
| limit | int | The number of crabs to fetch |
| offset | int | Used for paginating the list |
Returns: Crab list
Fetches molts created by this crab
Params:
| name | type | description |
|---|---|---|
| limit | int | The number of crabs to fetch |
| offset | int | Used for paginating the list |
| since_id | int | Molt ID; used to check for molts made after that one |
NOTE: Remolts currently appear as molts with no content, using the ID of the original molt
Returns: Molt list
Fetches the bookmarks of the given crab
Params:
| name | type | description |
|---|---|---|
| limit | int | The number of crabs to fetch |
| offset | int | Used for paginating the list |
Returns: Molt list
Creates a new molt
Body: Should be form data containing the following:
| name | type | description |
|---|---|---|
| content | string | Must be less than 280 characters |
| image | file | A file attachment of a valid image |
| source | string | Defaults to "Crabber API" |
Returns: Molt
Fetches a specific molt
Returns: Molt
Deletes a specific molt
Returns: plain text confirmation message
Edits the given molt.
NOTE: This endpoint is only valid within the first 5 minutes after sending a molt
Body: Should be form data containing the following:
| name | type | description |
|---|---|---|
| content | string | Must be less than 280 characters |
| image | file | A file attachment of a valid image |
| source | string | Defaults to "Crabber API" |
Returns: Molt
Quote-molts the given molt to the authorized account
Body: Should be form data containing the following:
| name | type | description |
|---|---|---|
| content | string | Must be less than 280 characters |
| image | file | A file attachment of a valid image |
| source | string | Defaults to "Crabber API" |
Returns: Molt
Replies to the given molt from the authorized account
Body: Should be form data containing the following:
| name | type | description |
|---|---|---|
| content | string | Must be less than 280 characters |
| image | file | A file attachment of a valid image |
| source | string | Defaults to "Crabber API" |
Returns: Molt
Remolts the given molt to the authorized account
Returns: plain text confirmation message
Deletes a remolt made from the authorized account
Returns: plain text confirmation message
Bookmarks the given molt
Returns: plain text confirmation message
Un-bookmarks the given molt
Returns: plain text confirmation message
Likes the given molt from the authorized account
Returns: plain text confirmation message
Unlikes the given molt from the authorized account
Returns: plain text confirmation message
Fetches replies on a molt
Params:
| name | type | description |
|---|---|---|
| limit | int | The number of crabs to fetch |
| offset | int | Used for paginating the list |
| since_id | int | Molt ID; used to check for molts made after that one |
Returns: Molt list
Fetches quote-molts on a molt
Params:
| name | type | description |
|---|---|---|
| limit | int | The number of crabs to fetch |
| offset | int | Used for paginating the list |
| since_id | int | Molt ID; used to check for molts made after that one |
Returns: Molt list
Fetches molts mentioning a user with the given username
Params:
| name | type | description |
|---|---|---|
| limit | int | The number of crabs to fetch |
| offset | int | Used for paginating the list |
| since_id | int | Molt ID; used to check for molts made after that one |
Returns: Molt list
Fetches molts replying to a user with the given username
Params:
| name | type | description |
|---|---|---|
| limit | int | The number of crabs to fetch |
| offset | int | Used for paginating the list |
| since_id | int | Molt ID; used to check for molts made after that one |
Returns: Molt list
Fetches molts using the given crabtag
Params:
| name | type | description |
|---|---|---|
| limit | int | The number of crabs to fetch |
| offset | int | Used for paginating the list |
| since_id | int | Molt ID; used to check for molts made after that one |
Returns: Molt list
Fetches the timeline for a user with the given username
Params:
| name | type | description |
|---|---|---|
| limit | int | The number of crabs to fetch |
| offset | int | Used for paginating the list |
| since_id | int | Molt ID; used to check for molts made after that one |
Returns: Molt list