create account

A public API for 3Speak by wehmoen

View this thread on steemit.com
· @wehmoen · (edited)
$26.34
A public API for 3Speak
I wanted to make this post for a good while now to tell you guys about the public API that I built for 3Speak. Finished already months ago it was only today deployed to production. The API allows 3rd party developers to integrate 3Speak content into their own web applications easily. 

**INFO:** The API does not allow 3rd party video uploads at the moment. I am building an oAuth2 integration for 3Speak to allow this kind of implementation in the future. If you are interested get in touch.

---

The base URL for all API requests is:

`https://3speak.online/apiv2/`

### **GET** /leaderboard

Returns the content creator leaderboard of 3Speak as a JSON array.

```
[
  {
    "rank": 1,
    "score": 55,
    "username": "cryptoinvestsvk"
  },
  {
    "rank": 2,
    "score": 42.43,
    "username": "nuoviso"
  },
  {
    "rank": 3,
    "score": 31.26,
    "username": "toufiq777"
  },
  {
    "rank": 4,
    "score": 23.03,
    "username": "clixmoney"
  },
...
```

### **GET** /banned

Returns a list of banned content creators. Append `?details=true` to also retrieve the ban reason.

### **GET** /@:username

##### Parameters

- username

Returns a user profile. If the user is not found an error message is returned instead.

```
{
  "username": "wehmoen",
  "banned": false,
  "canUpload": true,
  "canProxyUpvote": false,
  "isCitizenJournalist": false,
  "hidden": false,
  "verified": true,
  "joined": "2019-05-13T11:13:45.908Z",
  "badges": [
    "alpha_tester",
    "team",
    "deutsch"
  ],
  "subscriber": 52,
  "views": 1278,
  "avatar": "https://v--01-profile-eu-west.3speak.online/79eb80699b3634a68d0f6b047ee159d7.png",
  "cover": "https://v--01-cover-eu-west.3speak.online/79eb80699b3634a68d0f6b047ee159d7.png"
}
```

### **GET** /@:username/:permlink

##### Parameters

- username
- permlink

Returns information about a single video or if the `permlink` is set to `@all` all videos from this user.

```
{
  "created": "2019-12-12T08:35:49.381Z",
  "language": "en",
  "views": 345,
  "author": "wehmoen",
  "likes": 1,
  "permlink": "xrhjxocx",
  "title": "Most Simple Steem Account Creation Tool",
  "duration": 90.3,
  "tags": [
    "steem",
    "onboarding",
    "invite"
  ],
  "images": {
    "thumbnail": "https://img.3speakcontent.online/xrhjxocx/thumbnail.png",
    "poster": "https://img.3speakcontent.online/xrhjxocx/poster.png",
    "post": "https://img.3speakcontent.online/xrhjxocx/post.png"
  },
  "description": "",
  "embed": "<iframe width=\"560\" height=\"315\" src=\"https://3speak.online/embed?v=wehmoen/xrhjxocx\" frameborder=\"0\"  allow=\"accelerometer; autoplay; encrypted-media; gyroscope; picture-in-picture\" allowfullscreen></iframe>"
}
```

### **GET** /statistics

Returns a numbers and global statistics about 3Speak.

``` 
{
  "creators": 967,
  "videos": {
    "count": 10925,
    "size": 6079702568518.25,
    "duration": 7723860.399190438
  },
  "views": 362740,
  "likes": 11746,
  "subscriber": 4285,
  "communities": 12,
  "notifications": 13170,
  "guestAccounts": {
    "comments": 365,
    "user": 1228
  },
  "spk": {
    "transactions": 468
  }
}
```

### **GET** /feeds/trending

Returns the top 100 trending videos as an array.

### **GET** /feeds/new

Returns the latest 100 videos as an array.

👍  , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , and 450 others
👎  , ,
properties (23)
post_id82,972,440
authorwehmoen
permlinka-public-api-for-3speak
categoryhive-100421
json_metadata{"app":"steempeak\/2.2.6","format":"markdown","tags":["hive-100421","api","development"],"users":["all"],"image":["https:\/\/v--01-profile-eu-west.3speak.online\/79eb80699b3634a68d0f6b047ee159d7.png","https:\/\/v--01-cover-eu-west.3speak.online\/79eb80699b3634a68d0f6b047ee159d7.png","https:\/\/img.3speakcontent.online\/xrhjxocx\/thumbnail.png","https:\/\/img.3speakcontent.online\/xrhjxocx\/poster.png","https:\/\/img.3speakcontent.online\/xrhjxocx\/post.png"]}
created2019-12-31 00:37:42
last_update2019-12-31 00:38:48
depth0
children6
net_rshares181,045,484,253,890
last_payout2020-01-07 00:37:42
cashout_time1969-12-31 23:59:59
total_payout_value0.000 SBD
curator_payout_value26.343 SBD
pending_payout_value0.000 SBD
promoted0.000 SBD
body_length3,265
author_reputation65,062,887,486,555
root_title"A public API for 3Speak"
beneficiaries
0.
accountwehmoen
weight10,000
max_accepted_payout1,000,000.000 SBD
percent_steem_dollars10,000
author_curate_reward""
vote details (517)
@c-squared ·
c-squared-comment
<div class="pull-left">https://cdn.steemitimages.com/DQmVHt1f2jqCViLk6dX2SZsajYRWBpmdQA7sQDEbuQBxFB3/c2100.png</div><br>This post was shared in the <a href="https://discord.gg/B8JFmJ4">Curation Collective Discord community</a> for curators, and upvoted and resteemed by the @c-squared community account after manual review.<br/>@c-squared runs a <a href="https://steemit.com/witness/@c-cubed/announcing-the-launch-of-the-new-c-squared-witness">community witness</a>. Please consider using one of your witness votes on us <a href ="https://steemconnect.com/sign/account-witness-vote?witness=c-squared&approve=true">here</a>
properties (22)
post_id82,972,921
authorc-squared
permlink20191231t011226031z
categoryhive-100421
json_metadata{"tags":["c-squared"]}
created2019-12-31 01:12:30
last_update2019-12-31 01:12:30
depth1
children0
net_rshares0
last_payout2020-01-07 01:12:30
cashout_time1969-12-31 23:59:59
total_payout_value0.000 SBD
curator_payout_value0.000 SBD
pending_payout_value0.000 SBD
promoted0.000 SBD
body_length622
author_reputation6,778,148,994,829
root_title"A public API for 3Speak"
beneficiaries[]
max_accepted_payout1,000,000.000 SBD
percent_steem_dollars10,000
@transisto ·
Does that has anything to do with Steem? I don't see how.
properties (22)
post_id82,979,843
authortransisto
permlinkq3dbsb
categoryhive-100421
json_metadata{"app":"steemit\/0.1"}
created2019-12-31 08:33:48
last_update2019-12-31 08:33:48
depth1
children1
net_rshares0
last_payout2020-01-07 08:33:48
cashout_time1969-12-31 23:59:59
total_payout_value0.000 SBD
curator_payout_value0.000 SBD
pending_payout_value0.000 SBD
promoted0.000 SBD
body_length57
author_reputation323,593,656,929,629
root_title"A public API for 3Speak"
beneficiaries[]
max_accepted_payout1,000,000.000 SBD
percent_steem_dollars10,000
@wehmoen ·
No it does not. It is the API for 3Speak. If you are looking for the Steem API docs check this link instead: https://developers.steem.io/
properties (22)
post_id82,980,394
authorwehmoen
permlinkq3dd9u
categoryhive-100421
json_metadata{"links":["https:\/\/developers.steem.io\/"],"app":"steemit\/0.2"}
created2019-12-31 09:05:54
last_update2019-12-31 09:05:54
depth2
children0
net_rshares0
last_payout2020-01-07 09:05:54
cashout_time1969-12-31 23:59:59
total_payout_value0.000 SBD
curator_payout_value0.000 SBD
pending_payout_value0.000 SBD
promoted0.000 SBD
body_length137
author_reputation65,062,887,486,555
root_title"A public API for 3Speak"
beneficiaries[]
max_accepted_payout1,000,000.000 SBD
percent_steem_dollars10,000
@eng.ramy ·
check my new website
https://www.viraltodo.com/
properties (22)
post_id83,000,590
authoreng.ramy
permlinkq3et1p
categoryhive-100421
json_metadata{"links":["https:\/\/www.viraltodo.com\/"],"app":"steemit\/0.1"}
created2020-01-01 03:44:15
last_update2020-01-01 03:44:15
depth1
children0
net_rshares0
last_payout2020-01-08 03:44:15
cashout_time1969-12-31 23:59:59
total_payout_value0.000 SBD
curator_payout_value0.000 SBD
pending_payout_value0.000 SBD
promoted0.000 SBD
body_length47
author_reputation426,579,518,801
root_title"A public API for 3Speak"
beneficiaries[]
max_accepted_payout1,000,000.000 SBD
percent_steem_dollars10,000
@ozannn ·
Happy new year 🎆🎊🎈 

Posted using [Partiko iOS](https://partiko.app/referral/ozannn)
properties (22)
post_id83,008,359
authorozannn
permlinkozannn-re-wehmoen-a-public-api-for-3speak-20200101t122001760z
categoryhive-100421
json_metadata{"app":"partiko","client":"ios"}
created2020-01-01 12:20:03
last_update2020-01-01 12:20:03
depth1
children0
net_rshares0
last_payout2020-01-08 12:20:03
cashout_time1969-12-31 23:59:59
total_payout_value0.000 SBD
curator_payout_value0.000 SBD
pending_payout_value0.000 SBD
promoted0.000 SBD
body_length84
author_reputation141,615,604,692
root_title"A public API for 3Speak"
beneficiaries[]
max_accepted_payout1,000,000.000 SBD
percent_steem_dollars10,000
@arcange ·
Congratulations @wehmoen!
Your post was mentioned in the [Steem Hit Parade](/hit-parade/@arcange/daily-hit-parade-20191231) in the following category:

* Pending payout - Ranked 3 with $ 48,66
properties (22)
post_id83,013,077
authorarcange
permlinkre-a-public-api-for-3speak-20191231t165116000z
categoryhive-100421
json_metadata{}
created2020-01-01 15:53:42
last_update2020-01-01 15:53:42
depth1
children0
net_rshares0
last_payout2020-01-08 15:53:42
cashout_time1969-12-31 23:59:59
total_payout_value0.000 SBD
curator_payout_value0.000 SBD
pending_payout_value0.000 SBD
promoted0.000 SBD
body_length193
author_reputation201,578,609,200,360
root_title"A public API for 3Speak"
beneficiaries[]
max_accepted_payout1,000,000.000 SBD
percent_steem_dollars10,000