Skip to content
Account

Get Account Details

Retrieve detailed information about a specific platform account

The v1 API, for batchesSquids, tasks and runs: many calls on a schedule, delivered where you work. For one call that answers in seconds, use the API v2.
GEThttps://api.lobstr.io/v1/accounts/{account_hash}

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

Headers

Authorizationstringheaderrequired

Your API authentication token. Value: Token YOUR_API_KEY

Path Parameters

account_hashstringpathrequired

The unique identifier (hash) of the account. Example: d3e97f2cd33658f301bdbe807402ab30

Response Field Explanations

idstring

Unique account identifier. Example: "d3e97f2cd33658f301bdbe807402ab30"

objectstring

Always "account". Example: "account"

usernamestring

Platform username. Example: "hashamxcom"

created_atstring

Account creation timestamp (ISO 8601). Example: "2024-03-08T15:15:53Z"

last_synchronization_timestring

Last successful sync timestamp. Example: "2024-12-16T10:28:43Z"

statusstring

HTTP status code indicating account health. Example: "200"

status_code_infostring

Status information keyword. Example: "synchronized"

status_code_descriptionstring

Human-readable status message. Example: "Success!"

typestring

Account type identifier. Example: "twitter-sync"

paramsobject

Account parameters with default and user-specific settings. Example: {"default": {}, "user": {}}

Show params.user fields
user.is_proboolean

Leboncoin accounts only. true for a professional Leboncoin account, false for a personal one. Absent until the account sends a message or is synchronized again.

updated_atstring | null

Last update timestamp. Example: null

account_type_hashstring

Reference to account type definition. Example: "9853173fc00a940a33d7a420c176ad3b"

squidsarray

Array of squids currently using this account. Example: [{"name": "Twitter Scraper", "hash_value": "fcd3..."}]

baseurlstring

Platform base URL. Example: "https://x.com"

cookiesarray

Required cookie specifications. Example: [{"name": "auth_token", "required": true}]

iconstring

Base64 encoded platform icon. Example: "<base64 image data>"

limitsarray

The account's limits, each over a rolling 24 hours: an action (a profile, a search, a message) frees its slot 24 hours after it was counted, so there is no daily reset. One object per limit. The Leboncoin message sender's batch (messages sent in one go, then a pause) is not a 24-hour limit and stays in params.

Show limit fields
keystring

The limit, as named in params. Example: "profiles"

displaystring

Its label. Example: "Profiles per 24h"

maxinteger

The account's limit. Example: 100

used_24hinteger

Actions counted in the last 24 hours. Example: 53

remaininginteger

Actions still possible now. Example: 47

next_capacity_atstring | null

While the limit is full, when the next slot frees (UTC): runs paused by this limit resume then. null while there is room. Example: null

full_capacity_atstring | null

When everything counted now has left the 24 hours (UTC). null when nothing is counted. Example: "2026-11-12T13:35:00Z"

by_hourarray

The last 24 hours, one item per hour, oldest first. Example: [{"hour": "2026-11-11T13:00:00Z", "count": 53}, ...]

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."
}