{"openapi":"3.1.0","info":{"title":"Apizie","version":"2.0.0","description":"One API key, one envelope, many public data sources. Success responses include a `source` block to cite. Apizie Finance endpoints (SEC EDGAR, FRED, ECB, U.S. Treasury, GLEIF, World Bank, official:*) need a Finance plan."},"servers":[{"url":"https://apizie.tech"}],"security":[{"ApiKeyAuth":[]}],"paths":{"/v1/places:lyft/get-cost":{"get":{"operationId":"places_lyft_get_cost","summary":"Cost estimates","description":"GET /cost","tags":["places"],"x-apizie-access":"read","parameters":[{"name":"ride_type","in":"query","required":false,"description":"ID of a ride type","schema":{"type":"string","enum":["lyft","lyft_line","lyft_plus","lyft_premier","lyft_lux","lyft_luxsuv"],"description":"ID of a ride type"}},{"name":"start_lat","in":"query","required":true,"description":"Latitude of the starting location","schema":{"type":"number","description":"Latitude of the starting location"}},{"name":"start_lng","in":"query","required":true,"description":"Longitude of the starting location","schema":{"type":"number","description":"Longitude of the starting location"}},{"name":"end_lat","in":"query","required":false,"description":"Latitude of the ending location","schema":{"type":"number","description":"Latitude of the ending location"}},{"name":"end_lng","in":"query","required":false,"description":"Longitude of the ending location","schema":{"type":"number","description":"Longitude of the ending location"}}],"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/places:lyft/get-drivers":{"get":{"operationId":"places_lyft_get_drivers","summary":"Available drivers nearby","description":"GET /drivers","tags":["places"],"x-apizie-access":"read","parameters":[{"name":"lat","in":"query","required":true,"description":"Latitude of a location","schema":{"type":"number","description":"Latitude of a location"}},{"name":"lng","in":"query","required":true,"description":"Longitude of a location","schema":{"type":"number","description":"Longitude of a location"}}],"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/places:lyft/get-eta":{"get":{"operationId":"places_lyft_get_eta","summary":"Pickup ETAs","description":"GET /eta","tags":["places"],"x-apizie-access":"read","parameters":[{"name":"lat","in":"query","required":true,"description":"Latitude of a location","schema":{"type":"number","description":"Latitude of a location"}},{"name":"lng","in":"query","required":true,"description":"Longitude of a location","schema":{"type":"number","description":"Longitude of a location"}},{"name":"destination_lat","in":"query","required":false,"description":"Latitude of destination location","schema":{"type":"number","description":"Latitude of destination location"}},{"name":"destination_lng","in":"query","required":false,"description":"Longitude of destination location","schema":{"type":"number","description":"Longitude of destination location"}},{"name":"ride_type","in":"query","required":false,"description":"ID of a ride type","schema":{"type":"string","enum":["lyft","lyft_line","lyft_plus","lyft_premier","lyft_lux","lyft_luxsuv"],"description":"ID of a ride type"}}],"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/places:lyft/get-profile":{"get":{"operationId":"places_lyft_get_profile","summary":"The user's general info","description":"GET /profile","tags":["places"],"x-apizie-access":"read","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/places:lyft/get-rides":{"get":{"operationId":"places_lyft_get_rides","summary":"List rides","description":"GET /rides","tags":["places"],"x-apizie-access":"read","parameters":[{"name":"start_time","in":"query","required":true,"description":"Restrict to rides starting after this point in time. The earliest supported date is 2015-01-01T00:00:00+00:00","schema":{"type":"string","description":"Restrict to rides starting after this point in time. The earliest supported date is 2015-01-01T00:00:00+00:00"}},{"name":"end_time","in":"query","required":false,"description":"Restrict to rides starting before this point in time. The earliest supported date is 2015-01-01T00:00:00+00:00","schema":{"type":"string","description":"Restrict to rides starting before this point in time. The earliest supported date is 2015-01-01T00:00:00+00:00"}},{"name":"limit","in":"query","required":false,"description":"The maximum number of rides to return. The default limit is 10 if not specified. The maximum allowed value is 50, an integer greater that…","schema":{"type":"integer","default":10,"description":"The maximum number of rides to return. The default limit is 10 if not specified. The maximum allowed value is 50, an integer greater that…"}}],"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/places:lyft/new-ride":{"post":{"operationId":"places_lyft_new_ride","summary":"Request a Lyft","description":"POST /rides","tags":["places"],"x-apizie-access":"write","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["body"],"properties":{"body":{"type":"object","description":"JSON request body"}}}}}},"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/places:lyft/get-ride":{"get":{"operationId":"places_lyft_get_ride","summary":"Get the ride detail of a given ride ID","description":"GET /rides/{id}","tags":["places"],"x-apizie-access":"read","parameters":[{"name":"id","in":"query","required":true,"description":"The ID of the ride","schema":{"type":"string","description":"The ID of the ride"}}],"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/places:lyft/cancel-ride":{"post":{"operationId":"places_lyft_cancel_ride","summary":"Cancel a ongoing requested ride","description":"POST /rides/{id}/cancel","tags":["places"],"x-apizie-access":"write","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["id"],"properties":{"id":{"type":"string","description":"The ID of the ride"},"body":{"type":"object","description":"JSON request body"}}}}}},"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/places:lyft/set-ride-destination":{"post":{"operationId":"places_lyft_set_ride_destination","summary":"Update the destination of the ride","description":"PUT /rides/{id}/destination","tags":["places"],"x-apizie-access":"write","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["id","body"],"properties":{"id":{"type":"string","description":"The ID of the ride"},"body":{"type":"object","description":"JSON request body"}}}}}},"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/places:lyft/set-ride-rating":{"post":{"operationId":"places_lyft_set_ride_rating","summary":"Add the passenger's rating, feedback, and tip","description":"PUT /rides/{id}/rating","tags":["places"],"x-apizie-access":"write","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["id","body"],"properties":{"id":{"type":"string","description":"The ID of the ride"},"body":{"type":"object","description":"JSON request body"}}}}}},"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/places:lyft/get-ride-receipt":{"get":{"operationId":"places_lyft_get_ride_receipt","summary":"Get the receipt of the rides.","description":"GET /rides/{id}/receipt","tags":["places"],"x-apizie-access":"read","parameters":[{"name":"id","in":"query","required":true,"description":"The ID of the ride","schema":{"type":"string","description":"The ID of the ride"}}],"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/places:lyft/get-ride-types":{"get":{"operationId":"places_lyft_get_ride_types","summary":"Types of rides","description":"GET /ridetypes","tags":["places"],"x-apizie-access":"read","parameters":[{"name":"lat","in":"query","required":true,"description":"Latitude of a location","schema":{"type":"number","description":"Latitude of a location"}},{"name":"lng","in":"query","required":true,"description":"Longitude of a location","schema":{"type":"number","description":"Longitude of a location"}},{"name":"ride_type","in":"query","required":false,"description":"ID of a ride type","schema":{"type":"string","enum":["lyft","lyft_line","lyft_plus","lyft_premier","lyft_lux","lyft_luxsuv"],"description":"ID of a ride type"}}],"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/places:lyft/set-prime-time":{"post":{"operationId":"places_lyft_set_prime_time","summary":"Preset Prime Time percentage","description":"PUT /sandbox/primetime","tags":["places"],"x-apizie-access":"write","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["body"],"properties":{"body":{"type":"object","description":"JSON request body"}}}}}},"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/places:lyft/set-ride-status":{"post":{"operationId":"places_lyft_set_ride_status","summary":"Propagate ride through ride status","description":"PUT /sandbox/rides/{id}","tags":["places"],"x-apizie-access":"write","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["id","body"],"properties":{"id":{"type":"string","description":"The ID of the ride"},"body":{"type":"object","description":"JSON request body"}}}}}},"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/places:lyft/set-ride-types":{"post":{"operationId":"places_lyft_set_ride_types","summary":"Preset types of rides for sandbox","description":"PUT /sandbox/ridetypes","tags":["places"],"x-apizie-access":"write","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["body"],"properties":{"body":{"type":"object","description":"JSON request body"}}}}}},"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/places:lyft/set-ride-type-availability":{"post":{"operationId":"places_lyft_set_ride_type_availability","summary":"Driver availability for processing ride request","description":"PUT /sandbox/ridetypes/{ride_type}","tags":["places"],"x-apizie-access":"write","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["ride_type","body"],"properties":{"ride_type":{"type":"string","enum":["lyft","lyft_line","lyft_plus","lyft_premier","lyft_lux","lyft_luxsuv"]},"body":{"type":"object","description":"JSON request body"}}}}}},"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":"official:company"},"data":{},"source":{"type":"object","description":"Where the data came from. Cite it.","properties":{"official":{"type":"boolean"},"provider":{"type":"string","example":"SEC EDGAR"},"publisher":{"type":"string","example":"U.S. Securities and Exchange Commission"},"url":{"type":"string","format":"uri","description":"A page a person can open to check the value"},"apiUrl":{"type":"string","format":"uri","description":"The official API URL that was called (credentials removed)"},"retrievedAt":{"type":"string","format":"date-time"},"license":{"type":"string"},"licenseUrl":{"type":"string","format":"uri"},"attribution":{"type":"string"},"notice":{"type":"string"}}},"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"}}}}}}}