{"id":28513605,"url":"https://github.com/livepeer/orchestrator-price-api","last_synced_at":"2025-07-04T06:30:39.020Z","repository":{"id":44707576,"uuid":"352765221","full_name":"livepeer/orchestrator-price-api","owner":"livepeer","description":"A tool for enhancing the price visibility in Livepeer ecosystem.","archived":false,"fork":false,"pushed_at":"2022-01-31T17:28:49.000Z","size":22,"stargazers_count":1,"open_issues_count":0,"forks_count":2,"subscribers_count":3,"default_branch":"main","last_synced_at":"2025-06-30T02:49:04.936Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"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/livepeer.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}},"created_at":"2021-03-29T19:44:27.000Z","updated_at":"2023-12-20T14:23:26.000Z","dependencies_parsed_at":"2022-09-13T23:10:24.183Z","dependency_job_id":null,"html_url":"https://github.com/livepeer/orchestrator-price-api","commit_stats":null,"previous_names":[],"tags_count":2,"template":false,"template_full_name":null,"purl":"pkg:github/livepeer/orchestrator-price-api","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/livepeer%2Forchestrator-price-api","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/livepeer%2Forchestrator-price-api/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/livepeer%2Forchestrator-price-api/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/livepeer%2Forchestrator-price-api/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/livepeer","download_url":"https://codeload.github.com/livepeer/orchestrator-price-api/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/livepeer%2Forchestrator-price-api/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":263461261,"owners_count":23470085,"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","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":[],"created_at":"2025-06-09T01:07:29.940Z","updated_at":"2025-07-04T06:30:39.009Z","avatar_url":"https://github.com/livepeer.png","language":"Go","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Livepeer Price API - API Documentation\n\nAn API for curating the off-chain orchestrator pricing information and exposing the data via various endpoints.\n\n\u003cbr\u003e\n\n## Getting Started\n\n* Clone the repo: ```git clone https://github.com/livepeer/orchestrator-price-api``` and ```cd``` into it. \n\n### Using Docker\n\n* Create a file ```.env``` and set environment variables (sample present in ```livepeer-pricing-tool-api/.env.sample```)\n* Run your docker daemon.\n* Build the docker image: ```docker build --tag api:latest .``` .\n* Run Demux: ```docker run -v \"$(pwd)\"/data:/data -p 9000:9000 --env-file ./.env api:latest```\n\n\u003cbr\u003e\n\n## Table of Contents\n\n  - [/orchestratorStats](#orchestratorstats)\n    - [Parameters](#parameters)\n    - [Examples](#examples)\n  - [/priceHistory](#pricehistory)\n    - [Parameters](#parameters-1)\n    - [Examples](#examples-1)\n\n\u003cbr\u003e\n\n### /orchestratorStats\n\nGET request returning an object array consisting of latest statistics for all the orchestrators.\n\n#### Parameters\n\n##### Query Parameters\n\n| Name | Values | Description |\n|--|--|--|\n| excludeUnavailable | ```True``` [default] / ```False``` | This query parameter exludes the unavailable orchestrators from the list of returned orchestrators |\n\n#### Examples\n\n- Request\n    - [https://nyc.livepeer.com/orchestratorStats](https://nyc.livepeer.com/orchestratorStats)\n    - [https://nyc.livepeer.com/orchestratorStats?excludeUnavailable=False](https://nyc.livepeer.com/orchestratorStats?excludeUnavailable=False)\n\n\n- Response\n\n```\n[\n  {\n    \"Address\": \"0xe9e284277648fcdb09b8efc1832c73c09b5ecf59\",\n    \"ServiceURI\": \"https://livepeer.production-ue1.staked.cloud:8935\",\n    \"LastRewardRound\": 1774,\n    \"RewardCut\": 50000,\n    \"FeeShare\": 0,\n    \"DelegatedStake\": 2.0817318069491477e+24,\n    \"ActivationRound\": 1611,\n    \"DeactivationRound\": 1.157920892373162e+77,\n    \"Active\": true,\n    \"Status\": \"Registered\",\n    \"PricePerPixel\": 27840.575,\n    \"UpdatedAt\": 1591592904\n  },\n  {\n    \"Address\": \"0xda43d85b8d419a9c51bbf0089c9bd5169c23f2f9\",\n    \"ServiceURI\": \"https://70ea2ff5-004f-4ed6-98b4-60f6c1b48444.livepeer.herd.run:8935\",\n    \"LastRewardRound\": 1774,\n    \"RewardCut\": 25000,\n    \"FeeShare\": 500000,\n    \"DelegatedStake\": 1.3120167580279702e+24,\n    \"ActivationRound\": 1620,\n    \"DeactivationRound\": 1.157920892373162e+77,\n    \"Active\": true,\n    \"Status\": \"Registered\",\n    \"PricePerPixel\": 83862.63,\n    \"UpdatedAt\": 1591592904\n  },\n  {\n    \"Address\": \"0xa5e37e0ba14655e92deff29f32adbc7d09b8a2cf\",\n    \"ServiceURI\": \"https://7933316d-8d09-4b34-aebe-fe0654a3b7ca.livepeer.herd.run:8935\",\n    \"LastRewardRound\": 1774,\n    \"RewardCut\": 50000,\n    \"FeeShare\": 450000,\n    \"DelegatedStake\": 9.355364168371407e+23,\n    \"ActivationRound\": 1611,\n    \"DeactivationRound\": 1.157920892373162e+77,\n    \"Active\": true,\n    \"Status\": \"Registered\",\n    \"PricePerPixel\": 83862.63,\n    \"UpdatedAt\": 1591592904\n  }\n]\n```\n\n\u003cbr/\u003e\n\n### /priceHistory\n\nGET request returning the price history corresponding to an orchestrator in the form of an object list containing timestamps and price per pixel for the respective timestamps.\n\n#### Parameters\n\n##### Path Parameters\n\n- Orchestrator Address ```/priceHistory/:OrchestratorAddress```\n    - This path parameter constitutes of the the orchestrator address, for which the price history is required. The addresses can be fetched via [/orchestratorStats](#orchestratorStats) endpoint.\n\n##### Query Parameters\n\n| Name | Values | Description |\n|--|--|--|\n| limit | ```integer``` | Limits the number of rows in reponse to the specified value |\n| offset | ```integer``` | When coupled with ```limit```, can be used for pagination |\n| from | ```integer``` | Specifies the start value of a date/time range in unix epoch time format |\n| till | ```integer``` | Specifies the end value of a date/time range in unix epoch time format |\n\n\n#### Examples\n\n- Request\n    - [https://nyc.livepeer.com/priceHistory/0xda43d85b8d419a9c51bbf0089c9bd5169c23f2f9](https://livepeer-pricing-tool.com/priceHistory/0xda43d85b8d419a9c51bbf0089c9bd5169c23f2f9)\n    - [https://nyc.livepeer.com/priceHistory/0xda43d85b8d419a9c51bbf0089c9bd5169c23f2f9?limit=10\u0026offset=20](https://livepeer-pricing-tool.com/priceHistory/0xda43d85b8d419a9c51bbf0089c9bd5169c23f2f9?limit=10\u0026offset=20)\n    - [https://nyc.livepeer.com/priceHistory/0xda43d85b8d419a9c51bbf0089c9bd5169c23f2f9?from=1616218200\u0026till=1616563800](https://livepeer-pricing-tool.com/priceHistory/0xda43d85b8d419a9c51bbf0089c9bd5169c23f2f9?from=1616218200\u0026till=1616563800)\n\n\n- Response\n\n```\n[\n  {\n    \"PricePerPixel\": 81836.82,\n    \"Time\": 1591596521\n  },\n  {\n    \"PricePerPixel\": 83862.63,\n    \"Time\": 1591592904\n  },\n  {\n    \"PricePerPixel\": 83763,\n    \"Time\": 1591589287\n  },\n  {\n    \"PricePerPixel\": 83098.8,\n    \"Time\": 1591585672\n  },\n  {\n    \"PricePerPixel\": 82434.6,\n    \"Time\": 1591582056\n  }\n]\n```\n\n\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Flivepeer%2Forchestrator-price-api","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Flivepeer%2Forchestrator-price-api","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Flivepeer%2Forchestrator-price-api/lists"}