GrayhatWarfare Shorteners API

https://shorteners.grayhatwarfare.com/docs/api/v1
Admin
The GrayhatWarfare Shorteners API allows users to search, fetch, filter, and sort shortener URLs and...
Tokens:7,157
Snippets:32
Trust Score:8.4
Update:1 year ago
Show doc for...
Tokens:
Raw
### GET /api/v1/files/{start}/{limit}

Source: https://shorteners.grayhatwarfare.com/docs/api/v1/index

Retrieves a list of files based on specified parameters. You can filter by keywords, file extensions, sorting order, and direction. The 'start' and 'limit' parameters control pagination.

```APIDOC
## GET /api/v1/files/{start}/{limit}

### Description
Retrieves a list of files based on specified parameters. You can filter by keywords, file extensions, sorting order, and direction. The 'start' and 'limit' parameters control pagination.

### Method
GET

### Endpoint
/api/v1/files/{start}/{limit}

### Parameters
#### Path Parameters
- **start** (integer) - Required - The index of the first url in the response.
- **limit** (integer) - Required - How many urls in response.

#### Query Parameters
- **keywords** (string) - Optional - Keywords to search for.
- **ext** (string) - Optional - File extension to filter by (e.g., 'pdf', 'html'). Multiple extensions can be comma-separated.
- **order** (enum) - Optional - Sort property. Values: `size`, `timestamp`.
- **direction** (enum) - Optional - Sort direction. Values: `asc`, `desc`.
- **noautocorrect** (integer) - Optional - If set to 1, disables autocorrection for keywords.

### Request Example
```curl
curl --request GET \
  --url 'https://shorteners.grayhatwarfare.com/api/v1/files/10/20?keywords=doe&ext=pdf&order=size&direction=asc' \
  --header 'Authorization: Bearer {authToken}'
```

### Response
#### Success Response (200)
- **urlsCount** (integer) - How many urls match the filters.
- **premiumUrlsCount** (integer) - How many urls match the filters, when you have a premium account.
- **start** (integer) - The index of the first url in the response.
- **limit** (integer) - How many urls in response.
- **urls** (array) - An array containing the urls requested. The number of urls may be a subset of the total ones matched, depending on the start and limit parameters of the request.
  - **id** (string) - The id of this url in our database.
  - **subDomain** (string) - The url's subomain.
  - **regDomain** (string) - The url's registered domain.
  - **size** (integer) - The url's file size in bytes.
  - **url** (string) - The actual url.
  - **ext** (string) - The url's file extension.
  - **mimeType** (string) - The url's file mime type.
  - **shortUrl** (string) - The shortened url.
  - **discoveredTimestamp** (integer) - The timestamp when the url was discovered.
- **order** (enum) - Sort property.
- **direction** (enum) - Sort direction.

#### Response Example
```json
{
    "urlsCount": 1,
    "premiumUrlsCount": 1,
    "start": 0,
    "limit": 1000,
    "urls": [
        {
            "id": "5fec8c2c663cb3bf6759ec27",
            "subDomain": "doe.juntaex.es",
            "regDomain": "juntaex.es",
            "size": 103169,
            "url": "http://doe.juntaex.es/pdfs/doe/2009/1780O/09062583.pdf",
            "ext": "pdf",
            "mimeType": "application/pdf",
            "shortUrl": "http://bit.ly/106iDm",
            "discoveredTimestamp": 1608418800
        }
    ],
    "order": "size",
    "direction": "asc"
}
```
```

--------------------------------

### GET /api/v1/subdomains/{start}/{limit}

Source: https://shorteners.grayhatwarfare.com/docs/api/v1/index

Allows searching and fetching subdomains with filtering and sorting capabilities. You can specify the start index, limit, keywords, order, and direction for your search.

```APIDOC
## GET /api/v1/subdomains/{start}/{limit}

### Description
Allows searching and fetching the subdomains, supporting filtering and sorting.

### Method
GET

### Endpoint
`/api/v1/subdomains/{start}/{limit}`

### Parameters
#### Path Parameters
- **start** (integer) - Optional - The index of the first subdomain to fetch. Default: `0`
- **limit** (integer) - Optional - The number of subdomains to fetch. Valid values: `1-1000`. Default: `100`

#### Query Parameters
- **keywords** (string) - Optional - Your query for searching subdomains. Example: `savarakatranemia`
- **order** (enum) - Optional - Sort the queried URLs by a property. Valid values: `count`
- **direction** (enum) - Optional - Whether the sorting is ascending or descending. Valid values: `asc`, `desc`

### Request Example
```json
{
  "example": "curl --request GET \
  --url 'https://shorteners.grayhatwarfare.com/api/v1/subdomains/0/10?keywords=doe&order=count&direction=desc' \
  --header 'Authorization: Bearer {authToken}'"
}
```

### Response
#### Success Response (200)
- **domainsCount** (integer) - How many subdomains match the filters.
- **start** (integer) - The index of the first subdomain in the response.
- **limit** (integer) - How many subdomains are in the response.
- **subDomains** (array) - An array containing the subdomains requested. Each object has:
  - **id** (string) - The ID of the subdomain. Example: `5fec8c2c663cb3bf6759ec27`
  - **subDomain** (string) - The subdomain. Example: `joe.juntaex.es`
  - **regDomain** (string) - The registered domain. Example: `juntaex.es`
  - **urlsCount** (integer) - The number of URLs in this subdomain. Example: `103169`
- **order** (enum) - The sort property. Values: `count`
- **direction** (enum) - The sort direction. Values: `asc`, `desc`

#### Response Example
```json
{
    "domainsCount": 1,
    "start": 0,
    "limit": 100,
    "subDomains": [
        {
            "id": "5fec8c14663cb3bf6759e8e2",
            "subDomain": "doe.juntaex.es",
            "regDomain": "juntaex.es",
            "urlsCount": 1
        }
    ],
    "order": "count",
    "direction": "desc"
}
```
```

--------------------------------

### Subdomain Feed Response Example

Source: https://shorteners.grayhatwarfare.com/docs/api/v1/index

Example JSON response for a successful subdomain feed query. It includes counts of matching URLs, pagination information, and an array of URL objects, each with details like ID, subdomain, domain, size, URL, extension, MIME type, short URL, and discovery timestamp.

```json
{
    "urlsCount": 2,
    "premiumUrlsCount": 2,
    "start": 0,
    "limit": 10,
    "urls": [
        {
            "id": "5fec8c2d663cb3bf6759ec73",
            "subDomain": "feedproxy.google.com",
            "regDomain": "google.com",
            "size": -1,
            "url": "http://feedproxy.google.com/~r/Likecool/~3/8sBUYa_7W7M/BedBunker--Men--Gear.html",
            "ext": "html",
            "mimeType": "text/html",
            "shortUrl": "http://bit.ly/10GEzH",
            "discoveredTimestamp": 1608418800
        },
        {
            "id": "5fec8c2d663cb3bf6759ecb8",
            "subDomain": "feedproxy.google.com",
            "regDomain": "google.com",
            "size": -1,
            "url": "http://feedproxy.google.com/~r/nomanoshiwaza/~3/xvJOm-fx-Yo/007064.html",
            "ext": "html",
            "mimeType": "text/html",
            "shortUrl": "http://bit.ly/10Msih",
            "discoveredTimestamp": 1608418800
        }
    ],
    "order": "timestamp",
    "direction": "desc"
}
```

--------------------------------

### API Authentication Header Example

Source: https://shorteners.grayhatwarfare.com/docs/api/v1/index

Demonstrates how to include the API access token as a header in an API request for authentication.

```http
Authorization: Bearer {apiKey}
```

--------------------------------

### API Authentication Query Parameter Example

Source: https://shorteners.grayhatwarfare.com/docs/api/v1/index

Illustrates how to provide the API access token as a query parameter in an API request for authentication.

```http
...&access_token={apiKey}...
```

--------------------------------

### GET /api/v1/subdomain/{subdomain}/files/{start}/{limit}

Source: https://shorteners.grayhatwarfare.com/docs/api/v1/index

Allows searching and fetching the URLs of a specific subdomain, with filtering and sorting capabilities.

```APIDOC
## GET /api/v1/subdomain/{subdomain}/files/{start}/{limit}

### Description
Allows searching and fetching the URLs of a subdomain, supporting filtering and sorting.

### Method
GET

### Endpoint
`/api/v1/subdomain/{subdomain}/files/{start}/{limit}`

### Parameters
#### Path Parameters
- **subdomain** (string) - Required - The subdomain to list or filter URLs for. Accepts either the domain name or its unique ID.
- **start** (integer) - Optional - The index of the first subdomain URL to fetch. Default: `0`
- **limit** (integer) - Optional - The number of URLs to fetch. Valid values: `1-1000`. Default: `100`

### Request Example
```json
{
  "example": "curl --request GET \
  --url 'https://shorteners.grayhatwarfare.com/api/v1/subdomain/example.com/files/0/100' \
  --header 'Authorization: Bearer {authToken}'"
}
```

### Response
#### Success Response (200)
[Details about the response body for a successful request would go here, similar to the subdomains endpoint but specific to URLs.]

#### Response Example
```json
{
  "example": "[Response body with list of URLs for the subdomain]"
}
```
```

--------------------------------

### Regex Examples for File Searching

Source: https://shorteners.grayhatwarfare.com/docs/api/v1/index

Demonstrates various regular expression patterns to find files based on their names. Covers patterns for finding files containing specific keywords, date formats, multiple extensions, and literal strings.

```regex
.*backup.***
```

```regex
.*2018[\-_\. ]11.***
```

```regex
.*dump.*(gz|tar|zip)
```

```regex
backup.***
```

```regex
.*backup
```

```regex
.*\.php
```

```regex
19[0-9]{2}  
**
```

```regex
.*"test.txt"
```

--------------------------------

### GET /api/v1/subdomain/{subdomain}/files/{offset}/{limit}

Source: https://shorteners.grayhatwarfare.com/docs/api/v1/index

Retrieves a list of files from a specified subdomain, with options for filtering by extension, keywords, and sorting by size.

```APIDOC
## GET /api/v1/subdomain/{subdomain}/files/{offset}/{limit}

### Description
Retrieves files associated with a given subdomain. Supports pagination via offset and limit, and can filter by file extension, keywords, and sort order.

### Method
GET

### Endpoint
`/api/v1/subdomain/{subdomain}/files/{offset}/{limit}`

### Parameters
#### Path Parameters
- **subdomain** (string) - Required - The subdomain to query (e.g., `feedproxy.google.com`).
- **offset** (integer) - Required - The starting index for the results.
- **limit** (integer) - Required - The maximum number of results to return.

#### Query Parameters
- **ext** (string) - Optional - Comma-separated list of file extensions to filter by (e.g., `pdf,html`).
- **order** (string) - Optional - The field to sort the results by (e.g., `size`).
- **direction** (string) - Optional - The direction of sorting (`asc` or `desc`).
- **keywords** (string) - Optional - Keywords to search for within the file names or content.

### Request Example
```json
{
  "example": "curl --request GET \n  --url 'https://shorteners.grayhatwarfare.com/api/v1/subdomain/archive.org/files/0/1000?ext=pdf%2Chtml&order=size&direction=desc&keywords=media' \n  --header 'Authorization: Bearer {authToken}'"
}
```

### Response
#### Success Response (200)
- **files** (array) - A list of file objects, each containing details like name, URL, size, etc.
- **meta** (object) - Meta-information about the request, such as total count.

#### Response Example
```json
{
  "example": "{\"files\":[{\"name\":\"example.pdf\",\"url\":\"http://example.com/example.pdf\",\"size\":1024000,\"type\":\"pdf\"}], \"meta\":{\"total\":1000}}"
}
```
```

--------------------------------

### Get 0-10 links for feedproxy.google.com

Source: https://shorteners.grayhatwarfare.com/docs/api/v1/index

Retrieves the first 10 links associated with the 'feedproxy.google.com' subdomain. Requires an authorization token.

```shell
curl --request GET \
  --url https://shorteners.grayhatwarfare.com/api/v1/subdomain/feedproxy.google.com/files/0/10 \
  --header 'Authorization: Bearer {authToken}'
```

--------------------------------

### Fetch Subdomains by Range (curl)

Source: https://shorteners.grayhatwarfare.com/docs/api/v1/index

Retrieves a specified range of subdomains. The 'start' parameter defines the index of the first subdomain, and 'limit' specifies the number of subdomains to fetch.

```shell
curl --request GET \
  --url https://shorteners.grayhatwarfare.com/api/v1/subdomains/0/1000 \
  --header 'Authorization: Bearer {authToken}'
```

--------------------------------

### Get Subdomain Feed with cURL

Source: https://shorteners.grayhatwarfare.com/docs/api/v1/index

Example request to retrieve subdomain feed data using cURL. It demonstrates how to specify parameters like extension, keywords, order, and direction, along with authentication using a bearer token.

```shell
curl --request GET \
  --url 'https://shorteners.grayhatwarfare.com/api/v1/subdomain/feedproxy.google.com/files/0/10?ext=html&keywords=feedproxy&order=timestamp&direction=desc' \
  --header 'Authorization: Bearer {authToken}'
```

--------------------------------

### Get 0-1000 PDFs or HTMLs matching 'media' from archive.org, sorted by size

Source: https://shorteners.grayhatwarfare.com/docs/api/v1/index

Fetches up to 1000 PDF or HTML files from 'archive.org', matching the keyword 'media' and sorted by size in descending order. An authorization token is needed.

```shell
curl --request GET \
  --url 'https://shorteners.grayhatwarfare.com/api/v1/subdomain/archive.org/files/0/1000?ext=pdf%2Chtml&order=size&direction=desc&keywords=media' \
  --header 'Authorization: Bearer {authToken}'
```

--------------------------------

### Fetch Subdomains by Offset and Limit (curl)

Source: https://shorteners.grayhatwarfare.com/docs/api/v1/index

Retrieves a subsequent batch of subdomains by specifying a starting index and a limit. Useful for paginating through subdomain results.

```shell
curl --request GET \
  --url https://shorteners.grayhatwarfare.com/api/v1/subdomains/2000/1000 \
  --header 'Authorization: Bearer {authToken}'
```

--------------------------------

### Get 0-1000 PDFs from archive.org, sorted by size descending

Source: https://shorteners.grayhatwarfare.com/docs/api/v1/index

Retrieves up to 1000 PDF files from 'archive.org', sorted by file size in descending order. Requires an authorization token.

```shell
curl --request GET \
  --url 'https://shorteners.grayhatwarfare.com/api/v1/subdomain/archive.org/files/0/1000?ext=pdf&order=size&direction=desc' \
  --header 'Authorization: Bearer {authToken}'
```

--------------------------------

### GET /api/v1/stats

Source: https://shorteners.grayhatwarfare.com/docs/api/v1/index

Retrieves statistics about the Grayhatwarfare shorteners index, including URL counts, subdomain counts, and the last update time.

```APIDOC
## GET /api/v1/stats

### Description
Fetches overall statistics for the Grayhatwarfare shorteners index. This includes the total count of URLs, subdomains, and the timestamp of the last index update.

### Method
GET

### Endpoint
`/api/v1/stats`

### Parameters
#### Query Parameters
None

### Request Example
```json
{
  "example": "curl --request GET \n  --url https://shorteners.grayhatwarfare.com/api/v1/stats \n  --header 'Authorization: Bearer {authToken}'"
}
```

### Response
#### Success Response (200)
- **meta** (object) - Contains meta-information, potentially including user account restrictions.
- **notice** (string) - Optional. A notice related to user stats.
- **restrictedStats** (object) - Optional. Stats data when restrictions apply, following the schema of the `stats` object.
- **stats** (object) - Contains the main statistics:
    - **urlsCount** (integer) - Total number of URLs in the index.
    - **subdomainsCount** (integer) - Total number of subdomains in the index.
- **lastUpdated** (integer) - Unix timestamp of the last index update.

#### Response Example
```json
{
  "example": "{\n    \"meta\": [],\n    \"stats\": {\n        \"urlsCount\": 4000000201,\n        \"subdomainsCount\": 85213243\n    },\n    \"lastUpdated\": 1692344111\n}"
}
```
```

--------------------------------

### Get 1000-1010 links matching 'link' for feedproxy.google.com

Source: https://shorteners.grayhatwarfare.com/docs/api/v1/index

Fetches 10 links within the range of 1000 to 1010 for 'feedproxy.google.com' that match the keyword 'link'. An authorization token is required.

```shell
curl --request GET \
  --url 'https://shorteners.grayhatwarfare.com/api/v1/subdomain/feedproxy.google.com/files/1000/10?keywords=link' \
  --header 'Authorization: Bearer {authToken}'
```

--------------------------------

### GET /api/v1/subdomain/{subdomain}/files

Source: https://shorteners.grayhatwarfare.com/docs/api/v1/index

Retrieves a list of files associated with a given subdomain. You can filter the results by keywords, file extensions, and specify sorting order and direction.

```APIDOC
## GET /api/v1/subdomain/{subdomain}/files

### Description
Retrieves a list of files associated with a given subdomain. Allows filtering by keywords, file extensions, and sorting.

### Method
GET

### Endpoint
/api/v1/subdomain/{subdomain}/files

### Parameters
#### Path Parameters
- **subdomain** (string) - Required - The subdomain to search for files.

#### Query Parameters
- **keywords** (string) - Optional - Your query keywords.
- **ext** (string) - Optional - A comma-separated list of file extensions to filter by.
- **order** (enum) - Optional - Property to sort the results by. Valid values: `size`, `timestamp`.
- **direction** (enum) - Optional - Direction of sorting. Valid values: `asc`, `desc`.

### Request Example
```bash
curl --request GET \
  --url 'https://shorteners.grayhatwarfare.com/api/v1/subdomain/feedproxy.google.com/files/0/10?ext=html&keywords=feedproxy&order=timestamp&direction=desc' \
  --header 'Authorization: Bearer {authToken}'
```

### Response
#### Success Response (200)
- **urlsCount** (integer) - Number of URLs matching the filters.
- **premiumUrlsCount** (integer) - Number of URLs matching the filters for premium users.
- **start** (integer) - The index of the first URL in the response.
- **limit** (integer) - The number of URLs in the response.
- **urls** (array) - An array containing the requested URLs.
  - **id** (string) - The ID of the URL in the database.
  - **subDomain** (string) - The subdomain of the URL.
  - **regDomain** (string) - The registered domain of the URL.
  - **size** (integer) - The file size of the URL in bytes.
  - **url** (string) - The actual URL.
  - **ext** (string) - The file extension of the URL.
  - **mimeType** (string) - The MIME type of the file.
  - **shortUrl** (string) - The shortened URL.
  - **discoveredTimestamp** (integer) - The timestamp when the URL was discovered.
  - **order** (enum) - The sort property used.
  - **direction** (enum) - The sort direction used.

#### Response Example
```json
{
    "urlsCount": 2,
    "premiumUrlsCount": 2,
    "start": 0,
    "limit": 10,
    "urls": [
        {
            "id": "5fec8c2d663cb3bf6759ec73",
            "subDomain": "feedproxy.google.com",
            "regDomain": "google.com",
            "size": -1,
            "url": "http://feedproxy.google.com/~r/Likecool/~3/8sBUYa_7W7M/BedBunker--Men--Gear.html",
            "ext": "html",
            "mimeType": "text/html",
            "shortUrl": "http://bit.ly/10GEzH",
            "discoveredTimestamp": 1608418800
        },
        {
            "id": "5fec8c2d663cb3bf6759ecb8",
            "subDomain": "feedproxy.google.com",
            "regDomain": "google.com",
            "size": -1,
            "url": "http://feedproxy.google.com/~r/nomanoshiwaza/~3/xvJOm-fx-Yo/007064.html",
            "ext": "html",
            "mimeType": "text/html",
            "shortUrl": "http://bit.ly/10Msih",
            "discoveredTimestamp": 1608418800
        }
    ],
    "order": "timestamp",
    "direction": "desc"
}
```
```

--------------------------------

### Search Shortened URLs Endpoint

Source: https://shorteners.grayhatwarfare.com/docs/api/v1/index

This endpoint allows searching and fetching shortened URLs with filtering and sorting capabilities. It requires specifying the start index and limit for the results.

```http
GET https://shorteners.grayhatwarfare.com/api/v1/files/{start}/{limit}
```

--------------------------------

### Retrieve PDF files with keywords and autocorrection (curl)

Source: https://shorteners.grayhatwarfare.com/docs/api/v1/index

Fetches PDF files matching a keyword with autocorrection enabled. An authorization token is required. This behaves similarly to the noautocorrect example.

```curl
curl --request GET \
  --url 'https://shorteners.grayhatwarfare.com/api/v1/files/0/10?ext=pdf&keywords=jun' \
  --header 'Authorization: Bearer '
```

--------------------------------

### Retrieve files with keywords, extension, and sorting (curl)

Source: https://shorteners.grayhatwarfare.com/docs/api/v1/index

Fetches files matching specified keywords and extensions, sorted by size in ascending order. Requires an authorization token.

```curl
curl --request GET \
  --url 'https://shorteners.grayhatwarfare.com/api/v1/files/10/20?keywords=doe&ext=pdf&order=size&direction=asc' \
  --header 'Authorization: Bearer {authToken}'
```

--------------------------------

### Retrieve PDF or HTML files by keyword and sort (curl)

Source: https://shorteners.grayhatwarfare.com/docs/api/v1/index

Fetches PDF or HTML files matching a keyword, sorted by size in descending order. Requires an authorization token.

```curl
curl --request GET \
  --url 'https://shorteners.grayhatwarfare.com/api/v1/files/0/1000?order=size&direction=desc&ext=pdf%2Chtml&keywords=media' \
  --header 'Authorization: Bearer {authToken}'
```

--------------------------------

### Search Subdomains with Filtering and Sorting (curl)

Source: https://shorteners.grayhatwarfare.com/docs/api/v1/index

Fetches subdomains with optional keyword filtering, sorting by URL count in descending order. Requires an authorization token.

```shell
curl --request GET \
  --url 'https://shorteners.grayhatwarfare.com/api/v1/subdomains/0/10?keywords=doe&order=count&direction=desc' \
  --header 'Authorization: Bearer {authToken}'
```

--------------------------------

### Search Shortened URLs Request Parameters

Source: https://shorteners.grayhatwarfare.com/docs/api/v1/index

Details the available URL and query parameters for the 'Search shortened urls' endpoint, including options for filtering by keywords, extensions, and sorting.

```http
start: integer optional
The index of the first url to fetch.
Default: `0`
```

```http
limit: integer optional
The number of urls to fetch.
Valid values: `1-1000`
Default: `100`
```

```http
keywords: string optional
Your query.
Examples: `savarakatranemia`
```

```http
ext: string optional
A list of extensions. If more than one separated with ,
Examples: `html` `html,csv`
```

```http
regexp: boolean optional
Marks the query provided in the keywords as a regular expression search. This is parameter provided as a plain text, but depending on how you craft the query, you might need to urlencode the parameter. You can take a look at our basic overview of regex usage or view the regex documentation.
Examples: `1` `true`
```

```http
noautocorrect: boolean optional
Do not attempt to autocorrect the query when parsing it as regexp  ..
Examples: `1` `true`
```

```http
order: enum optional
Sort the queried urls by a property on them.
Valid values: `size` `timestamp`
```

```http
direction: enum optional
Whether the sorting done on the property defined by the order parmeter is ascending or descending.
Valid values: `asc` `desc`
```

--------------------------------

### Search and Sort Subdomains by URL Count (curl)

Source: https://shorteners.grayhatwarfare.com/docs/api/v1/index

Fetches subdomains containing a specified keyword and sorts them in descending order based on the number of URLs associated with each subdomain. Requires an authorization token.

```shell
curl --request GET \
  --url 'https://shorteners.grayhatwarfare.com/api/v1/subdomains/0/10?keywords=drive&order=count&direction=desc' \
  --header 'Authorization: Bearer {authToken}'
```

--------------------------------

### Search Shortened URLs

Source: https://shorteners.grayhatwarfare.com/docs/api/v1/index

Allows searching and fetching shortened URLs with filtering and sorting capabilities. Supports query parameters for keywords, extensions, regular expressions, and sorting options.

```APIDOC
## GET /api/v1/files/{start}/{limit}

### Description
Allows searching and fetching the urls allowing filtering and sorting.

### Method
GET

### Endpoint
https://shorteners.grayhatwarfare.com/api/v1/files/{start}/{limit}

### Parameters
#### Path Parameters
- **start** (integer) - Optional - The index of the first url to fetch. Default: `0`
- **limit** (integer) - Optional - The number of urls to fetch. Valid values: `1-1000`. Default: `100`

#### Query Parameters
- **keywords** (string) - Optional - Your query. Examples: `savarakatranemia`
- **ext** (string) - Optional - A list of extensions. If more than one separated with `,`. Examples: `html` `html,csv`
- **regexp** (boolean) - Optional - Marks the query provided in the keywords as a regular expression search. Examples: `1` `true`
- **noautocorrect** (boolean) - Optional - Do not attempt to autocorrect the query when parsing it as regexp. Examples: `1` `true`
- **order** (enum) - Optional - Sort the queried urls by a property on them. Valid values: `size` `timestamp`
- **direction** (enum) - Optional - Whether the sorting done on the property defined by the order parameter is ascending or descending. Valid values: `asc` `desc`

#### Request Body
This endpoint does not accept a request body.

### Response
#### Success Response (200)
application/json
A successful request returns the HTTP 200 OK status code and a JSON response body that contains the urls matching the request parameters.

#### Response Example
```json
{
  "urls": [
    {
      "url": "http://example.com/shortened1",
      "original_url": "http://original.com/verylongurl1",
      "timestamp": "2023-01-01T10:00:00Z",
      "size": 1024
    },
    {
      "url": "http://example.com/shortened2",
      "original_url": "http://original.com/verylongurl2",
      "timestamp": "2023-01-02T11:00:00Z",
      "size": 2048
    }
  ],
  "total_results": 1000
}
```
```

--------------------------------

### View API Statistics

Source: https://shorteners.grayhatwarfare.com/docs/api/v1/index

Retrieves statistics for the Grayhatwarfare shorteners index, including total URLs and subdomains, and the last update timestamp. Requires an authorization token.

```shell
curl --request GET \
  --url https://shorteners.grayhatwarfare.com/api/v1/stats \
  --header 'Authorization: Bearer {authToken}'
```

--------------------------------

### Retrieve PDF files with regex keywords and no autocorrect (curl)

Source: https://shorteners.grayhatwarfare.com/docs/api/v1/index

Fetches PDF files matching a regular expression for keywords without autocorrecting the query. Requires an authorization token.

```curl
curl --request GET \
  --url 'https://shorteners.grayhatwarfare.com/api/v1/files/0/10?ext=pdf&keywords=.*jun.*&noautocorrect=1' \
  --header 'Authorization: Bearer {authToken}'
```

--------------------------------

### Retrieve and sort PDF files by size (curl)

Source: https://shorteners.grayhatwarfare.com/docs/api/v1/index

Fetches PDF files and sorts them by size in descending order. An authorization token is required.

```curl
curl --request GET \
  --url 'https://shorteners.grayhatwarfare.com/api/v1/files/0/1000?order=size&direction=desc&ext=pdf' \
  --header 'Authorization: Bearer {authToken}'
```

--------------------------------

### Search Subdomains by Keyword (curl)

Source: https://shorteners.grayhatwarfare.com/docs/api/v1/index

Fetches a limited number of subdomains that contain a specific keyword in their names. This allows for targeted searching of subdomains.

```shell
curl --request GET \
  --url 'https://shorteners.grayhatwarfare.com/api/v1/subdomains/0/10?keywords=facebook' \
  --header 'Authorization: Bearer {authToken}'
```

--------------------------------

### Retrieve a specific range of links (curl)

Source: https://shorteners.grayhatwarfare.com/docs/api/v1/index

Fetches a specific range of links, useful for pagination. An authorization token is needed.

```curl
curl --request GET \
  --url https://shorteners.grayhatwarfare.com/api/v1/files/1000/10 \
  --header 'Authorization: Bearer {authToken}'
```

--------------------------------

### Retrieve a range of links (curl)

Source: https://shorteners.grayhatwarfare.com/docs/api/v1/index

Retrieves a specified range of links from the API. An authorization token is required.

```curl
curl --request GET \
  --url https://shorteners.grayhatwarfare.com/api/v1/files/0/10 \
  --header 'Authorization: Bearer {authToken}'
```

--------------------------------

### Regex Autocorrect Behavior Explanation

Source: https://shorteners.grayhatwarfare.com/docs/api/v1/index

Explains how the API automatically adjusts user-provided regular expressions to ensure they match the entire filename. It details the rules for adding `.*` at the beginning and end if they are missing, and how to prevent this auto-correction.

```text
When the regex does not start with `.*` or `^`(=start of string) we add `.*`.
When the regex does not end with `.*` or `$`(=end of string) we add `.*`.
```
Tokens:
Raw