How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
Axle Energy

Axle Energy 3. Sites API

Register your sites with Axle; configure market participation

Documentation Provider Profile APIs.io OpenAPI GitHub

Axle Energy 3. Sites API is one of 8 APIs that Axle Energy publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include 3. Sites. The published artifact set on APIs.io includes an OpenAPI specification.

This API exposes 20 operations across 17 paths, and defines 45 schemas. It is described by OpenAPI 3.2.0, at version 1.4.6.

Requests are made against a single base URL, https://api.axle.energy.

20 operations 17 paths 45 schemas 1 DELETE6 GET1 PATCH12 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.4.6
Base URL
https://api.axle.energy
Authentication
OAuth 2.0
Resource Areas
1

Authentication & Security 1

Axle Energy 3. Sites API declares 1 security scheme for authenticating requests. It supports OAuth 2.0 (OAuth2PasswordBearer) using the password flow.

Paths & Operations 20

Across 17 paths, the API surfaces 20 operations — 1 DELETE, 6 GET, 1 PATCH, 12 POST. Each is listed below with its method, path, parameters, and response codes.

3. Sites 20

Register your sites with Axle; configure market participation

GET
/entities/site
Get Sites
get_sites_entities_site_get 4 params → 200500422
POST
/entities/site
Create Site
create_site_entities_site_post body → 200400404409422500
POST
/entities/site/initialise
Initialise Site
initialise_site_entities_site_initialise_post body → 200400404409500422
POST
/entities/site/check-eligibility
Check Eligibility
check_eligibility_entities_site_check_eligibility_post body → 200404500422
POST
/entities/site/{site_id}/enrol
Enrol Site
enrol_site_entities_site__site_id__enrol_post 1 param body → 200404422500
POST
/entities/site/onboard
Onboard
onboard_entities_site_onboard_post body → 200400404409422500
POST
/entities/site/{site_id}/unenrol
Unenrol Site
unenrol_site_entities_site__site_id__unenrol_post 1 param body → 200404500422
POST
/entities/site/onboard-site-and-assetdeprecated
Onboard Site And Asset
onboard_site_and_asset_entities_site_onboard_site_and_asset_post body → 200400409422500
POST
/entities/site/{site_id}/offboard-site-and-assets
Offboard Site And Assets
offboard_site_and_assets_entities_site__site_id__offboard_site_and_assets_post 1 param → 200400404500422
GET
/entities/site/{site_id}
Get Site
get_site_entities_site__site_id__get 1 param → 200404500422
DELETE
/entities/site/{site_id}
Delete Site
delete_site_entities_site__site_id__delete 1 param → 204400404500422
PATCH
/entities/site/{site_id}
Update Site
update_site_entities_site__site_id__patch 1 param body → 200404500422
GET
/entities/site/{site_id}/eligibility
Get Site Eligibility
get_site_eligibility_entities_site__site_id__eligibility_get 1 param → 200404500422
POST
/entities/site/{site_id}/meter-consent
Add Site Meter Consent
add_site_meter_consent_entities_site__site_id__meter_consent_post 1 param body → 200400404500422
POST
/entities/site/{site_id}/dispatch-consent
Add Site Dispatch Consent
add_site_dispatch_consent_entities_site__site_id__dispatch_consent_post 1 param body → 200404500422
POST
/entities/site/{site_id}/dispatch-deconsent
Remove Site Dispatch Consent
remove_site_dispatch_consent_entities_site__site_id__dispatch_deconsent_post 1 param body → 200404500422
POST
/entities/site/{site_id}/token
Add Site Auth Token
add_site_auth_token_entities_site__site_id__token_post 1 param body → 200404500422
GET
/entities/site/{site_id}/flex-events
Get Site Flex Events
get_site_flex_events_entities_site__site_id__flex_events_get 1 param → 200404500422
GET
/entities/site/{site_id}/price-curve
Get Price Curve
get_price_curve_entities_site__site_id__price_curve_get 1 param → 200404500422
GET
/entities/site/{site_id}/oauth/{provider}/initiate
Initiate Site Oauth
initiate_site_oauth_entities_site__site_id__oauth__provider__initiate_get 2 params → 200400500422

Schemas 45

The contract defines 45 schemas that model the data the API accepts and returns. The most detailed are SiteResponse (9 properties), OnboardingAssetRequest (5 properties), SiteAuthTokenRequest (5 properties), SiteRequest (5 properties). Each schema is shown below with its type and property counts.

InitialiseSiteResult
object
Result metadata for a site after upsert.
4 properties 2 required
EligibilityCheckResponse
object
Response model for the ephemeral eligibility check endpoint.
2 properties 1 required
InitialiseRequest
object
Request model for initialising a site with one or more assets. Upserts the site and assets, returning eligibility information. No enrollment side effects (no d…
2 properties 2 required
SiteEligibilityDetail
object
Eligibility detail for a site's proposition eligibility check.
4 properties 2 required
OAuthInitiateResponse
object
Response for initiating OAuth flow with a third party service (e.g. FoxESS)
1 property 1 required
OnboardingRequest
object
Request model for onboarding a site with an asset and dispatch consent in a single call.
3 properties 3 required
InitialiseAssetResult
object
Result metadata for a single asset after upsert.
5 properties 3 required
EligibilityCode
string
Codes identifying specific eligibility issues for an asset.
CreatableAssetType
string
Asset types that can be created through the API.
EligibilityCheckRequest
object
Request model for the ephemeral eligibility check endpoint.
2 properties 1 required
UnenrolRequest
object
Request model for unenrolling a site from a proposition.
1 property 1 required
AssetType
string
An enumeration.
SiteAuthTokenRequest
object
Request model for providing an auth token to enable Axle to access assets at a site.
5 properties
SiteDispatchConsentRequest
object
Request model for updating dispatch consent for a site.
1 property 1 required
OnboardRequest
object
Request model for the onboard endpoint.
4 properties 3 required
HalfHourlyPrice
object
Represents the market price for a given half-hour period. If the asset is not participating in the market for that period, pricegbppermwh will be None.
2 properties 2 required
TariffResponse
object
Response model for tariff information.
3 properties
SiteRequest
object
Request model for creating a new site.
5 properties 2 required
SiteProperties
object
Site-level properties relevant to eligibility evaluation.
2 properties 2 required
AssetProperties
object
Optional properties for an asset.
2 properties
HTTPValidationError
object
1 property
PropositionEligibility
object
Eligibility detail for a single proposition.
3 properties 2 required
SiteFlexEventsResponse
object
2 properties 2 required
EnrolResponse
object
Outcome of an enrolment attempt.
2 properties 2 required
UnenrolResponse
object
Response model for the unenrol endpoint.
2 properties 2 required
MarketResponse
string
Market types available for participation. - CM: Capacity Market - DFS: Dynamic Frequency Service - DNO: Distribution Network Operator flexibility services - LC…
InitialiseResponse
object
Response model for the initialise endpoint.
3 properties 3 required
DispatchMethodResponse
string
Axle propositions that a site can enrol into.
PriceCurveResponse
object
Response model for getting the price curve for a dispatchable asset (battery / charger).
1 property 1 required
EnrolRequest
object
Request model for enrolling a site in a proposition.
3 properties 1 required
SiteResponse
object
Response model for site information.
9 properties 1 required
ErrorWithDetail
object
Standard error response with a detailed message.
1 property 1 required
AssetEligibilityDetail
object
Eligibility detail for a single asset across all propositions.
3 properties 2 required
TariffType
string
An enumeration.
OnboardResponse
object
Response model for the onboard endpoint.
3 properties 3 required
OnboardingResponse
object
Response model for onboarding operation.
2 properties 2 required
ValidationError
object
3 properties 3 required
OnboardingAssetRequest
object
Request model for creating an asset during onboarding (without siteid).
5 properties 2 required
AssetResponse
object
Response model for asset information.
5 properties 4 required
SiteMeterConsentRequest
object
Request model for adding boundary meter consent for a site.
1 property 1 required
SiteUpdateRequest
object
Request model for updating site information.
5 properties
TariffRequest
object
Request model for updating tariff information.
3 properties 1 required
SiteResponsePage
object
Paginated response for site listings.
4 properties 4 required
OAuthProvider
string
OAuth 2 providers supported for asset connections.
FlexEventResponse
object
4 properties 3 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

axle-energy-3-sites-api-openapi.yml Raw ↑

Other APIs Axle Energy publishes across the network.

Axle Energy 1. Authentication API
AE Profile APIs.io
Axle Energy 2. Meters API
AE Profile APIs.io
Axle Energy 4. Assets API
AE Profile APIs.io
Axle Energy 5. Data API
AE Profile APIs.io
Axle Energy 6. Rewards API
AE Profile APIs.io
Axle Energy 7. Validation API
AE Profile APIs.io
Axle Energy 8. Examples API
AE Profile APIs.io
#3. Sites
← Back to A APIs
API Details
ID
axle-energy:axle-energy-3-sites-api
Base URL
https://api.axle.energy
Docs
https://docs.axle.energy/introduction
Provider
Axle Energy
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network
Work with this as data

Every API here is available over the API and to AI agents over MCP. APIs is not yet its own endpoint on the v1 API. Reach this content through network search and the tag graph, or the MCP server below.

Installs https://mcp.apievangelist.com/mcp in Claude, Cursor, VS Code and the rest — one button, every client.

MCP tools for apis
4 tools reach this content
  • search_api_evangelistSearch every content type across the network at once.
  • find_relatedThe shared-tag relevance graph — what else covers this.
  • get_tagEverything one tag labels, across all content types.
  • guide_topicPRO — a curated bundle for a topic: area, guidance, rules, papers, stories, services.
All tools & prompts
Call it yourself
curl for this page
Search the network for this 
curl "https://api.apievangelist.com/v1/search?q=axle-energy-3-sites-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/axle-energy-3-sites-api"

Discovery needs no key. Full bodies and the synthesis endpoints are Pro.

Get an API key

Free tier, no email required. Sign in with whichever identity you already have.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have. Your account

Where this information came from

This is an independent, third-party profile of Axle Energy 3. Sites API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.