Api Documentation

API (JSON)

Parameters

NameDescriptionRemarkExample
key stringUser API keyRequiredhttps://onstipe.com/web/api/json/Your_Stipe_ID?key=Your_API_Key
Stipe ID intStipe identity numberRequiredhttps://onstipe.com/web/api/json/Your_Stipe_ID?key=Your_API_Key
start intStarting index of post in API response.

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

Optionalhttps://onstipe.com/web/api/json/Your_Stipe_ID?key=Your_API_Key&start=Number
count intTotal number of post in API responseOptionalhttps://onstipe.com/web/api/json/Your_Stipe_ID?key=Your_API_Key&count=Number
min_id intMinimum post ID in API responseOptionalhttps://onstipe.com/web/api/json/Your_Stipe_ID?key=Your_API_Key&min_id=MIN_ID
max_id intMaximum post ID in API responseOptionalhttps://onstipe.com/web/api/json/Your_Stipe_ID?key=Your_API_Key&max_id=MAX_ID

JSON Variables

1stipeStipe detail
2stipe > idStipe identity number
3stipe > nameStipe name
4postsPost detail
5posts > source > idSource identity number
6posts > source > nameSource name
7posts > source > networkSource network name
8posts > idPost identity number
9posts > created_atPost creation timestamp
10posts > linkPost link
11posts > image_urlPost image url
12posts > video_urlPost video url
13posts > titlePost title
14posts > descriptionPost description
15posts > author_namePost author name
16posts > author_usernamePost author username
17posts > author_picturePost author picture
18posts > cta > titlePost CTA title
19posts > cta > urlPost CTA URL
20posts > cta > title_colorPost CTA title color
21posts > cta > bg_colorPost 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

NameDescriptionRemarkExample
key stringUser API keyRequiredhttps://onstipe.com/web/api/xml/Your_Stipe_ID?key=Your_API_Key
Stipe ID intStipe identity numberRequiredhttps://onstipe.com/web/api/xml/Your_Stipe_ID?key=Your_API_Key
start intStarting index of post in API response.

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

Optionalhttps://onstipe.com/web/api/xml/Your_Stipe_ID?key=Your_API_Key&start=Number
count intTotal number of post in API responseOptionalhttps://onstipe.com/web/api/xml/Your_Stipe_ID?key=Your_API_Key&count=Number
min_id intMinimum post ID in API responseOptionalhttps://onstipe.com/web/api/xml/Your_Stipe_ID?key=Your_API_Key&min_id=MIN_ID
max_id intMaximum post ID in API responseOptionalhttps://onstipe.com/web/api/xml/Your_Stipe_ID?key=Your_API_Key&max_id=MAX_ID

XML Variables

1stipeStipe detail
2stipe > idStipe identity number
3stipe > nameStipe name
4postsPost detail
5post > source > idSource identity number
6post > source > nameSource name
7post > source > networkSource network name
8post > idPost identity number
9post > created_atPost creation timestamp
10post > linkPost link
11post > image_urlPost image url
12post > video_urlPost video url
13post > titlePost title
14post > descriptionPost description
15post > author_namePost author name
16post > author_usernamePost author username
17post > author_picturePost author picture
18post > cta > titlePost CTA title
19post > cta > urlPost CTA URL
20post > cta > title_colorPost CTA title color
21post > cta > bg_colorPost 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>