Skip to main content
GET
/
status
Get Scrape Status
curl --request GET \
  --url https://api.groweasy.io/status \
  --header 'Authorization: Bearer <token>'
{
  "success": true,
  "data": {
    "scrapeId": "scr_abc123xyz",
    "status": "completed",
    "progress": 100,
    "leadsFound": 87,
    "creditsUsed": 87,
    "createdAt": "2024-01-15T10:30:00Z",
    "completedAt": "2024-01-15T10:35:00Z"
  }
}

​
Example

curl -X GET "https://api.groweasy.io/status?scrapeId=scr_abc123xyz" \
  -H "Authorization: Bearer YOUR_API_KEY"

​
Response

{
  "success": true,
  "data": {
    "scrapeId": "scr_abc123xyz",
    "status": "completed",
    "progress": 100,
    "leadsFound": 87,
    "creditsUsed": 87,
    "createdAt": "2024-01-15T10:30:00Z",
    "completedAt": "2024-01-15T10:35:00Z"
  }
}

​
Polling for Completion

For long-running scrapes, poll the status endpoint until status is completed or failed: 
async function waitForScrape(scrapeId) {
  while (true) {
    const response = await fetch(
      `https://api.groweasy.io/status?scrapeId=${scrapeId}`,
      { headers: { 'Authorization': 'Bearer YOUR_API_KEY' } }
    );
    const data = await response.json();

    if (data.data.status === 'completed') {
      return data.data;
    }
    if (data.data.status === 'failed') {
      throw new Error('Scrape failed');
    }

    // Wait 5 seconds before polling again
    await new Promise(resolve => setTimeout(resolve, 5000));
  }
}

Authorizations

​
Authorization
string
header
required

API key authentication. Get your API key from the GrowEasy dashboard.

Query Parameters

​
scrapeId
string
required

The ID of the scrape job to check

Response

Scrape status retrieved successfully

​
success
boolean
Example:

true

​
data
object