{"swagger":"2.0","info":{"version":"v1.24","title":"7parkAPI"},"host":"api.7parkdata.com","schemes":["https"],"paths":{"/oauth/token":{"post":{"tags":["oauth"],"summary":"request a token","consumes":["application/json"],"produces":["application/json"],"parameters":[{"in":"body","name":"oauth","description":"oauth token request body","required":true,"schema":{"$ref":"#/definitions/oauth"}}],"responses":{"200":{"description":"200 response","schema":{"$ref":"#/definitions/Empty"}}}}},"/permissions":{"get":{"tags":["permissions"],"summary":"List all users permissions","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"Authorization","in":"header","description":"Bearer [Token]","required":false,"type":"string"}],"responses":{"200":{"description":"200 response","schema":{"$ref":"#/definitions/Empty"}}},"security":[{"jwt-rsa-custom-authorizer":[]}]}},"/usages":{"get":{"tags":["usages"],"summary":"List of usage for user's applications.","produces":["application/json"],"parameters":[{"name":"Authorization","in":"header","description":"Bearer [Token]","required":false,"type":"string"}],"responses":{"200":{"description":"200 response","schema":{"$ref":"#/definitions/Empty"}}},"security":[{"jwt-rsa-custom-authorizer":[]}],"x-amazon-apigateway-request-validator":"Validate query string parameters and headers","x-amazon-apigateway-integration":{"uri":"https://avenue-api.7parkdata.com/v4/usage","responses":{"default":{"statusCode":"200"}},"requestParameters":{"integration.request.header.Authorization":"method.request.header.Authorization"},"passthroughBehavior":"when_no_match","httpMethod":"GET","type":"http"}}},"/companies":{"get":{"tags":["metadata"],"summary":"List all companies","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"company_id","in":"query","description":"filte result by company id","required":false,"type":"string"},{"name":"page_size","in":"query","description":"Number of results to return per page.","required":false,"type":"string"},{"name":"company_name","in":"query","description":"filter by company name","required":false,"type":"string"},{"name":"Authorization","in":"header","description":"Bearer [Token]","required":false,"type":"string"},{"name":"ordering","in":"query","description":"order by [company_name|ticker]","required":false,"type":"string"},{"name":"page","in":"query","description":"A page number within the paginated result set.","required":false,"type":"string"},{"name":"search","in":"query","description":"Search by company_name or ticker.","required":false,"type":"string"}],"responses":{"200":{"description":"200 response","schema":{"$ref":"#/definitions/Empty"}}},"security":[{"jwt-rsa-custom-authorizer":[]},{"api_key":[]}]}},"/company":{"post":{"tags":["metadata"],"description":"Add a new company to 7Park's list of tracked companies.Must not result in duplication.","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"Authorization","in":"header","required":false,"type":"string"},{"in":"body","name":"fullcompany","required":true,"schema":{"$ref":"#/definitions/fullcompany"}}],"responses":{"200":{"description":"200 response","schema":{"$ref":"#/definitions/Empty"}}},"security":[{"jwt-rsa-custom-authorizer":[]},{"api_key":[]}],"x-amazon-apigateway-integration":{"uri":"https://akm2-api-dev.7parkdata.com/dimension/companies","responses":{"default":{"statusCode":"200"}},"requestParameters":{"integration.request.header.Authorization":"method.request.header.Authorization"},"passthroughBehavior":"when_no_match","httpMethod":"POST","type":"http"}}},"/companies/search":{"get":{"tags":["metadata"],"summary":"Search company","produces":["application/json"],"parameters":[{"name":"ticker","in":"query","description":"search by ticker","required":false,"type":"string"},{"name":"company_name","in":"query","description":"search by company name","required":false,"type":"string"},{"name":"Authorization","in":"header","description":"Bearer [Token]","required":false,"type":"string"},{"name":"website","in":"query","description":"search by website","required":false,"type":"string"}],"responses":{"200":{"description":"200 response","schema":{"$ref":"#/definitions/Empty"}}},"x-amazon-apigateway-request-validator":"Validate query string parameters and headers","x-amazon-apigateway-integration":{"uri":"https://h5p3ly21zk.execute-api.us-east-1.amazonaws.com/prod/company-search/","responses":{"default":{"statusCode":"200"}},"requestParameters":{"integration.request.querystring.website":"method.request.querystring.website","integration.request.header.Authorization":"method.request.header.Authorization","integration.request.querystring.ticker":"method.request.querystring.ticker","integration.request.querystring.company_name":"method.request.querystring.company_name"},"passthroughBehavior":"when_no_match","httpMethod":"GET","type":"http"},"security":[{"jwt-rsa-custom-authorizer":[]},{"api_key":[]}]},"options":{"consumes":["application/json"],"produces":["application/json"],"responses":{"200":{"description":"200 response","schema":{"$ref":"#/definitions/Empty"},"headers":{"Access-Control-Allow-Origin":{"type":"string"},"Access-Control-Allow-Methods":{"type":"string"},"Access-Control-Allow-Headers":{"type":"string"}}}},"x-amazon-apigateway-integration":{"responses":{"default":{"statusCode":"200","responseParameters":{"method.response.header.Access-Control-Allow-Methods":"'DELETE,GET,HEAD,OPTIONS,PATCH,POST,PUT'","method.response.header.Access-Control-Allow-Headers":"'Content-Type,Authorization,X-Amz-Date,X-Api-Key,X-Amz-Security-Token'","method.response.header.Access-Control-Allow-Origin":"'*'"}}},"passthroughBehavior":"when_no_match","requestTemplates":{"application/json":"{\"statusCode\": 200}"},"type":"mock"}}},"/company/{company_id}":{"get":{"tags":["metadata"],"summary":"Info for a specific company","produces":["application/json"],"parameters":[{"name":"company_id","in":"path","description":"company_id","required":true,"type":"string"},{"name":"Authorization","in":"header","description":"Bearer [Token]","required":false,"type":"string"}],"responses":{"200":{"description":"200 response","schema":{"$ref":"#/definitions/company"}}},"security":[{"jwt-rsa-custom-authorizer":[]},{"api_key":[]}]}},"/company/{company_id}/hierarchy":{"get":{"tags":["metadata"],"description":"Get company hierarchy (parent company and subsidiaries)","produces":["application/json"],"parameters":[{"name":"company_id","in":"path","description":"company_id","required":true,"type":"string"},{"name":"Authorization","in":"header","description":"Bearer [Token]","required":false,"type":"string"}],"responses":{"200":{"description":"200 response","schema":{"$ref":"#/definitions/Empty"}}},"security":[{"jwt-rsa-custom-authorizer":[]}],"x-amazon-apigateway-integration":{"uri":"https://akm2-api-prod.7parkdata.com/dimension/company/{company_id}/hierarchy","responses":{"default":{"statusCode":"200"}},"requestParameters":{"integration.request.path.company_id":"method.request.path.company_id","integration.request.header.Authorization":"method.request.header.Authorization"},"passthroughBehavior":"when_no_match","httpMethod":"GET","type":"http"}}},"/company/{company_id}/metrics":{"get":{"tags":["metadata"],"summary":"List of metrics for company","produces":["application/json"],"parameters":[{"name":"company_id","in":"path","description":"company_id","required":true,"type":"string"},{"name":"ordering","in":"query","description":"order by {metric_name | -metric_name}","required":false,"type":"string"},{"name":"page","in":"query","description":"A page number within the paginated result set.","required":false,"type":"string"},{"name":"page_size","in":"query","description":"Number of results to return per page.","required":false,"type":"string"},{"name":"Authorization","in":"header","description":"Bearer [Token]","required":false,"type":"string"}],"responses":{"200":{"description":"200 response","schema":{"$ref":"#/definitions/Empty"}}},"security":[{"jwt-rsa-custom-authorizer":[]},{"api_key":[]}]}},"/company/{company_id}/metric/{metric_id}":{"get":{"tags":["metadata"],"summary":"Info for a specific metric","produces":["application/json"],"parameters":[{"name":"company_id","in":"path","description":"company_id","required":true,"type":"string"},{"name":"Authorization","in":"header","description":"Bearer [Token]","required":false,"type":"string"},{"name":"metric_id","in":"path","description":"metric_id","required":true,"type":"string"}],"responses":{"200":{"description":"200 response","schema":{"$ref":"#/definitions/Empty"}}},"security":[{"jwt-rsa-custom-authorizer":[]},{"api_key":[]}]}},"/company/{company_id}/metric/{metric_id}/entities":{"get":{"tags":["metadata"],"summary":"List of entities for company and metric","produces":["application/json"],"parameters":[{"name":"company_id","in":"path","description":"company_id","required":true,"type":"string"},{"name":"ordering","in":"query","description":"order by [entity_name|-entity_name]","required":false,"type":"string"},{"name":"page","in":"query","description":"A page number within the paginated result set.","required":false,"type":"string"},{"name":"page_size","in":"query","description":"Number of results to return per page.","required":false,"type":"string"},{"name":"Authorization","in":"header","description":"Bearer [Token]","required":false,"type":"string"},{"name":"metric_id","in":"path","description":"metric_id","required":true,"type":"string"}],"responses":{"200":{"description":"200 response","schema":{"$ref":"#/definitions/Empty"}}},"security":[{"jwt-rsa-custom-authorizer":[]},{"api_key":[]}]}},"/company/{company_id}/metric/{metric_id}/entity/{entity_id}":{"get":{"tags":["metadata"],"summary":"Info for a specific entity","produces":["application/json"],"parameters":[{"name":"entity_id","in":"path","description":"entity_id","required":true,"type":"string"},{"name":"company_id","in":"path","description":"company_id","required":true,"type":"string"},{"name":"Authorization","in":"header","description":"Bearer [Token]","required":false,"type":"string"},{"name":"metric_id","in":"path","description":"metric_id","required":true,"type":"string"}],"responses":{"200":{"description":"200 response","schema":{"$ref":"#/definitions/Empty"}}},"security":[{"jwt-rsa-custom-authorizer":[]},{"api_key":[]}]}},"/forecasts":{"get":{"tags":["forecasts"],"summary":"List of available forecast's metadata","produces":["application/json"],"parameters":[{"name":"company_id","in":"query","description":"filte result by company id","required":false,"type":"string"},{"name":"ordering","in":"query","description":"order by [metric | -metric]","required":false,"type":"string"},{"name":"page","in":"query","description":"A page number within the paginated result set.","required":false,"type":"string"},{"name":"page_size","in":"query","description":"Number of results to return per page.","required":false,"type":"string"},{"name":"search","in":"query","description":"Search by company_name or ticker.","required":false,"type":"string"},{"name":"Authorization","in":"header","description":"Bearer [Token]","required":false,"type":"string"}],"responses":{"200":{"description":"200 response","schema":{"$ref":"#/definitions/Empty"}}},"security":[{"jwt-rsa-custom-authorizer":[]},{"api_key":[]}]}},"/company/{company_id}/metric/{metric_id}/entity/{entity_id}/forecast":{"get":{"tags":["forecasts"],"summary":"Forecast info for company, metric and entity","produces":["application/json"],"parameters":[{"name":"entity_id","in":"path","description":"entity_id","required":true,"type":"string"},{"name":"company_id","in":"path","description":"company_id","required":true,"type":"string"},{"name":"Authorization","in":"header","description":"Bearer [Token]","required":false,"type":"string"},{"name":"metric_id","in":"path","description":"metric_id","required":true,"type":"string"}],"responses":{"200":{"description":"200 response","schema":{"$ref":"#/definitions/Empty"}}},"security":[{"jwt-rsa-custom-authorizer":[]},{"api_key":[]}]}},"/company/{company_id}/metric/{metric_id}/entity/{entity_id}/forecast/history":{"get":{"tags":["forecasts"],"summary":"Historical forecast info for company, metric and entity","produces":["application/json"],"parameters":[{"name":"entity_id","in":"path","description":"entity_id","required":true,"type":"string"},{"name":"company_id","in":"path","description":"company_id","required":true,"type":"string"},{"name":"metric_id","in":"path","description":"metric_id","required":true,"type":"string"}],"responses":{"200":{"description":"200 response","schema":{"$ref":"#/definitions/Empty"}}},"security":[{"jwt-rsa-custom-authorizer":[]},{"api_key":[]}]}},"/company/{company_id}/metric/{metric_id}/entity/{entity_id}/forecast/snapshot":{"get":{"tags":["forecasts"],"summary":"Historical forecast snapshot info for company, metric and entity","produces":["application/json","text/csv"],"parameters":[{"name":"entity_id","in":"path","description":"entity_id","required":true,"type":"string"},{"name":"data_through","in":"query","description":"YYYY-MM-DD","required":false,"type":"string"},{"name":"company_id","in":"path","description":"company_id","required":true,"type":"string"},{"name":"Authorization","in":"header","description":"Bearer [Token]","required":false,"type":"string"},{"name":"metric_id","in":"path","description":"metric_id","required":true,"type":"string"}],"responses":{"200":{"description":"200 response","schema":{"$ref":"#/definitions/Empty"}}},"security":[{"jwt-rsa-custom-authorizer":[]},{"api_key":[]}],"x-amazon-apigateway-request-validator":"Validate query string parameters and headers","x-amazon-apigateway-integration":{"uri":"arn:aws:apigateway:us-east-1:lambda:path/2015-03-31/functions/arn:aws:lambda:us-east-1:084888172679:function:API-Gateway-7ParkAPI-forecast-snapshot/invocations","responses":{"default":{"statusCode":"200"}},"passthroughBehavior":"when_no_match","httpMethod":"POST","type":"aws_proxy"}}},"/company/{company_id}/metric/{metric_id}/entity/{entity_id}/queries":{"get":{"tags":["metadata"],"summary":"Queries info for company, metric and entity","produces":["application/json"],"parameters":[{"name":"entity_id","in":"path","description":"entity_id","required":true,"type":"string"},{"name":"company_id","in":"path","description":"company_id","required":true,"type":"string"},{"name":"Authorization","in":"header","description":"Bearer [Token]","required":false,"type":"string"},{"name":"metric_id","in":"path","description":"metric_id","required":true,"type":"string"}],"responses":{"200":{"description":"200 response","schema":{"$ref":"#/definitions/Empty"}}},"security":[{"jwt-rsa-custom-authorizer":[]},{"api_key":[]}]}},"/queries":{"get":{"produces":["application/json"],"parameters":[{"name":"company_id","in":"query","description":"company_id","required":false,"type":"string"},{"name":"dataset_id","in":"query","description":"dataset_id","required":false,"type":"string"},{"name":"page_size","in":"query","description":"Number of results to return per page.","required":false,"type":"string"},{"name":"page","in":"query","description":"A page number within the paginated result set.","required":false,"type":"string"},{"name":"Authorization","in":"header","description":"Bearer [Token]","required":false,"type":"string"}],"responses":{"200":{"description":"200 response","schema":{"$ref":"#/definitions/Empty"}}},"security":[{"jwt-rsa-custom-authorizer":[]},{"api_key":[]}],"x-amazon-apigateway-request-validator":"Validate query string parameters and headers","x-amazon-apigateway-integration":{"uri":"https://akm2-api-prod.7parkdata.com/dashboard/actual_entity_metrics/","responses":{"default":{"statusCode":"200"}},"requestParameters":{"integration.request.querystring.company_id":"method.request.querystring.company_id","integration.request.header.Authorization":"method.request.header.Authorization"},"passthroughBehavior":"when_no_match","httpMethod":"GET","type":"http"}}},"/data":{"get":{"tags":["time series"],"summary":"Data for metric and entity","produces":["application/json"],"parameters":[{"name":"date_from","in":"query","description":"Time series data beginning on this date. (Format: YYYY-MM-DD)","required":false,"type":"string"},{"name":"date_to","in":"query","description":"Time series data going through this date. (Format: YYYY-MM-DD)","required":false,"type":"string"},{"name":"entity_id","in":"query","description":"entity_id","required":true,"type":"string"},{"name":"Authorization","in":"header","description":"Bearer [Token]","required":false,"type":"string"},{"name":"metric_periodicity","in":"query","description":"metric_periodicity","required":true,"type":"string"},{"name":"country_name","in":"query","description":"country_name","required":false,"type":"string"},{"name":"metric_id","in":"query","description":"metric_id","required":true,"type":"string"},{"name":"world_region_name","in":"query","description":"world_region_name","required":false,"type":"string"},{"name":"us_region_name","in":"query","description":"us_region_name","required":false,"type":"string"},{"name":"discovery_name","in":"query","description":"discovery_name","required":false,"type":"string"}],"responses":{"200":{"description":"200 response","schema":{"$ref":"#/definitions/Empty"}}},"security":[{"jwt-rsa-custom-authorizer":[]},{"api_key":[]}],"x-amazon-apigateway-request-validator":"Validate query string parameters and headers","x-amazon-apigateway-integration":{"uri":"arn:aws:apigateway:us-east-1:lambda:path/2015-03-31/functions/arn:aws:lambda:us-east-1:084888172679:function:API-Gateway-7ParkAPI-data/invocations","responses":{"default":{"statusCode":"200"}},"passthroughBehavior":"when_no_match","httpMethod":"POST","contentHandling":"CONVERT_TO_TEXT","type":"aws_proxy"}}},"/healthcheck":{"get":{"tags":["healthcheck"],"summary":"health check","produces":["application/json"],"responses":{"200":{"description":"200 response","schema":{"$ref":"#/definitions/Empty"}},"500":{"description":"500 response"},"403":{"description":"403 response"}},"security":[{"jwt-rsa-custom-authorizer":[]},{"api_key":[]}]}}},"securityDefinitions":{"jwt-rsa-custom-authorizer":{"type":"apiKey","name":"Authorization","in":"header","x-amazon-apigateway-authtype":"custom"},"api_key":{"type":"apiKey","name":"x-api-key","in":"header"}},"definitions":{"Empty":{"type":"object","title":"Empty Schema"},"company":{"type":"object","properties":{"company_id":{"type":"string"},"company_name":{"type":"string"},"ticker":{"type":"string"}}},"fullcompany":{"type":"object","properties":{"company_name":{"type":"string"},"ticker":{"type":"string"},"isin":{"type":"string"},"sedol":{"type":"string"}},"description":"A fuller description of a company as tracked by 7Park."},"oauth":{"type":"object","properties":{"client_id":{"type":"string"},"client_secret":{"type":"string"}}}}}