Api Documentation

API (JSON)

Parameters

Name Description Remark Example
key string User API key Required https://onstipe.com/web/api/json/Your_Stipe_ID?key=Your_API_Key
Stipe ID int Stipe identity number Required https://onstipe.com/web/api/json/Your_Stipe_ID?key=Your_API_Key
start int Starting index of post in API response.

Description: start=0&count=4 (get 4 posts from starting), start=10&count=6 (get 11-16 posts)

 Optional https://onstipe.com/web/api/json/Your_Stipe_ID?key=Your_API_Key&start=Number
count int Total number of post in API response Optional https://onstipe.com/web/api/json/Your_Stipe_ID?key=Your_API_Key&count=Number
min_id int Minimum post ID in API response Optional https://onstipe.com/web/api/json/Your_Stipe_ID?key=Your_API_Key&min_id=MIN_ID
max_id int Maximum post ID in API response Optional https://onstipe.com/web/api/json/Your_Stipe_ID?key=Your_API_Key&max_id=MAX_ID

JSON Variables

1 stipe Stipe detail
2 stipe > id Stipe identity number
3 stipe > name Stipe name
4 posts Post detail
5 posts > source > id Source identity number
6 posts > source > name Source name
7 posts > source > network Source network name
8 posts > id Post identity number
9 posts > created_at Post creation timestamp
10 posts > link Post link
11 posts > image_url Post image url
12 posts > video_url Post video url
13 posts > title Post title
14 posts > description Post description
15 posts > author_name Post author name
16 posts > author_username Post author username
17 posts > author_picture Post author picture
18 posts > cta > title Post CTA title
19 posts > cta > url Post CTA URL
20 posts > cta > title_color Post CTA title color
21 posts > cta > bg_color Post CTA background color

Sample API(JSON) Response

{
"stipe": {
"id": "77",
"name": "Fashion Lover"
},
"posts": [
{
"source": {
"id": "83",
"name": "fashion",
"network": "Twitter"
},
"id": "1375",
"created_at": "1602786957",
"link": "https:\/\/twitter.com\/Ticoshea125\/statuses\/1316810057625269854",
"image_url": "https:\/\/pbs.twimg.com\/media\/IXsAUunw6b0.jpg",
"video_url": false,
"title": null,
"description": "#hair #cut of Smith is in the #latest #fashion",
"author_name": "Ticoshea",
"author_username": "Ticoshea125",
"author_picture": "https:\/\/pbs.twimg.com\/profile_images\/kg_normal.jpg",
"cta": null
},
.
.
.
{
"source": {
"id": "83",
"name": "fashion",
"network": "Twitter"
},
"id": "1376",
"created_at": "1602786639",
"link": "https:\/\/twitter.com\/Hempthio\/statuses\/1316802327782775104",
"image_url": "https:\/\/pbs.twimg.com\/media\/EkjSWkAhmQIp8.jpg",
"video_url": false,
"title": null,
"description": "#clothing #footwear #makeup #lifestyle belongs to #fashion",
"author_name": "Hempthio Sears",
"author_username": "Hempthio",
"author_picture": "https:\/\/pbs.twimg.com\/profile_images\/og_normal.jpg",
"cta": null
}
]
}

API (XML)

Parameters

Name Description Remark Example
key string User API key Required https://onstipe.com/web/api/xml/Your_Stipe_ID?key=Your_API_Key
Stipe ID int Stipe identity number Required https://onstipe.com/web/api/xml/Your_Stipe_ID?key=Your_API_Key
start int Starting index of post in API response.

Description: start=0&count=4 (get 4 posts from starting), start=10&count=6 (get 11-16 posts)

 Optional https://onstipe.com/web/api/xml/Your_Stipe_ID?key=Your_API_Key&start=Number
count int Total number of post in API response Optional https://onstipe.com/web/api/xml/Your_Stipe_ID?key=Your_API_Key&count=Number
min_id int Minimum post ID in API response Optional https://onstipe.com/web/api/xml/Your_Stipe_ID?key=Your_API_Key&min_id=MIN_ID
max_id int Maximum post ID in API response Optional https://onstipe.com/web/api/xml/Your_Stipe_ID?key=Your_API_Key&max_id=MAX_ID

XML Variables

1 stipe Stipe detail
2 stipe > id Stipe identity number
3 stipe > name Stipe name
4 posts Post detail
5 post > source > id Source identity number
6 post > source > name Source name
7 post > source > network Source network name
8 post > id Post identity number
9 post > created_at Post creation timestamp
10 post > link Post link
11 post > image_url Post image url
12 post > video_url Post video url
13 post > title Post title
14 post > description Post description
15 post > author_name Post author name
16 post > author_username Post author username
17 post > author_picture Post author picture
18 post > cta > title Post CTA title
19 post > cta > url Post CTA URL
20 post > cta > title_color Post CTA title color
21 post > cta > bg_color Post CTA background color

Sample API(XML) Response

<data>
<stipe>
<id>77</id>  
<name>Fashion Lover</name>
</stipe>
<posts>
<post>
<source>
<id>83</id>
<name>fashion</name>
<network>Twitter</network>
</source>
<id>1375</id>
<created_at>1602786957</created_at>
<link>https://twitter.com/Ticoshea125/statuses/1316810057625269854</link>
<image_url>https://pbs.twimg.com/media/IXsAUunw6b0.jpg</image_url>
<video_url/>
<title/>
<description>#hair #cut of Smith is in the #latest #fashion</description>
<author_name>Ticoshea</author_name>
<author_username>Ticoshea125</author_username>
<author_picture>https://pbs.twimg.com/profile_images/kg_normal.jpg</author_picture>
<cta/>
</post>
.
.
.
<post>
<source>
<id>83</id>
<name>fashion</name>
<network>Twitter</network>
</source>
<id>1376</id>
<created_at>1602786639</created_at>
<link>https://twitter.com/Hempthio/statuses/1316802327782775104</link>
<image_url>https://pbs.twimg.com/media/EkjSWkAhmQIp8.jpg</image_url>
<video_url/> 
<title/>
<description>#clothing #footwear #makeup #lifestyle belongs to #fashion </description>
<author_name>Hempthio Sears</author_name>
<author_username>Hempthio</author_username>
<author_picture>https://pbs.twimg.com/profile_images/og_normal.jpg</author_picture>
<cta/>
</post>
</posts>
</data>