{"openapi":"3.1.0","info":{"title":"Apizie","version":"2.0.0","description":"One API key, one envelope, many public data sources."},"servers":[{"url":"https://zieapi.vercel.app"}],"security":[{"ApiKeyAuth":[]}],"paths":{"/v1/social-media:instagram/get-locations-search":{"get":{"operationId":"social_media_instagram_get_locations_search","summary":"Search for a location by geographic coordinate.","description":"GET /locations/search","tags":["social-media"],"parameters":[{"name":"distance","in":"query","required":false,"description":"Default is 1000m (distance=1000), max distance is 5000.","schema":{"type":"integer","description":"Default is 1000m (distance=1000), max distance is 5000."}},{"name":"facebook_places_id","in":"query","required":false,"description":"Returns a location mapped off of a Facebook places id. If used, a Foursquare id and `lat`, `lng` are not required.","schema":{"type":"string","description":"Returns a location mapped off of a Facebook places id. If used, a Foursquare id and `lat`, `lng` are not required."}},{"name":"foursquare_id","in":"query","required":false,"description":"Returns a location mapped off of a foursquare v1 api location id. If used, you are not required to use `lat` and `lng`. Note that this…","schema":{"type":"string","description":"Returns a location mapped off of a foursquare v1 api location id. If used, you are not required to use `lat` and `lng`. Note that this…"}},{"name":"lat","in":"query","required":false,"description":"Latitude of the center search coordinate. If used, `lng` is required.","schema":{"type":"number","description":"Latitude of the center search coordinate. If used, `lng` is required."}},{"name":"lng","in":"query","required":false,"description":"Longitude of the center search coordinate. If used, `lat` is required.","schema":{"type":"number","description":"Longitude of the center search coordinate. If used, `lat` is required."}},{"name":"foursquare_v2_id","in":"query","required":false,"description":"Returns a location mapped off of a foursquare v2 api location id. If used, you are not required to use `lat` and `lng`.","schema":{"type":"string","description":"Returns a location mapped off of a foursquare v2 api location id. If used, you are not required to use `lat` and `lng`."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/social-media:instagram/get-locations-location-id":{"get":{"operationId":"social_media_instagram_get_locations_location_id","summary":"Get information about a location.","description":"GET /locations/{location-id}","tags":["social-media"],"parameters":[{"name":"location-id","in":"query","required":true,"description":"The location ID.","schema":{"type":"string","description":"The location ID."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/social-media:instagram/get-locations-location-id-media-recent":{"get":{"operationId":"social_media_instagram_get_locations_location_id_media_recent","summary":"Get a list of recent media objects from a given location.","description":"GET /locations/{location-id}/media/recent","tags":["social-media"],"parameters":[{"name":"location-id","in":"query","required":true,"description":"The location ID.","schema":{"type":"string","description":"The location ID."}},{"name":"min_timestamp","in":"query","required":false,"description":"Return media after this UNIX timestamp.","schema":{"type":"integer","description":"Return media after this UNIX timestamp."}},{"name":"max_timestamp","in":"query","required":false,"description":"Return media before this UNIX timestamp.","schema":{"type":"integer","description":"Return media before this UNIX timestamp."}},{"name":"min_id","in":"query","required":false,"description":"Return media before this `min_id`.","schema":{"type":"string","description":"Return media before this `min_id`."}},{"name":"max_id","in":"query","required":false,"description":"Return media after this `max_id`.","schema":{"type":"string","description":"Return media after this `max_id`."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/social-media:instagram/get-media-search":{"get":{"operationId":"social_media_instagram_get_media_search","summary":"Search for media in a given area.","description":"GET /media/search","tags":["social-media"],"parameters":[{"name":"lat","in":"query","required":true,"description":"Latitude of the center search coordinate. If used, `lng` is required.","schema":{"type":"number","description":"Latitude of the center search coordinate. If used, `lng` is required."}},{"name":"lng","in":"query","required":true,"description":"Longitude of the center search coordinate. If used, `lat` is required.","schema":{"type":"number","description":"Longitude of the center search coordinate. If used, `lat` is required."}},{"name":"min_timestamp","in":"query","required":false,"description":"A unix timestamp. All media returned will be taken later than this timestamp.","schema":{"type":"integer","description":"A unix timestamp. All media returned will be taken later than this timestamp."}},{"name":"max_timestamp","in":"query","required":false,"description":"A unix timestamp. All media returned will be taken earlier than this timestamp.","schema":{"type":"integer","description":"A unix timestamp. All media returned will be taken earlier than this timestamp."}},{"name":"distance","in":"query","required":false,"description":"Default is 1km (distance=1000), max distance is 5km.","schema":{"type":"integer","description":"Default is 1km (distance=1000), max distance is 5km."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/social-media:instagram/get-media-shortcode-shortcode":{"get":{"operationId":"social_media_instagram_get_media_shortcode_shortcode","summary":"Get information about a media object.","description":"GET /media/shortcode/{shortcode}","tags":["social-media"],"parameters":[{"name":"shortcode","in":"query","required":true,"description":"The short code of the media resource.","schema":{"type":"string","description":"The short code of the media resource."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/social-media:instagram/get-media-media-id":{"get":{"operationId":"social_media_instagram_get_media_media_id","summary":"Get information about a media object.","description":"GET /media/{media-id}","tags":["social-media"],"parameters":[{"name":"media-id","in":"query","required":true,"description":"The ID of the media resource.","schema":{"type":"string","description":"The ID of the media resource."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/social-media:instagram/get-media-media-id-comments":{"get":{"operationId":"social_media_instagram_get_media_media_id_comments","summary":"Get a list of recent comments on a media object.","description":"GET /media/{media-id}/comments","tags":["social-media"],"parameters":[{"name":"media-id","in":"query","required":true,"description":"The ID of the media resource.","schema":{"type":"string","description":"The ID of the media resource."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/social-media:instagram/post-media-media-id-comments":{"post":{"operationId":"social_media_instagram_post_media_media_id_comments","summary":"Create a comment on a media object.","description":"POST /media/{media-id}/comments","tags":["social-media"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["media-id","text"],"properties":{"media-id":{"type":"string","description":"The ID of the media resource."},"text":{"type":"string","description":"Text to post as a comment on the media object as specified in `media-id`."}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/social-media:instagram/delete-media-media-id-comments-comment-id":{"post":{"operationId":"social_media_instagram_delete_media_media_id_comments_comment_id","summary":"Remove a comment.","description":"DELETE /media/{media-id}/comments/{comment-id}","tags":["social-media"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["media-id","comment-id"],"properties":{"media-id":{"type":"string","description":"The ID of the media resource."},"comment-id":{"type":"string","description":"The ID of the comment entry."}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/social-media:instagram/get-media-media-id-likes":{"get":{"operationId":"social_media_instagram_get_media_media_id_likes","summary":"Get a list of users who have liked this media.","description":"GET /media/{media-id}/likes","tags":["social-media"],"parameters":[{"name":"media-id","in":"query","required":true,"description":"The ID of the media resource.","schema":{"type":"string","description":"The ID of the media resource."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/social-media:instagram/post-media-media-id-likes":{"post":{"operationId":"social_media_instagram_post_media_media_id_likes","summary":"Set a like on this media by the current user.","description":"POST /media/{media-id}/likes","tags":["social-media"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["media-id"],"properties":{"media-id":{"type":"string","description":"The ID of the media resource."}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/social-media:instagram/delete-media-media-id-likes":{"post":{"operationId":"social_media_instagram_delete_media_media_id_likes","summary":"Remove a like on this media by the current user.","description":"DELETE /media/{media-id}/likes","tags":["social-media"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["media-id"],"properties":{"media-id":{"type":"string","description":"The ID of the media resource."}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/social-media:instagram/get-tags-search":{"get":{"operationId":"social_media_instagram_get_tags_search","summary":"Search for tags by name.","description":"GET /tags/search","tags":["social-media"],"parameters":[{"name":"q","in":"query","required":true,"description":"A valid tag name without a leading \\#. (eg. snowy, nofilter)","schema":{"type":"string","description":"A valid tag name without a leading \\#. (eg. snowy, nofilter)"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/social-media:instagram/get-tags-tag-name":{"get":{"operationId":"social_media_instagram_get_tags_tag_name","summary":"Get information about a tag object.","description":"GET /tags/{tag-name}","tags":["social-media"],"parameters":[{"name":"tag-name","in":"query","required":true,"description":"The tag name.","schema":{"type":"string","description":"The tag name."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/social-media:instagram/get-tags-tag-name-media-recent":{"get":{"operationId":"social_media_instagram_get_tags_tag_name_media_recent","summary":"Get a list of recently tagged media.","description":"GET /tags/{tag-name}/media/recent","tags":["social-media"],"parameters":[{"name":"tag-name","in":"query","required":true,"description":"The tag name.","schema":{"type":"string","description":"The tag name."}},{"name":"count","in":"query","required":false,"description":"Count of tagged media to return.","schema":{"type":"integer","description":"Count of tagged media to return."}},{"name":"min_tag_id","in":"query","required":false,"description":"Return media before this `min_tag_id`.","schema":{"type":"string","description":"Return media before this `min_tag_id`."}},{"name":"max_tag_id","in":"query","required":false,"description":"Return media after this `max_tag_id`.","schema":{"type":"string","description":"Return media after this `max_tag_id`."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/social-media:instagram/get-users-search":{"get":{"operationId":"social_media_instagram_get_users_search","summary":"Search for a user by name.","description":"GET /users/search","tags":["social-media"],"parameters":[{"name":"q","in":"query","required":true,"description":"A query string.","schema":{"type":"string","description":"A query string."}},{"name":"count","in":"query","required":false,"description":"Number of users to return.","schema":{"type":"integer","description":"Number of users to return."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/social-media:instagram/get-users-self-media-liked":{"get":{"operationId":"social_media_instagram_get_users_self_media_liked","summary":"See the list of media liked by the authenticated user.","description":"GET /users/self/media/liked","tags":["social-media"],"parameters":[{"name":"count","in":"query","required":false,"description":"Count of media to return.","schema":{"type":"integer","description":"Count of media to return."}},{"name":"max_like_id","in":"query","required":false,"description":"Return media liked before this id.","schema":{"type":"string","description":"Return media liked before this id."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/social-media:instagram/get-users-self-requested-by":{"get":{"operationId":"social_media_instagram_get_users_self_requested_by","summary":"List the users who have requested this user's permission to follow.","description":"GET /users/self/requested-by","tags":["social-media"],"parameters":[],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/social-media:instagram/get-users-user-id":{"get":{"operationId":"social_media_instagram_get_users_user_id","summary":"Get basic information about a user.","description":"GET /users/{user-id}","tags":["social-media"],"parameters":[{"name":"user-id","in":"query","required":true,"description":"The ID of a user to get information about, or **self** to retrieve information about authenticated user.","schema":{"type":"string","description":"The ID of a user to get information about, or **self** to retrieve information about authenticated user."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/social-media:instagram/get-users-user-id-followed-by":{"get":{"operationId":"social_media_instagram_get_users_user_id_followed_by","summary":"Get the list of users this user is followed by.","description":"GET /users/{user-id}/followed-by","tags":["social-media"],"parameters":[{"name":"user-id","in":"query","required":true,"description":"The ID of a user, or **self** to retrieve information about authenticated user.","schema":{"type":"string","description":"The ID of a user, or **self** to retrieve information about authenticated user."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/social-media:instagram/get-users-user-id-follows":{"get":{"operationId":"social_media_instagram_get_users_user_id_follows","summary":"Get the list of users this user follows.","description":"GET /users/{user-id}/follows","tags":["social-media"],"parameters":[{"name":"user-id","in":"query","required":true,"description":"The ID of a user, or **self** to retrieve information about authenticated user.","schema":{"type":"string","description":"The ID of a user, or **self** to retrieve information about authenticated user."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/social-media:instagram/get-users-user-id-media-recent":{"get":{"operationId":"social_media_instagram_get_users_user_id_media_recent","summary":"Get the most recent media published by a user.","description":"GET /users/{user-id}/media/recent","tags":["social-media"],"parameters":[{"name":"user-id","in":"query","required":true,"description":"The ID of a user to get recent media of, or **self** to retrieve media of authenticated user.","schema":{"type":"string","description":"The ID of a user to get recent media of, or **self** to retrieve media of authenticated user."}},{"name":"count","in":"query","required":false,"description":"Count of media to return.","schema":{"type":"integer","description":"Count of media to return."}},{"name":"max_timestamp","in":"query","required":false,"description":"Return media before this UNIX timestamp.","schema":{"type":"integer","description":"Return media before this UNIX timestamp."}},{"name":"min_timestamp","in":"query","required":false,"description":"Return media after this UNIX timestamp.","schema":{"type":"integer","description":"Return media after this UNIX timestamp."}},{"name":"min_id","in":"query","required":false,"description":"Return media later than this `min_id`.","schema":{"type":"string","description":"Return media later than this `min_id`."}},{"name":"max_id","in":"query","required":false,"description":"Return media earlier than this `max_id`.","schema":{"type":"string","description":"Return media earlier than this `max_id`."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/social-media:instagram/get-users-user-id-relationship":{"get":{"operationId":"social_media_instagram_get_users_user_id_relationship","summary":"Get information about a relationship to another user.","description":"GET /users/{user-id}/relationship","tags":["social-media"],"parameters":[{"name":"user-id","in":"query","required":true,"description":"The ID of a user to get information about.","schema":{"type":"string","description":"The ID of a user to get information about."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/social-media:instagram/post-users-user-id-relationship":{"post":{"operationId":"social_media_instagram_post_users_user_id_relationship","summary":"Modify the relationship between the current user and the target user.","description":"POST /users/{user-id}/relationship","tags":["social-media"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["user-id","action"],"properties":{"user-id":{"type":"string","description":"The ID of the target user."},"action":{"type":"string","enum":["follow","unfollow","block","unblock","approve","ignore"],"description":"Type of action to apply for relationship with the user."}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}}},"components":{"securitySchemes":{"ApiKeyAuth":{"type":"apiKey","in":"header","name":"x-api-key"}},"schemas":{"RunEnvelope":{"type":"object","required":["project","data","timestamp"],"properties":{"project":{"type":"string","example":"dev-tools:hash"},"data":{},"timestamp":{"type":"string","format":"date-time"}}},"ErrorEnvelope":{"type":"object","properties":{"content":{},"message":{"type":"string"},"errors":{"type":"array","items":{}},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"}}}}}},"responses":{"Error":{"description":"Invalid key, plan gate, rate limit or upstream failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}}}}