Get started
API Endpoint https://ghostproject.fr/api
The GP API provides programmatic access to read pwned data. Retrieve a email/addresses/usernames/passwords......), provide an oauth connexion, retrieve a familly, filter them, etc.
To use this API, you need an API key to get your own API key. Purchase one
QUERY searching
# Here is a curl example
curl -G \
'https://ghostproject.fr/api/' \
-d 'api_key=XXXXXXXX' \
-d 'column=email' \
-d 'search_string="[email protected]"' \
-d 'row=10' \
-d 'type=json'
To get characters you need to make a GET call to the following url :
https://ghostproject.fr/api
[
{
"responseHeader": {
"params": {
"rows": "1",
"wt": "json",
"indent": "true",
"q": "email:\"[email protected]\""
},
"status": 0,
"QTime": 0
},
"response": {
"docs": [
{
"fax": "203-929-7799",
"email": "[email protected]",
"phoneNumber": "617-308-1410",
"company": "Deschenes, Albert",
"address": "65 Pearl Street",
"url": "BABYCAM.NET^^GHOSTPROJECT.NET",
"city": "NEWTON",
"Database_name": "8MillionUSA_Business",
"zip": "02458",
"stats": "MA"
}
],
"numFound": 2,
"start": 0
}
},
{
"responseHeader": {
"params": {
"rows": "1",
"wt": "json",
"indent": "true",
"q": "email:\"[email protected]\""
},
"status": 0,
"QTime": 0
},
"response": {
"docs": [
{
"email": "[email protected]",
"password": "rUG5cLevlRI=",
"Database_name": "Adobe.com"
}
],
"numFound": 1,
"start": 0
}
}
]
QUERY PARAMETERS
Field | Type | Description |
---|---|---|
api_key | String | Your API key. |
column | String | (optional) A search column to find character by column. |
username | String | (optional) a string array of columns: |
search_string | string | (optional) a string to search pwned results! |
row | Integer | (optional - default: 10) A limit on the number of page rows to be returned, between 1 and 1000 |
type | string | (optional - default: json) A limit of the types to be returned, chose between json,xml,csv. |
Errors
The GP API uses the following error codes:
Error Code | Meaning |
---|---|
401 | Your subscription is expired. Please purchase again. This error appears when your subscription expired. |
401 |
Invalid API key api_key . This error appears if you use an unknow API key.
|
400 |
Column is required column for this X. This error appears X is required mean you didn't fill are the columns required or you're missing some necessary columns like row & type...
|
400 | Special characters is not allowed. This error appears when you use forbidden characters for security reasons. |
Examples
This List of Examples & Explanations:
Examples | Meaning |
---|---|
column |
This a list of all columns : username,email,password,ip,password,Database_name,fullname, address,phoneNumber |
type |
GP offer 3 types of extension you can get after the requests data json,xml,csv .
|
search_string |
Search_string is your or what you query in the search for example ghostproject there's two options for that you can use exact record by adding the quotes "ghostproject"
or you can get unlimited wildcard results by removing the quotes.
|
Response from cluster | Response from cluster mean the cluster which the data came from, after the colon is the name of the clusters. Lets say we have multi clusters to keep everything fast. |
Wildcard |
Get exact record by addding the quotes example"ghostproject" or use unlimited wildcard results by simply removing the quotes ghostproject
|
Escaping Special Characters |
GP supports escaping special characters that are part of the query syntax. The current list special characters are
+ - && || ! ( ) { } [ ] ^ " ~ * ? : \
To escape these character use the \ before the character. For example to search for (1+1):2 use the query:
\(1\+1\)\:2 |
CSV Separator |
Extra CSV option.
These parameters specify the CSV format that will be returned. You can accept the default values or specify your own. Example:
&sep=: : , | or any characters that will be returned.
|