APIsGet Account Limits

Get Account Limits API

Retrieves comprehensive information about your account’s usage limits, remaining quotas, and current tier. This endpoint is essential for monitoring API usage, planning content strategies within quota constraints, and understanding your account’s capabilities across different features.

Endpoint Details

GET https://portfolio.tigest.club/api/v1/limit/get_limit

Content-Type: application/json

Request Parameters

This endpoint requires no query parameters or request body. All information is retrieved based on your authenticated account.

Authentication

Include your API key in the request header:

X-API-KEY: your_api_key_here

Basic Limit Check

curl --location 'https://portfolio.tigest.club/api/v1/limit/get_limit' \
--header 'X-API-KEY: your_api_key_here'

Response Format

Successful Response

Status Code: 200 OK

{
  "data": {
    "api_draft_post_limit": {
      "max": 30,
      "remaining": 28,
      "used": 2
    },
    "api_published_scheduled_post_limit": {
      "max": 0,
      "remaining": -10,
      "used": 10
    },
    "keyword_webhook_limit": {
      "max": 0,
      "remaining": 0,
      "used": 0
    },
    "list_limit": {
      "max": 0,
      "remaining": 0,
      "used": 0
    },
    "list_member_limit": {
      "max": 20,
      "remaining": 0,
      "used": 20
    },
    "mention_webhook_limit": {
      "max": 0,
      "remaining": 0,
      "used": 0
    },
    "published_scheduled_post_limit": {
      "max": 10,
      "remaining": 0,
      "used": 10
    },
    "tier": "free"
  },
  "success": true
}

Response Structure

Root Object

FieldTypeDescription
dataobjectContainer for all limit and usage information
successbooleanIndicates if the request was successful

Data Object Fields

FieldTypeDescription
api_draft_post_limitobjectLimits for draft posts created via API
api_published_scheduled_post_limitobjectLimits for published/scheduled posts via API
keyword_webhook_limitobjectLimits for keyword-based webhook subscriptions
list_limitobjectLimits for creating and managing lists
list_member_limitobjectLimits for adding members to lists
mention_webhook_limitobjectLimits for mention-based webhook subscriptions
published_scheduled_post_limitobjectLimits for published/scheduled posts (UI + API)
tierstringCurrent account tier (free, basic, pro, enterprise)

Limit Object Structure

Each limit object contains the following fields:

FieldTypeDescription
maxintegerMaximum allowed usage for this feature
remainingintegerRemaining quota (can be negative if over limit)
usedintegerCurrent usage count

Limit Categories Explained

API Draft Post Limit

Controls the number of draft posts you can create through the API:

  • Purpose: Prevents excessive draft creation that could impact system performance
  • Scope: Only applies to posts created via API endpoints
  • Reset: Typically resets monthly or when drafts are published/deleted

API Published/Scheduled Post Limit

Specific limit for posts published or scheduled through API calls:

  • Purpose: Rate limiting for automated posting systems
  • Scope: API-created posts that are actually published or scheduled
  • Note: Separate from UI-based posting limits

Published/Scheduled Post Limit

Overall limit for all published and scheduled posts:

  • Purpose: Total content output control across all interfaces
  • Scope: Includes both UI and API created posts
  • Impact: Core limitation affecting your content strategy

List Management Limits

List Limit

  • Purpose: Controls how many lists you can create
  • Use Case: Organizing followers, prospects, or content categories

List Member Limit

  • Purpose: Controls total members across all your lists
  • Use Case: Managing audience segmentation and targeting

Webhook Limits

Keyword Webhook Limit

  • Purpose: Monitor mentions of specific keywords or phrases
  • Use Case: Brand monitoring, competitor analysis

Mention Webhook Limit

  • Purpose: Track when your account is mentioned
  • Use Case: Engagement tracking, reputation management

Understanding Tier Limitations

Free Tier Characteristics

Based on the example response, free tier typically includes:

  • Limited API posting capabilities
  • Basic list management (20 member limit)
  • No webhook subscriptions
  • Restricted automation features

Upgrading Benefits

Higher tiers generally provide:

  • Increased posting limits
  • Advanced webhook capabilities
  • Larger list management quotas
  • Enhanced API access

Use Cases

Pre-Publishing Checks

Before scheduling content, verify you have remaining quota:

# Check limits before bulk scheduling
curl --location 'https://portfolio.tigest.club/api/v1/limit/get_limit' \
--header 'X-API-KEY: your_api_key_here'

Monitoring Dashboard Integration

Regular limit checks for application dashboards:

// Example: Check limits every hour
setInterval(async () => {
  const limits = await checkAccountLimits();
  updateDashboard(limits);
}, 3600000);

Quota Status Indicators

Normal Usage (Positive Remaining)

{
  "max": 30,
  "remaining": 25,
  "used": 5
}

Status: ✅ Normal operation Action: Continue normal usage

At Limit (Zero Remaining)

{
  "max": 10,
  "remaining": 0,
  "used": 10
}

Status: ⚠️ At capacity Action: Wait for reset or upgrade tier

Over Limit (Negative Remaining)

{
  "max": 0,
  "remaining": -10,
  "used": 10
}

Status: 🚫 Over quota Action: Feature may be restricted, upgrade required

Feature Unavailable (Zero Max)

{
  "max": 0,
  "remaining": 0,
  "used": 0
}

Status: 🔒 Not available on current tier Action: Upgrade to access feature


Error Handling

Authentication Error (Code: 4004)

{
  "errors": {
    "code": 4004,
    "message": "Invalid API key or insufficient permissions."
  },
  "success": false
}

Solution: Verify your API key is correct and active.

Service Unavailable (Code: 5003)

{
  "errors": {
    "code": 5003,
    "message": "Limit service temporarily unavailable."
  },
  "success": false
}

Solution: Retry after a brief delay.


Best Practices

1. Regular Monitoring

Check limits before major operations:

# Before bulk operations
curl --location 'https://portfolio.tigest.club/api/v1/limit/get_limit' \
--header 'X-API-KEY: your_api_key_here' | jq '.data'

2. Graceful Degradation

Handle limit exhaustion gracefully:

const limits = await getAccountLimits();
if (limits.published_scheduled_post_limit.remaining <= 0) {
  // Switch to draft creation or queue for later
  console.log("Publishing limit reached, switching to draft mode");
}

Last updated: May 30, 2025