Skip to content

AccountApi.md

Latest commit

 

History

History
67 lines (44 loc) · 1.9 KB

AccountApi.md

File metadata and controls

67 lines (44 loc) · 1.9 KB
Raw

ScrapeBadger\AccountApi

All URIs are relative to https://scrapebadger.com, except if the operation defines another base path.

Method HTTP request Description
accountGetAccountInfo() GET /v1/account/me Get account info

accountGetAccountInfo()

accountGetAccountInfo(): \ScrapeBadger\Model\AccountInfo

Get account info

Get account details for the authenticated API key. Returns credit balances, tier, rate limit, and subscription details. No credits are deducted for this call.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure API key authorization: ApiKeyAuth
$config = ScrapeBadger\Configuration::getDefaultConfiguration()->setApiKey('X-API-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = ScrapeBadger\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-Key', 'Bearer');


$apiInstance = new ScrapeBadger\Api\AccountApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);

try {
    $result = $apiInstance->accountGetAccountInfo();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AccountApi->accountGetAccountInfo: ', $e->getMessage(), PHP_EOL;
}

Parameters

This endpoint does not need any parameter.

Return type

\ScrapeBadger\Model\AccountInfo

Authorization

ApiKeyAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]