modified_trueway-places.json•17.9 kB
{
"openapi": "3.0.1",
"info": {
"title": "TrueWay Places API V1",
"description": "Search for places with details information",
"contact": {
"name": "TrueWay Team",
"url": "https://truewayapi.com/",
"email": "trueway@usa.com"
},
"version": "v1"
},
"servers": [
{
"url": "http://api.magicapi.dev/api/v1/trueway/places"
}
],
"paths": {
"trueway/places/PlacesService/FindPlaceByText": {
"get": {
"tags": [
"PlacesService"
],
"summary": "Search for places by text",
"description": "Search for places by text string",
"parameters": [
{
"name": "text",
"in": "query",
"description": "A text string on which to search",
"required": true,
"schema": {
"type": "string"
},
"example": "Children's Creativity Museum"
},
{
"name": "language",
"in": "query",
"description": "The two-letter language code in which to return results (ISO 639-1)",
"schema": {
"type": "string"
},
"example": "en"
},
{
"name": "bounds",
"in": "query",
"description": "The bounding box for results preference. Format: south,west,north,east. Coordinates: decimal degrees.",
"schema": {
"type": "string"
},
"example": "-90.0,-180.0,90.0,180.0"
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"required": [
"results"
],
"type": "object",
"properties": {
"results": {
"type": "array",
"items": {
"required": [
"id",
"location"
],
"type": "object",
"properties": {
"id": {
"maxLength": 32,
"minLength": 32,
"type": "string",
"description": "Unique place identifier"
},
"name": {
"type": "string",
"description": "Name of place",
"nullable": true
},
"address": {
"type": "string",
"description": "Street address",
"nullable": true
},
"phone_number": {
"type": "string",
"description": "Phone number",
"nullable": true
},
"website": {
"type": "string",
"description": "Place website",
"nullable": true
},
"location": {
"type": "object",
"properties": {
"lat": {
"type": "number",
"format": "double"
},
"lng": {
"type": "number",
"format": "double"
}
},
"additionalProperties": false
},
"types": {
"type": "array",
"items": {
"type": "string"
},
"description": "Place types",
"nullable": true
},
"distance": {
"type": "integer",
"description": "Distance to the place (meters). For nearby search only.",
"format": "int32",
"nullable": true
}
},
"additionalProperties": false
},
"description": "Searching results array"
}
},
"additionalProperties": false
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"required": [
"error"
],
"type": "object",
"properties": {
"error": {
"type": "string"
},
"message": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
}
}
}
},
"500": {
"description": "Server Error",
"content": {
"application/json": {
"schema": {
"required": [
"error"
],
"type": "object",
"properties": {
"error": {
"type": "string"
},
"message": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
}
}
}
}
}
},
"parameters": [
{
"description": "API.market API Key",
"in": "header",
"name": "x-magicapi-key",
"value": "clp7flnx6000j3pifm3pinw92",
"required": true,
"schema": {
"type": "string"
}
}
]
},
"trueway/places/PlacesService/FindPlacesNearby": {
"get": {
"tags": [
"PlacesService"
],
"summary": "Search for nearby places",
"description": "Search for places around location within a specified radius.",
"parameters": [
{
"name": "location",
"in": "query",
"description": "The latitude/longitude around which to retrieve places",
"required": true,
"schema": {
"type": "string"
},
"example": "37.783366,-122.402325"
},
{
"name": "radius",
"in": "query",
"description": "The distance (in meters) within which to return results. Max = 10000 m.",
"schema": {
"type": "integer",
"format": "int32",
"default": 10000
},
"example": 180
},
{
"name": "type",
"in": "query",
"description": "The type of places that are returned",
"schema": {
"type": "string"
},
"example": "cafe"
},
{
"name": "language",
"in": "query",
"description": "The two-letter language code in which to return results (ISO 639-1)",
"schema": {
"type": "string"
},
"example": "en"
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"required": [
"results"
],
"type": "object",
"properties": {
"results": {
"type": "array",
"items": {
"required": [
"id",
"location"
],
"type": "object",
"properties": {
"id": {
"maxLength": 32,
"minLength": 32,
"type": "string",
"description": "Unique place identifier"
},
"name": {
"type": "string",
"description": "Name of place",
"nullable": true
},
"address": {
"type": "string",
"description": "Street address",
"nullable": true
},
"phone_number": {
"type": "string",
"description": "Phone number",
"nullable": true
},
"website": {
"type": "string",
"description": "Place website",
"nullable": true
},
"location": {
"type": "object",
"properties": {
"lat": {
"type": "number",
"format": "double"
},
"lng": {
"type": "number",
"format": "double"
}
},
"additionalProperties": false
},
"types": {
"type": "array",
"items": {
"type": "string"
},
"description": "Place types",
"nullable": true
},
"distance": {
"type": "integer",
"description": "Distance to the place (meters). For nearby search only.",
"format": "int32",
"nullable": true
}
},
"additionalProperties": false
},
"description": "Searching results array"
}
},
"additionalProperties": false
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"required": [
"error"
],
"type": "object",
"properties": {
"error": {
"type": "string"
},
"message": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
}
}
}
},
"500": {
"description": "Server Error",
"content": {
"application/json": {
"schema": {
"required": [
"error"
],
"type": "object",
"properties": {
"error": {
"type": "string"
},
"message": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
}
}
}
}
}
},
"parameters": [
{
"description": "API.market API Key",
"in": "header",
"name": "x-magicapi-key",
"value": "clp7flnx6000j3pifm3pinw92",
"required": true,
"schema": {
"type": "string"
}
}
]
}
},
"components": {
"schemas": {
"FaultResponse": {
"required": [
"error"
],
"type": "object",
"properties": {
"error": {
"type": "string"
},
"message": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"Location": {
"type": "object",
"properties": {
"lat": {
"type": "number",
"format": "double"
},
"lng": {
"type": "number",
"format": "double"
}
},
"additionalProperties": false
},
"Place": {
"required": [
"id",
"location"
],
"type": "object",
"properties": {
"id": {
"maxLength": 32,
"minLength": 32,
"type": "string",
"description": "Unique place identifier"
},
"name": {
"type": "string",
"description": "Name of place",
"nullable": true
},
"address": {
"type": "string",
"description": "Street address",
"nullable": true
},
"phone_number": {
"type": "string",
"description": "Phone number",
"nullable": true
},
"website": {
"type": "string",
"description": "Place website",
"nullable": true
},
"location": {
"type": "object",
"properties": {
"lat": {
"type": "number",
"format": "double"
},
"lng": {
"type": "number",
"format": "double"
}
},
"additionalProperties": false
},
"types": {
"type": "array",
"items": {
"type": "string"
},
"description": "Place types",
"nullable": true
},
"distance": {
"type": "integer",
"description": "Distance to the place (meters). For nearby search only.",
"format": "int32",
"nullable": true
}
},
"additionalProperties": false
},
"PlacesResponse": {
"required": [
"results"
],
"type": "object",
"properties": {
"results": {
"type": "array",
"items": {
"required": [
"id",
"location"
],
"type": "object",
"properties": {
"id": {
"maxLength": 32,
"minLength": 32,
"type": "string",
"description": "Unique place identifier"
},
"name": {
"type": "string",
"description": "Name of place",
"nullable": true
},
"address": {
"type": "string",
"description": "Street address",
"nullable": true
},
"phone_number": {
"type": "string",
"description": "Phone number",
"nullable": true
},
"website": {
"type": "string",
"description": "Place website",
"nullable": true
},
"location": {
"type": "object",
"properties": {
"lat": {
"type": "number",
"format": "double"
},
"lng": {
"type": "number",
"format": "double"
}
},
"additionalProperties": false
},
"types": {
"type": "array",
"items": {
"type": "string"
},
"description": "Place types",
"nullable": true
},
"distance": {
"type": "integer",
"description": "Distance to the place (meters). For nearby search only.",
"format": "int32",
"nullable": true
}
},
"additionalProperties": false
},
"description": "Searching results array"
}
},
"additionalProperties": false
}
}
},
"security": {},
"tags": []
}