{"id":15289000,"url":"https://github.com/nginxinc/rtapi","last_synced_at":"2025-10-07T03:30:53.695Z","repository":{"id":38839164,"uuid":"238705477","full_name":"nginxinc/rtapi","owner":"nginxinc","description":"Real time API latency analyzer - Create a PDF report and HDR histogram of your APIs","archived":true,"fork":false,"pushed_at":"2023-05-24T18:42:32.000Z","size":8285,"stargazers_count":133,"open_issues_count":1,"forks_count":14,"subscribers_count":12,"default_branch":"master","last_synced_at":"2025-08-15T11:35:47.354Z","etag":null,"topics":["api","latency","nginx","real-time"],"latest_commit_sha":null,"homepage":"","language":"Go","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/nginxinc.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2020-02-06T14:19:45.000Z","updated_at":"2023-12-07T22:05:11.000Z","dependencies_parsed_at":"2024-06-18T22:32:49.660Z","dependency_job_id":"66a51bae-9166-4865-aa56-4b583c5c34e7","html_url":"https://github.com/nginxinc/rtapi","commit_stats":null,"previous_names":[],"tags_count":3,"template":false,"template_full_name":null,"purl":"pkg:github/nginxinc/rtapi","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nginxinc%2Frtapi","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nginxinc%2Frtapi/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nginxinc%2Frtapi/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nginxinc%2Frtapi/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/nginxinc","download_url":"https://codeload.github.com/nginxinc/rtapi/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nginxinc%2Frtapi/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":278715508,"owners_count":26033296,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","status":"online","status_checked_at":"2025-10-07T02:00:06.786Z","response_time":59,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["api","latency","nginx","real-time"],"created_at":"2024-09-30T15:55:33.035Z","updated_at":"2025-10-07T03:30:50.162Z","avatar_url":"https://github.com/nginxinc.png","language":"Go","funding_links":[],"categories":[],"sub_categories":[],"readme":"[![Project Status: Abandoned – Initial development has started, but there has not yet been a stable, usable release; the project has been abandoned and the author(s) do not intend on continuing development.](https://www.repostatus.org/badges/latest/abandoned.svg)](https://www.repostatus.org/#abandoned)\n\n# Real Time API (RTAPI) Latency Testing Tool\n\n# This repository has been archived. There will likely be no further development on the project and security vulnerabilities may be unaddressed.\n\n\nThis tool measures the latency response of a series of API endpoints and creates a PDF report with an HDR histogram of all API endpoints.\n\n## How to use\n\n`rtapi` takes either a JSON/YAML file or a JSON string containing endpoint data and query parameters (optional), queries each endpoint using the query parameters (or default query values if no parameters have been specified), and outputs a PDF report containing all the endpoint query results plotted in an HDR histogram.\n\n```\n$ ./rtapi -h\nNAME:\n    Real time API latency analyzer - Create a PDF report and HDR histogram of Your APIs\n\nUSAGE:\n    rtapi [global options] command [command options] [arguments...]\n\nVERSION:\n    v0.2.0\n\nCOMMANDS:\n    help, h  Shows a list of commands or help for one command\n\nGLOBAL OPTIONS:\n    --file value, -f value    select a JSON or YAML file to load\n    --data value, -d value    input API parameters directly as a JSON string\n    --output value, -o value  output query results in easy to grasp PDF report\n    --print, -p               output technical query results to terminal (default: false)\n    --help, -h                show help (default: false)\n    --version, -v             print the version (default: false)\n```\n\n## Sample Input\n\n### JSON\n\n```json\n[\n  {\n    \"target\": {\n      \"url\": \"https://www.example.com\",\n      \"method\": \"POST\",\n      \"body\": \"{\\\"id\\\":\\\"0\\\"}\",\n      \"header\": {\n        \"Content-Type\": [\n          \"application/json\"\n        ]\n      }\n    },\n    \"query_parameters\": {\n      \"threads\": 2,\n      \"max_threads\": 2,\n      \"connections\": 12,\n      \"duration\": \"10s\",\n      \"request_rate\": 500\n    }\n  }\n]\n```\n\n### YAML\n\n```yaml\n- target:\n    url: https://www.example.com\n    method: POST\n    body: '{\"id\":\"0\"}'\n    header:\n      Content-Type:\n        - application/json\n  query_parameters:\n    threads: 2\n    max_threads: 2\n    connections: 12\n    duration: 10s\n    request_rate: 500\n```\n\n### Default Values\n\nOnly the `target.url` parameter is required. If no method is specified the default is \"GET\", while in the case of the body and headers these will simply remain empty during the benchmark.\n\nThe default `query_parameters` closely follow the default query parameters found in [`wrk2`](https://github.com/giltene/wrk2).\n\n```\nthreads: 2\nmax_threads: 2\nconnections: 10\nduration: 10s\nrequest_rate: 500\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnginxinc%2Frtapi","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fnginxinc%2Frtapi","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnginxinc%2Frtapi/lists"}