LBRYCommunity/spee.ch
1
0
Fork 0
Code Issues 95 Pull requests 2 Projects Releases 4 Packages Wiki Activity

updated readme with publish response

Browse source
This commit is contained in:
bill bittner 2018-08-10 15:13:35 -07:00
parent 855eb38203
commit e8a7dd75d2
1 changed files with 65 additions and 22 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

87
README.md
View file

@ -60,28 +60,71 @@ check out the [customization guide](https://github.com/lbryio/spee.ch/blob/readm
* This is not necessary, but highly reccomended. It will decode the blocks of the `LBRY` blockchain and add the claims information to your database's tables * This is not necessary, but highly reccomended. It will decode the blocks of the `LBRY` blockchain and add the claims information to your database's tables
## API ## API
* _(post)_ /api/claim/publish #### /api/claim/publish (post)
* example: `curl -F 'name=MyPictureName' -F 'file=@/path/to/myPicture.jpeg' https://spee.ch/api/claim/publish` example:
* Parameters: ```
* `name` (required) curl -F 'name=MyPictureName' -F 'file=@/path/to/myPicture.jpeg' https://spee.ch/api/claim/publish
* `file` (required) (must be type .mp4, .jpeg, .jpg, .gif, or .png) ```
* `nsfw` (optional) Parameters:
* `license` (optional)
* `title` (optional) * `name` (required)
* `description` (optional) * `file` (required) (must be type .mp4, .jpeg, .jpg, .gif, or .png)
* `thumbnail` url to thumbnail image, for .mp4 uploads only (optional) * `nsfw` (optional)
* `channelName` channel to publish too (optional) * `license` (optional)
* `channelPassword` password for channel to publish too (optional, but required if `channelName` is provided) * `title` (optional)
* _(get)_ /api/claim/resolve/:name/:claimId * `description` (optional)
* example: `curl https://spee.ch/api/claim/resolve/doitlive/xyz` * `thumbnail` url to thumbnail image, for .mp4 uploads only (optional)
* _(get)_ /api/claim/list/:name * `channelName` channel to publish too (optional)
* example: `curl https://spee.ch/api/claim/list/doitlive` * `channelPassword` password for channel to publish too (optional, but required if `channelName` is provided)
* _(get)_ /api/claim/availability/:name
* returns the name if it is available response:
* example: `curl https://spee.ch/api/claim/availability/doitlive` ```
* _(get)_ /api/channel/availability/:name {
* returns the name if it is available "success": <bool>,
* example: `curl https://spee.ch/api/channel/availability/@CoolChannel` "message": <string>,
"data": {
"name": <string>,
"claimId": <string>,
"url": <string>,
"showUrl": <string>,
"serveUrl": <string>,
"lbryTx": {
"claim_address": <string>,
"claim_id": <string>,
"fee": <number>,
"nout": <number>,
"tx": <string>,
"value": <number>
}
}
}
```
#### /api/claim/resolve/:name/:claimId (get)
example:
```
curl https://spee.ch/api/claim/resolve/doitlive/xyz
```
#### /api/claim/list/:name (get)
example:
```
curl https://spee.ch/api/claim/list/doitlive
```
#### /api/claim/availability/:name (get)
example:
```
curl https://spee.ch/api/claim/availability/doitlive
```
returns the name if it is available
#### /api/channel/availability/:name (get)
example:
```
curl https://spee.ch/api/channel/availability/@CoolChannel
```
returns the name if it is available
## Contribute ## Contribute