API ReferenceAPI Keys
Get your API key info
Retrieve information about your own API key. Returns your key's name, tier, limits, and expiration date.
Header Parameters
X-API-Key*string
Response Body
application/json
application/json
application/json
application/json
application/json
application/json
application/json
curl -X GET "http://localhost:8000/me" \ -H "X-API-Key: string"{
"data": {
"id": 1,
"name": "Example"
},
"error": false,
"message": "Operation completed successfully",
"success": true
}{
"data": {
"errors": [
"field -> error message"
]
},
"error": true,
"message": "Validation error",
"success": false
}{
"data": {
"errors": [
"field -> error message"
]
},
"error": true,
"message": "Validation error",
"success": false
}{
"data": {
"errors": [
"field -> error message"
]
},
"error": true,
"message": "Validation error",
"success": false
}{
"data": {
"errors": [
"field -> error message"
]
},
"error": true,
"message": "Validation error",
"success": false
}{
"data": {
"errors": [
"field -> error message"
]
},
"error": true,
"message": "Validation error",
"success": false
}{
"data": {
"errors": [
"field -> error message"
]
},
"error": true,
"message": "Validation error",
"success": false
}Get API key usage statistics
Retrieve usage statistics for a specific API key. Returns: - Total requests made - Total leads scraped - Monthly usage vs limit - Remaining quota
Get your usage statistics
Retrieve your own API usage statistics. Returns: - Total requests made - Total leads scraped - Monthly usage vs your tier's limit - Remaining quota for the month