diff --git a/docs/index.html b/docs/index.html index 41bf3ef..c9bc11c 100644 --- a/docs/index.html +++ b/docs/index.html @@ -15,10 +15,10 @@ +.sc-gwVKww {} .jtxFSh{position:absolute;left:20px;height:1.8em;width:0.9em;} .jtxFSh path{fill:primary:#333333;secondary:#808080;} -

Lighthouse (0.0.1)

Download OpenAPI specification:Download

LBRY Inc: filip@lbry.io URL: https://lbry.io License: MIT

Lighthouse is a search engine for the LBRY blockchain based on elasticsearch, chainquery and Node.JS.

-

Search API

Returns all the searches matching the search query

Returns all the searches matching the search query.

-
query Parameters
s
required
string

The search text

-
channel
string

The channel to search, if none, will return all search results

-
size
integer

The amount of results to return at max

-
from
integer

The number to start from, good for pagination

-
nsfw
boolean

If search should return nsfw content or not.

-

Responses

200

The search API returns an array of the found matching search items.

-
get /search
https://lighthouse.lbry.io/search

Response samples

application/json
Copy
Expand all Collapse all
[
  • {
    }
]

Autocomplete API

Returns an array of autocompleted strings.

Returns an array of autocompleted strings.

-
query Parameters
s
required
string

The string to be autocompleted.

-

Responses

200

The autocomplete API returns an array of the found matching autocompleted strings.

-
get /autocomplete
https://lighthouse.lbry.io/autocomplete

Response samples

application/json
Copy
Expand all Collapse all
[
  • "lbryisawesome"
]

Status API

Returns the current status of the lighthouse insta

Returns the current status of the lighthouse instance.

-

Responses

200

Returns the current status of the lighthouse instance.

-
get /status
https://lighthouse.lbry.io/status

Response samples

application/json
Copy
Expand all Collapse all
{
  • "spaceUsed": "632.3MB",
  • "claimsInIndex": 97615085,
  • "totSearches": 100000
}
+ " fill="currentColor">

Lighthouse (0.0.1)

Download OpenAPI specification:Download

LBRY Inc: filip@lbry.io URL: https://lbry.io License: MIT

Lighthouse is a search engine for the LBRY blockchain based on elasticsearch, chainquery and Node.JS.

+

Search API

Returns all the searches matching the search query

Returns all the searches matching the search query.

+
query Parameters
s
required
string

The search text

+
channel
string

The channel to search, if none, will return all search results

+
size
integer

The amount of results to return at max

+
from
integer

The number to start from, good for pagination

+
nsfw
boolean

If search should return nsfw content or not.

+
contentType
string

Filter by MIME type.

+
mediaType
string

Filter by media type, can be audio, video, image, application, text or cad.

+
claimType
string

Return channels or files only, value can be 'channel' or 'file'.

+

Responses

200

The search API returns an array of the found matching search items.

+
get /search
https://lighthouse.lbry.io/search

Response samples

application/json
Copy
Expand all Collapse all
[
  • {
    }
]

Autocomplete API

Returns an array of autocompleted strings.

Returns an array of autocompleted strings.

+
query Parameters
s
required
string

The string to be autocompleted.

+

Responses

200

The autocomplete API returns an array of the found matching autocompleted strings.

+
get /autocomplete
https://lighthouse.lbry.io/autocomplete

Response samples

application/json
Copy
Expand all Collapse all
[
  • "lbryisawesome"
]

Status API

Returns the current status of the lighthouse insta

Returns the current status of the lighthouse instance.

+

Responses

200

Returns the current status of the lighthouse instance.

+
get /status
https://lighthouse.lbry.io/status

Response samples

application/json
Copy
Expand all Collapse all
{
  • "spaceUsed": "632.3MB",
  • "claimsInIndex": 97615085,
  • "totSearches": 100000
}