Credits

This section described how to check or buy Lookup credits through the API.

Balance

Request to check balance

GET https://a.looplookup.com/customer/api/v1/credits/balance/

Headers

Name	Type	Description
Authorization*	String	API Key
Content-Type*	String	application/json

200: OK Request accepted

This response returns results from a cache storage. Updated results may be returned with some delay (10-15 seconds).

{
  "credits": 100
}

400: Bad Request Request failed

{
    "success": false,
    "code": 100,
    "message": "Failed description",
}

Buy credits

Check available lookup packages

GET https://a.looplookup.com/customer/api/v1/credits/packages/

Headers

Name	Type	Description
Authorization*	String	API Key
Content-Type*	String	application/json

200: OK Request accepted

This response returns results from a cache storage. Updated results may be returned with some delay (10-15 seconds).

{
  "items": [
    {
      "id": "2BC4FD6A-CE49-439F-81DF-E895C09CA49C",
      "price": 10,
      "currency": "USD",
      "credits": 1000,
      "price_per_request": "0.01"
    }
  ]
}

400: Bad Request Request failed

{
    "success": false,
    "code": 100,
    "message": "Failed description",
}

Buy lookup package

To buy a package through an API request, you must have at least one active subscription. The billing method added to your subscription will be used to charge you for a purchase.

You can only submit 5 buy requests per hour.

POST https://a.looplookup.com/customer/api/v1/credits/buy/{package_id}/

Path Parameters

Name	Type	Description
package_id	String	The package ID that you can get from a list of available packages

Headers

Name	Type	Description
Authorization*	String	API Key
Content-Type*	String	application/json

200: OK Request accepted

{
  "success": true
}

400: Bad Request Request failed

{
    "success": false,
    "code": 100,
    "message": "Failed description",
}