Skip to main content
GET
/
v1
/
accounts
/
{account_hash}
Get Account Details
curl --request GET \
  --url https://api.lobstr.io/v1/accounts/{account_hash} \
  --header 'Authorization: <authorization>'
{
  "id": "<string>",
  "object": "<string>",
  "username": "<string>",
  "created_at": "<string>",
  "last_synchronization_time": "<string>",
  "status": "<string>",
  "status_code_info": "<string>",
  "status_code_description": "<string>",
  "type": "<string>",
  "params": {},
  "updated_at": {},
  "account_type_hash": "<string>",
  "squids": [
    {}
  ],
  "baseurl": "<string>",
  "cookies": [
    {}
  ],
  "icon": "<string>"
}

Documentation Index

Fetch the complete documentation index at: https://docs.lobstr.io/llms.txt

Use this file to discover all available pages before exploring further.

This endpoint retrieves detailed information about a specific platform account using its hash ID.

​
Headers

​
Authorization
string
required
Your API authentication token. Value: Token YOUR_API_KEY

​
Query Parameters

​
account_hash
string
required
The unique identifier (hash) of the account. Example: d3e97f2cd33658f301bdbe807402ab30

​
Response Field Explanations

​
id
string
Unique account identifier. Example: "d3e97f2cd33658f301bdbe807402ab30"
​
object
string
Always “account”. Example: "account"
​
username
string
Platform username. Example: "hashamxcom"
​
created_at
string
Account creation timestamp (ISO 8601). Example: "2024-03-08T15:15:53Z"
​
last_synchronization_time
string
Last successful sync timestamp. Example: "2024-12-16T10:28:43Z"
​
status
string
HTTP status code indicating account health. Example: "200"
​
status_code_info
string
Status information keyword. Example: "synchronized"
​
status_code_description
string
Human-readable status message. Example: "Success!"
​
type
string
Account type identifier. Example: "twitter-sync"
​
params
object
Account parameters with default and user-specific settings. Example: {"default": {}, "user": {}}
​
updated_at
string | null
Last update timestamp. Example: null
​
account_type_hash
string
Reference to account type definition. Example: "9853173fc00a940a33d7a420c176ad3b"
​
squids
array
Array of squids currently using this account. Example: [{"name": "Twitter Scraper", "hash_value": "fcd3..."}]
​
baseurl
string
Platform base URL. Example: "https://x.com"
​
cookies
array
Required cookie specifications. Example: [{"name": "auth_token", "required": true}]
​
icon
string
Base64 encoded platform icon. Example: "<base64 image data>"
Check the squids array to see which squids are using this account before deleting or updating it.
Monitor the status field regularly. A status of 429 or 401 indicates cookie expiration and requires re-synchronization.
The params object contains both default limits and current user-configured values, useful for understanding account usage.

​
Code Examples

curl -X GET "https://api.lobstr.io/v1/accounts/d3e97f2cd33658f301bdbe807402ab30" \
  -H "Authorization: Token YOUR_API_KEY"

​
Response

200
{
  "total_results": 1,
  "limit": 50,
  "page": 1,
  "total_pages": 1,
  "result_from": 1,
  "result_to": 2,
  "data": [
    {
      "id": "d3e97f2cd33658f301bdbe807402ab30",
      "object": "account",
      "username": "hashamxcom",
      "created_at": "2024-03-08T15:15:53Z",
      "last_synchronization_time": "2024-12-16T10:28:43Z",
      "status": "200",
      "status_code_info": "synchronized",
      "status_code_description": "Success!",
      "type": "twitter-sync",
      "params": {
        "default": {},
        "user": {}
      },
      "updated_at": null,
      "account_type_hash": "9853173fc00a940a33d7a420c176ad3b",
      "squids": [
        {
          "name": "Twitter User Tweets Scraper (2)",
          "hash_value": "fcd3fff4053e444b8a98b3660bee8b03"
        }
      ],
      "baseurl": "https://x.com",
      "cookies": [
        {"name": "auth_token", "required": true},
        {"name": "ct0", "required": true}
      ],
      "icon": "<base64 image data>"
    }
  ],
  "next": null,
  "previous": null
}
401
{
  "detail": "Invalid token."
}
404
{
  "detail": "Not found."
}